Interface AssistantSessionOrBuilder (0.19.0)

public interface AssistantSessionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActiveTurn()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getRequestor()

public abstract 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 abstract 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.

getSessionCheckpoint()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.