Class Session.Builder (3.64.0)

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

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

Protobuf type google.cloud.aiplatform.v1beta1.Session

Implements

SessionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

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
Overrides

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

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.

clearField(Descriptors.FieldDescriptor field)

public Session.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Session.Builder
Overrides

clearName()

public Session.Builder clearName()

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

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

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
Overrides

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

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.

clone()

public Session.Builder clone()
Returns
Type Description
Session.Builder
Overrides

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

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.

getName()

public String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.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

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.

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.

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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Session.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Session.Builder
Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Session.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Session.Builder
Overrides

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

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.

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
Overrides

setName(String value)

public Session.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.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)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.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.

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
Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Session.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Session.Builder
Overrides

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.