Class AssistantSession (0.19.0)

public final class AssistantSession extends GeneratedMessage implements AssistantSessionOrBuilder

An assistant session represents a conversation between a user and the assistant agent.

Protobuf type google.cloud.ces.v1beta.AssistantSession

Static Fields

ACTIVE_TURN_FIELD_NUMBER

public static final int ACTIVE_TURN_FIELD_NUMBER
Field Value
Type Description
int

ARTIFACTS_FIELD_NUMBER

public static final int ARTIFACTS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MESSAGES_FIELD_NUMBER

public static final int MESSAGES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REQUESTOR_FIELD_NUMBER

public static final int REQUESTOR_FIELD_NUMBER
Field Value
Type Description
int

SESSION_CHECKPOINT_FIELD_NUMBER

public static final int SESSION_CHECKPOINT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

USER_RESPONSE_SUGGESTIONS_FIELD_NUMBER

public static final int USER_RESPONSE_SUGGESTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AssistantSession getDefaultInstance()
Returns
Type Description
AssistantSession

getDescriptor()

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

newBuilder()

public static AssistantSession.Builder newBuilder()
Returns
Type Description
AssistantSession.Builder

newBuilder(AssistantSession prototype)

public static AssistantSession.Builder newBuilder(AssistantSession prototype)
Parameter
Name Description
prototype AssistantSession
Returns
Type Description
AssistantSession.Builder

parseDelimitedFrom(InputStream input)

public static AssistantSession parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AssistantSession
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AssistantSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantSession
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AssistantSession parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AssistantSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AssistantSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AssistantSession parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AssistantSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AssistantSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AssistantSession parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AssistantSession
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AssistantSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantSession
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AssistantSession parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AssistantSession
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AssistantSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantSession
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AssistantSession parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AssistantSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AssistantSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AssistantSession
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AssistantSession> parser()
Returns
Type Description
Parser<AssistantSession>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActiveTurn()

public ActiveTurnInfo getActiveTurn()

Output only. Attachment info for this session's currently running turn. Unset when no turn is running.

.google.cloud.ces.v1beta.ActiveTurnInfo active_turn = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ActiveTurnInfo

The activeTurn.

getActiveTurnOrBuilder()

public ActiveTurnInfoOrBuilder getActiveTurnOrBuilder()

Output only. Attachment info for this session's currently running turn. Unset when no turn is running.

.google.cloud.ces.v1beta.ActiveTurnInfo active_turn = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ActiveTurnInfoOrBuilder

getArtifacts(int index)

public AssistantSessionArtifact getArtifacts(int index)

Output only. Document artifacts (e.g. generated TDDs in markdown) produced by the assistant in this session. Pointers only; the file content lives in the customer's Cloud Storage bucket.

repeated .google.cloud.ces.v1beta.AssistantSessionArtifact artifacts = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AssistantSessionArtifact

getArtifactsCount()

public int getArtifactsCount()

Output only. Document artifacts (e.g. generated TDDs in markdown) produced by the assistant in this session. Pointers only; the file content lives in the customer's Cloud Storage bucket.

repeated .google.cloud.ces.v1beta.AssistantSessionArtifact artifacts = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getArtifactsList()

public List<AssistantSessionArtifact> getArtifactsList()

Output only. Document artifacts (e.g. generated TDDs in markdown) produced by the assistant in this session. Pointers only; the file content lives in the customer's Cloud Storage bucket.

repeated .google.cloud.ces.v1beta.AssistantSessionArtifact artifacts = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AssistantSessionArtifact>

getArtifactsOrBuilder(int index)

public AssistantSessionArtifactOrBuilder getArtifactsOrBuilder(int index)

Output only. Document artifacts (e.g. generated TDDs in markdown) produced by the assistant in this session. Pointers only; the file content lives in the customer's Cloud Storage bucket.

repeated .google.cloud.ces.v1beta.AssistantSessionArtifact artifacts = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AssistantSessionArtifactOrBuilder

getArtifactsOrBuilderList()

public List<? extends AssistantSessionArtifactOrBuilder> getArtifactsOrBuilderList()

Output only. Document artifacts (e.g. generated TDDs in markdown) produced by the assistant in this session. Pointers only; the file content lives in the customer's Cloud Storage bucket.

repeated .google.cloud.ces.v1beta.AssistantSessionArtifact artifacts = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.AssistantSessionArtifactOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the assistant session was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the assistant session was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public AssistantSession getDefaultInstanceForType()
Returns
Type Description
AssistantSession

getDisplayName()

public String getDisplayName()

Optional. The display name of the assistant session.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The display name of the assistant session.

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

Returns
Type Description
ByteString

The bytes for displayName.

getMessages(int index)

public AssistantMessage getMessages(int index)

Optional. History of messages in the session.

repeated .google.cloud.ces.v1beta.AssistantMessage messages = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AssistantMessage

getMessagesCount()

public int getMessagesCount()

Optional. History of messages in the session.

repeated .google.cloud.ces.v1beta.AssistantMessage messages = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getMessagesList()

public List<AssistantMessage> getMessagesList()

Optional. History of messages in the session.

repeated .google.cloud.ces.v1beta.AssistantMessage messages = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AssistantMessage>

getMessagesOrBuilder(int index)

public AssistantMessageOrBuilder getMessagesOrBuilder(int index)

Optional. History of messages in the session.

repeated .google.cloud.ces.v1beta.AssistantMessage messages = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AssistantMessageOrBuilder

getMessagesOrBuilderList()

public List<? extends AssistantMessageOrBuilder> getMessagesOrBuilderList()

Optional. History of messages in the session.

repeated .google.cloud.ces.v1beta.AssistantMessage messages = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.AssistantMessageOrBuilder>

getName()

public String getName()

Required. Identifier. The unique identifier of the session. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Identifier. The unique identifier of the session. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<AssistantSession> getParserForType()
Returns
Type Description
Parser<AssistantSession>
Overrides

getRequestor()

public String getRequestor()

Output only. The user who initiated the session.

string requestor = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The requestor.

getRequestorBytes()

public ByteString getRequestorBytes()

Output only. The user who initiated the session.

string requestor = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for requestor.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionCheckpoint()

public SessionCheckpoint getSessionCheckpoint()

Output only. Session checkpoint containing user intent and rolling history summary.

.google.cloud.ces.v1beta.SessionCheckpoint session_checkpoint = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SessionCheckpoint

The sessionCheckpoint.

getSessionCheckpointOrBuilder()

public SessionCheckpointOrBuilder getSessionCheckpointOrBuilder()

Output only. Session checkpoint containing user intent and rolling history summary.

.google.cloud.ces.v1beta.SessionCheckpoint session_checkpoint = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SessionCheckpointOrBuilder

getState()

public AssistantSessionState getState()

Output only. The status of the assistant session.

.google.cloud.ces.v1beta.AssistantSessionState state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AssistantSessionState

The state.

getStateValue()

public int getStateValue()

Output only. The status of the assistant session.

.google.cloud.ces.v1beta.AssistantSessionState state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the assistant session was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the assistant session was last updated.

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

Returns
Type Description
TimestampOrBuilder

getUserResponseSuggestions()

public UserResponseSuggestions getUserResponseSuggestions()

Output only. Suggested user responses from the assistant agent.

.google.cloud.ces.v1beta.UserResponseSuggestions user_response_suggestions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserResponseSuggestions

The userResponseSuggestions.

getUserResponseSuggestionsOrBuilder()

public UserResponseSuggestionsOrBuilder getUserResponseSuggestionsOrBuilder()

Output only. Suggested user responses from the assistant agent.

.google.cloud.ces.v1beta.UserResponseSuggestions user_response_suggestions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserResponseSuggestionsOrBuilder

hasActiveTurn()

public boolean hasActiveTurn()

Output only. Attachment info for this session's currently running turn. Unset when no turn is running.

.google.cloud.ces.v1beta.ActiveTurnInfo active_turn = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the activeTurn field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the assistant session was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasSessionCheckpoint()

public boolean hasSessionCheckpoint()

Output only. Session checkpoint containing user intent and rolling history summary.

.google.cloud.ces.v1beta.SessionCheckpoint session_checkpoint = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sessionCheckpoint field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the assistant session was last updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hasUserResponseSuggestions()

public boolean hasUserResponseSuggestions()

Output only. Suggested user responses from the assistant agent.

.google.cloud.ces.v1beta.UserResponseSuggestions user_response_suggestions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the userResponseSuggestions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AssistantSession.Builder newBuilderForType()
Returns
Type Description
AssistantSession.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AssistantSession.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AssistantSession.Builder
Overrides

toBuilder()

public AssistantSession.Builder toBuilder()
Returns
Type Description
AssistantSession.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException