Class Session.Builder (3.88.0)

Version latest

• 3.88.0 (latest)
• 3.86.0
• 3.84.0
• 3.83.0
• 3.82.0
• 3.81.0
• 3.79.0
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 3.71.0
• 3.69.0
• 3.68.0
• 3.65.0
• 3.64.0
• 3.63.0
• 3.61.0
• 3.60.0
• 3.59.0
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class Session.Builder extends GeneratedMessage.Builder<Session.Builder> implements SessionOrBuilder

A session contains a set of actions between users and Vertex agents.

Protobuf type google.cloud.aiplatform.v1.Session

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Session.Builder

Implements

SessionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

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

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearCreateTime()

public Session.Builder clearCreateTime()

Output only. Timestamp when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Session.Builder

clearDisplayName()

public Session.Builder clearDisplayName()

Optional. The display name of the session.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Session.Builder	This builder for chaining.

clearExpiration()

public Session.Builder clearExpiration()

Returns
Type	Description
Session.Builder

clearExpireTime()

public Session.Builder clearExpireTime()

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Session.Builder

clearLabels()

public Session.Builder clearLabels()

Returns
Type	Description
Session.Builder

clearName()

public Session.Builder clearName()

Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
Session.Builder	This builder for chaining.

clearSessionState()

public Session.Builder clearSessionState()

Optional. Session specific memory which stores key conversation points.

.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Session.Builder

clearTtl()

public Session.Builder clearTtl()

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
Session.Builder

clearUpdateTime()

public Session.Builder clearUpdateTime()

Output only. Timestamp when the session was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Session.Builder

clearUserId()

public Session.Builder clearUserId()

Required. Immutable. String id provided by the user

string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Session.Builder	This builder for chaining.

containsLabels(String key)

public boolean containsLabels(String key)

The labels with user-defined metadata to organize your Sessions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Session getDefaultInstanceForType()

Returns
Type	Description
Session

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Optional. The display name of the session.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The display name of the session.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for displayName.

getExpirationCase()

public Session.ExpirationCase getExpirationCase()

Returns
Type	Description
Session.ExpirationCase

getExpireTime()

public Timestamp getExpireTime()

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Builder

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels with user-defined metadata to organize your Sessions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 8;

Returns
Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels with user-defined metadata to organize your Sessions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 8;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The labels with user-defined metadata to organize your Sessions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 8;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels with user-defined metadata to organize your Sessions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public String getName()

Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getSessionState()

public Struct getSessionState()

Optional. Session specific memory which stores key conversation points.

.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The sessionState.

getSessionStateBuilder()

public Struct.Builder getSessionStateBuilder()

Optional. Session specific memory which stores key conversation points.

.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Builder

getSessionStateOrBuilder()

public StructOrBuilder getSessionStateOrBuilder()

Optional. Session specific memory which stores key conversation points.

.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getTtl()

public Duration getTtl()

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
Duration	The ttl.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
Builder

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
DurationOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when the session was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when the session was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the session was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getUserId()

public String getUserId()

Required. Immutable. String id provided by the user

string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The userId.

getUserIdBytes()

public ByteString getUserIdBytes()

Required. Immutable. String id provided by the user

string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for userId.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasExpireTime()

public boolean hasExpireTime()

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the expireTime field is set.

hasSessionState()

public boolean hasSessionState()

Optional. Session specific memory which stores key conversation points.

.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the sessionState field is set.

hasTtl()

public boolean hasTtl()

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
boolean	Whether the ttl field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when the session was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public Session.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Session.Builder

mergeExpireTime(Timestamp value)

public Session.Builder mergeExpireTime(Timestamp value)

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Session.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Session.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSessionState(Struct value)

public Session.Builder mergeSessionState(Struct value)

Optional. Session specific memory which stores key conversation points.

.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
Session.Builder

mergeTtl(Duration value)

public Session.Builder mergeTtl(Duration value)

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
value	Duration

Returns
Type	Description
Session.Builder

mergeUpdateTime(Timestamp value)

public Session.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when the session was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Session.Builder

putAllLabels(Map<String,String> values)

public Session.Builder putAllLabels(Map<String,String> values)

The labels with user-defined metadata to organize your Sessions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 8;

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
Session.Builder

putLabels(String key, String value)

public Session.Builder putLabels(String key, String value)

The labels with user-defined metadata to organize your Sessions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 8;

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
Session.Builder

removeLabels(String key)

public Session.Builder removeLabels(String key)

The labels with user-defined metadata to organize your Sessions.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 8;

Parameter
Name	Description
key	String

Returns
Type	Description
Session.Builder

setCreateTime(Timestamp value)

public Session.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Session.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Session.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the session was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Session.Builder

setDisplayName(String value)

public Session.Builder setDisplayName(String value)

Optional. The display name of the session.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The 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.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
Session.Builder	This builder for chaining.

setExpireTime(Timestamp value)

public Session.Builder setExpireTime(Timestamp value)

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Session.Builder

setExpireTime(Timestamp.Builder builderForValue)

public Session.Builder setExpireTime(Timestamp.Builder builderForValue)

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Session.Builder

setName(String value)

public Session.Builder setName(String value)

Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Session.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Session.Builder setNameBytes(ByteString value)

Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Session.Builder	This builder for chaining.

setSessionState(Struct value)

public Session.Builder setSessionState(Struct value)

Optional. Session specific memory which stores key conversation points.

.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
Session.Builder

setSessionState(Struct.Builder builderForValue)

public Session.Builder setSessionState(Struct.Builder builderForValue)

Optional. Session specific memory which stores key conversation points.

.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Session.Builder

setTtl(Duration value)

public Session.Builder setTtl(Duration value)

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
value	Duration

Returns
Type	Description
Session.Builder

setTtl(Duration.Builder builderForValue)

public Session.Builder setTtl(Duration.Builder builderForValue)

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Session.Builder

setUpdateTime(Timestamp value)

public Session.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when the session was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Session.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Session.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the session was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Session.Builder

setUserId(String value)

public Session.Builder setUserId(String value)

Required. Immutable. String id provided by the user

string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The userId to set.

Returns
Type	Description
Session.Builder	This builder for chaining.

setUserIdBytes(ByteString value)

public Session.Builder setUserIdBytes(ByteString value)

Required. Immutable. String id provided by the user

string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for userId to set.

Returns
Type	Description
Session.Builder	This builder for chaining.