- 0.56.0 (latest)
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class Session.Builder extends GeneratedMessageV3.Builder<Session.Builder> implements SessionOrBuilderExternal session proto definition.
Protobuf type google.cloud.discoveryengine.v1.Session
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Session.BuilderImplements
SessionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllTurns(Iterable<? extends Session.Turn> values)
public Session.Builder addAllTurns(Iterable<? extends Session.Turn> values)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.Session.Turn> |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Session.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
addTurns(Session.Turn value)
public Session.Builder addTurns(Session.Turn value)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Session.Turn |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
addTurns(Session.Turn.Builder builderForValue)
public Session.Builder addTurns(Session.Turn.Builder builderForValue)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Session.Turn.Builder |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
addTurns(int index, Session.Turn value)
public Session.Builder addTurns(int index, Session.Turn value)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Session.Turn |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
addTurns(int index, Session.Turn.Builder builderForValue)
public Session.Builder addTurns(int index, Session.Turn.Builder builderForValue)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Session.Turn.Builder |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
addTurnsBuilder()
public Session.Turn.Builder addTurnsBuilder()Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Returns | |
|---|---|
| Type | Description |
Session.Turn.Builder |
|
addTurnsBuilder(int index)
public Session.Turn.Builder addTurnsBuilder(int index)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Session.Turn.Builder |
|
build()
public Session build()| Returns | |
|---|---|
| Type | Description |
Session |
|
buildPartial()
public Session buildPartial()| Returns | |
|---|---|
| Type | Description |
Session |
|
clear()
public Session.Builder clear()| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
clearDisplayName()
public Session.Builder clearDisplayName()Optional. The display name of the session.
This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
clearEndTime()
public Session.Builder clearEndTime()Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Session.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
clearIsPinned()
public Session.Builder clearIsPinned()Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
bool is_pinned = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
clearName()
public Session.Builder clearName() Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Session.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
clearStartTime()
public Session.Builder clearStartTime()Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
clearState()
public Session.Builder clearState()The state of the session.
.google.cloud.discoveryengine.v1.Session.State state = 2;
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
clearTurns()
public Session.Builder clearTurns()Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
clearUserPseudoId()
public Session.Builder clearUserPseudoId()A unique identifier for tracking users.
string user_pseudo_id = 3;
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
clone()
public Session.Builder clone()| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
getDefaultInstanceForType()
public Session getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Session |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Optional. The display name of the session.
This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Optional. The display name of the session.
This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEndTime()
public Timestamp getEndTime()Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getIsPinned()
public boolean getIsPinned()Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
bool is_pinned = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The isPinned. |
getName()
public String getName() Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getStartTime()
public Timestamp getStartTime()Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The startTime. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getState()
public Session.State getState()The state of the session.
.google.cloud.discoveryengine.v1.Session.State state = 2;
| Returns | |
|---|---|
| Type | Description |
Session.State |
The state. |
getStateValue()
public int getStateValue()The state of the session.
.google.cloud.discoveryengine.v1.Session.State state = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getTurns(int index)
public Session.Turn getTurns(int index)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Session.Turn |
|
getTurnsBuilder(int index)
public Session.Turn.Builder getTurnsBuilder(int index)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Session.Turn.Builder |
|
getTurnsBuilderList()
public List<Session.Turn.Builder> getTurnsBuilderList()Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getTurnsCount()
public int getTurnsCount()Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getTurnsList()
public List<Session.Turn> getTurnsList()Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Returns | |
|---|---|
| Type | Description |
List<Turn> |
|
getTurnsOrBuilder(int index)
public Session.TurnOrBuilder getTurnsOrBuilder(int index)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Session.TurnOrBuilder |
|
getTurnsOrBuilderList()
public List<? extends Session.TurnOrBuilder> getTurnsOrBuilderList()Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.Session.TurnOrBuilder> |
|
getUserPseudoId()
public String getUserPseudoId()A unique identifier for tracking users.
string user_pseudo_id = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The userPseudoId. |
getUserPseudoIdBytes()
public ByteString getUserPseudoIdBytes()A unique identifier for tracking users.
string user_pseudo_id = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for userPseudoId. |
hasEndTime()
public boolean hasEndTime()Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the endTime field is set. |
hasStartTime()
public boolean hasStartTime()Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEndTime(Timestamp value)
public Session.Builder mergeEndTime(Timestamp value)Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
mergeFrom(Session other)
public Session.Builder mergeFrom(Session other)| Parameter | |
|---|---|
| Name | Description |
other |
Session |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Session.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Session.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
mergeStartTime(Timestamp value)
public Session.Builder mergeStartTime(Timestamp value)Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Session.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
removeTurns(int index)
public Session.Builder removeTurns(int index)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setDisplayName(String value)
public Session.Builder setDisplayName(String value)Optional. The display name of the session.
This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Session.Builder setDisplayNameBytes(ByteString value)Optional. The display name of the session.
This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
setEndTime(Timestamp value)
public Session.Builder setEndTime(Timestamp value)Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setEndTime(Timestamp.Builder builderForValue)
public Session.Builder setEndTime(Timestamp.Builder builderForValue)Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Session.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setIsPinned(boolean value)
public Session.Builder setIsPinned(boolean value)Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
bool is_pinned = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe isPinned to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
setName(String value)
public Session.Builder setName(String value) Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Session.Builder setNameBytes(ByteString value) Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Session.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setStartTime(Timestamp value)
public Session.Builder setStartTime(Timestamp value)Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setStartTime(Timestamp.Builder builderForValue)
public Session.Builder setStartTime(Timestamp.Builder builderForValue)Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setState(Session.State value)
public Session.Builder setState(Session.State value)The state of the session.
.google.cloud.discoveryengine.v1.Session.State state = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Session.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
setStateValue(int value)
public Session.Builder setStateValue(int value)The state of the session.
.google.cloud.discoveryengine.v1.Session.State state = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
setTurns(int index, Session.Turn value)
public Session.Builder setTurns(int index, Session.Turn value)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Session.Turn |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setTurns(int index, Session.Turn.Builder builderForValue)
public Session.Builder setTurns(int index, Session.Turn.Builder builderForValue)Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Session.Turn.Builder |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Session.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
|
setUserPseudoId(String value)
public Session.Builder setUserPseudoId(String value)A unique identifier for tracking users.
string user_pseudo_id = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe userPseudoId to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |
setUserPseudoIdBytes(ByteString value)
public Session.Builder setUserPseudoIdBytes(ByteString value)A unique identifier for tracking users.
string user_pseudo_id = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for userPseudoId to set. |
| Returns | |
|---|---|
| Type | Description |
Session.Builder |
This builder for chaining. |