Class StreamChatAiAssistantResponse (0.19.0)

public final class StreamChatAiAssistantResponse extends GeneratedMessage implements StreamChatAiAssistantResponseOrBuilder

Response message for SessionService.StreamChatAiAssistant.

Protobuf type google.cloud.ces.v1beta.StreamChatAiAssistantResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > StreamChatAiAssistantResponse

Static Fields

ARTIFACT_CHUNK_FIELD_NUMBER

public static final int ARTIFACT_CHUNK_FIELD_NUMBER
Field Value
Type Description
int

CONFIRMATION_REQUEST_FIELD_NUMBER

public static final int CONFIRMATION_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

EVENT_ID_FIELD_NUMBER

public static final int EVENT_ID_FIELD_NUMBER
Field Value
Type Description
int

EVENT_TIME_FIELD_NUMBER

public static final int EVENT_TIME_FIELD_NUMBER
Field Value
Type Description
int

HANDOFF_FIELD_NUMBER

public static final int HANDOFF_FIELD_NUMBER
Field Value
Type Description
int

OPTION_QUESTIONS_CHUNK_FIELD_NUMBER

public static final int OPTION_QUESTIONS_CHUNK_FIELD_NUMBER
Field Value
Type Description
int

RESUME_SNAPSHOT_FIELD_NUMBER

public static final int RESUME_SNAPSHOT_FIELD_NUMBER
Field Value
Type Description
int

SEQUENCE_NUMBER_FIELD_NUMBER

public static final int SEQUENCE_NUMBER_FIELD_NUMBER
Field Value
Type Description
int

SESSION_CHECKPOINT_FIELD_NUMBER

public static final int SESSION_CHECKPOINT_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_CHUNK_FIELD_NUMBER

public static final int TEXT_CHUNK_FIELD_NUMBER
Field Value
Type Description
int

THOUGHT_CHUNK_FIELD_NUMBER

public static final int THOUGHT_CHUNK_FIELD_NUMBER
Field Value
Type Description
int

TOOL_CALL_FIELD_NUMBER

public static final int TOOL_CALL_FIELD_NUMBER
Field Value
Type Description
int

TOOL_RESPONSE_FIELD_NUMBER

public static final int TOOL_RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

TURN_COMPLETED_FIELD_NUMBER

public static final int TURN_COMPLETED_FIELD_NUMBER
Field Value
Type Description
int

TURN_IN_PROGRESS_FIELD_NUMBER

public static final int TURN_IN_PROGRESS_FIELD_NUMBER
Field Value
Type Description
int

TURN_METADATA_FIELD_NUMBER

public static final int TURN_METADATA_FIELD_NUMBER
Field Value
Type Description
int

UI_EVENT_FIELD_NUMBER

public static final int UI_EVENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StreamChatAiAssistantResponse getDefaultInstance()
Returns
Type Description
StreamChatAiAssistantResponse

getDescriptor()

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

newBuilder()

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

newBuilder(StreamChatAiAssistantResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getArtifactChunk()

public ArtifactChunk getArtifactChunk()

Generated-document artifact event (live preview deltas + final GCS pointer).

.google.cloud.ces.v1beta.ArtifactChunk artifact_chunk = 9;

Returns
Type Description
ArtifactChunk

The artifactChunk.

getArtifactChunkOrBuilder()

public ArtifactChunkOrBuilder getArtifactChunkOrBuilder()

Generated-document artifact event (live preview deltas + final GCS pointer).

.google.cloud.ces.v1beta.ArtifactChunk artifact_chunk = 9;

Returns
Type Description
ArtifactChunkOrBuilder

getConfirmationRequest()

public AssistantConfirmationRequest getConfirmationRequest()

A blocking confirmation the agent paused on. The agent resumes when the answer arrives on a later request's confirmation_response. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request.

.google.cloud.ces.v1beta.AssistantConfirmationRequest confirmation_request = 12;

Returns
Type Description
AssistantConfirmationRequest

The confirmationRequest.

getConfirmationRequestOrBuilder()

public AssistantConfirmationRequestOrBuilder getConfirmationRequestOrBuilder()

A blocking confirmation the agent paused on. The agent resumes when the answer arrives on a later request's confirmation_response. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request.

.google.cloud.ces.v1beta.AssistantConfirmationRequest confirmation_request = 12;

Returns
Type Description
AssistantConfirmationRequestOrBuilder

getDefaultInstanceForType()

public StreamChatAiAssistantResponse getDefaultInstanceForType()
Returns
Type Description
StreamChatAiAssistantResponse

getEventCase()

public StreamChatAiAssistantResponse.EventCase getEventCase()
Returns
Type Description
StreamChatAiAssistantResponse.EventCase

getEventId()

public String getEventId()

Unique identifier for the event.

string event_id = 1;

Returns
Type Description
String

The eventId.

getEventIdBytes()

public ByteString getEventIdBytes()

Unique identifier for the event.

string event_id = 1;

Returns
Type Description
ByteString

The bytes for eventId.

getEventTime()

public Timestamp getEventTime()

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Returns
Type Description
Timestamp

The eventTime.

getEventTimeOrBuilder()

public TimestampOrBuilder getEventTimeOrBuilder()

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Returns
Type Description
TimestampOrBuilder

getHandoff()

public TurnHandoffEvent getHandoff()

Tells the client to silently reconnect with resume_from_sequence_number: the task serving this stream is going away and the turn will continue elsewhere. Not an error; the stream completes normally after this event.

.google.cloud.ces.v1beta.TurnHandoffEvent handoff = 18;

Returns
Type Description
TurnHandoffEvent

The handoff.

getHandoffOrBuilder()

public TurnHandoffEventOrBuilder getHandoffOrBuilder()

Tells the client to silently reconnect with resume_from_sequence_number: the task serving this stream is going away and the turn will continue elsewhere. Not an error; the stream completes normally after this event.

.google.cloud.ces.v1beta.TurnHandoffEvent handoff = 18;

Returns
Type Description
TurnHandoffEventOrBuilder

getOptionQuestionsChunk()

public OptionQuestionsChunk getOptionQuestionsChunk()

Structured clarification options parsed out of the model turn. The console renders these as a selectable option list instead of raw text.

.google.cloud.ces.v1beta.OptionQuestionsChunk option_questions_chunk = 10;

Returns
Type Description
OptionQuestionsChunk

The optionQuestionsChunk.

getOptionQuestionsChunkOrBuilder()

public OptionQuestionsChunkOrBuilder getOptionQuestionsChunkOrBuilder()

Structured clarification options parsed out of the model turn. The console renders these as a selectable option list instead of raw text.

.google.cloud.ces.v1beta.OptionQuestionsChunk option_questions_chunk = 10;

Returns
Type Description
OptionQuestionsChunkOrBuilder

getParserForType()

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

getResumeSnapshot()

public TurnResumeSnapshot getResumeSnapshot()

A compacted replay of an in-flight turn, sent as the first event of every attach or resume before any live event. The client replaces any locally rendered state for this turn with the snapshot's contents.

.google.cloud.ces.v1beta.TurnResumeSnapshot resume_snapshot = 17;

Returns
Type Description
TurnResumeSnapshot

The resumeSnapshot.

getResumeSnapshotOrBuilder()

public TurnResumeSnapshotOrBuilder getResumeSnapshotOrBuilder()

A compacted replay of an in-flight turn, sent as the first event of every attach or resume before any live event. The client replaces any locally rendered state for this turn with the snapshot's contents.

.google.cloud.ces.v1beta.TurnResumeSnapshot resume_snapshot = 17;

Returns
Type Description
TurnResumeSnapshotOrBuilder

getSequenceNumber()

public long getSequenceNumber()

Optional. Monotonically increasing sequence number for this session turn.

int64 sequence_number = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The sequenceNumber.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionCheckpoint()

public SessionCheckpoint getSessionCheckpoint()

Session checkpoint/compaction recap event containing user intent and rolling summary.

.google.cloud.ces.v1beta.SessionCheckpoint session_checkpoint = 13;

Returns
Type Description
SessionCheckpoint

The sessionCheckpoint.

getSessionCheckpointOrBuilder()

public SessionCheckpointOrBuilder getSessionCheckpointOrBuilder()

Session checkpoint/compaction recap event containing user intent and rolling summary.

.google.cloud.ces.v1beta.SessionCheckpoint session_checkpoint = 13;

Returns
Type Description
SessionCheckpointOrBuilder

getStatus()

public Status getStatus()

Simple status update.

.google.rpc.Status status = 4;

Returns
Type Description
com.google.rpc.Status

The status.

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

Simple status update.

.google.rpc.Status status = 4;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getTextChunk()

public String getTextChunk()

Text Token (for streaming Gemini responses word-by-word).

string text_chunk = 3;

Returns
Type Description
String

The textChunk.

getTextChunkBytes()

public ByteString getTextChunkBytes()

Text Token (for streaming Gemini responses word-by-word).

string text_chunk = 3;

Returns
Type Description
ByteString

The bytes for textChunk.

getThoughtChunk()

public String getThoughtChunk()

Thought text chunk (agent's reasoning before generating response).

string thought_chunk = 6;

Returns
Type Description
String

The thoughtChunk.

getThoughtChunkBytes()

public ByteString getThoughtChunkBytes()

Thought text chunk (agent's reasoning before generating response).

string thought_chunk = 6;

Returns
Type Description
ByteString

The bytes for thoughtChunk.

getToolCall()

public ToolCall getToolCall()

Tool call execution event.

.google.cloud.ces.v1beta.ToolCall tool_call = 7;

Returns
Type Description
ToolCall

The toolCall.

getToolCallOrBuilder()

public ToolCallOrBuilder getToolCallOrBuilder()

Tool call execution event.

.google.cloud.ces.v1beta.ToolCall tool_call = 7;

Returns
Type Description
ToolCallOrBuilder

getToolResponse()

public ToolResponse getToolResponse()

Tool call response event.

.google.cloud.ces.v1beta.ToolResponse tool_response = 8;

Returns
Type Description
ToolResponse

The toolResponse.

getToolResponseOrBuilder()

public ToolResponseOrBuilder getToolResponseOrBuilder()

Tool call response event.

.google.cloud.ces.v1beta.ToolResponse tool_response = 8;

Returns
Type Description
ToolResponseOrBuilder

getTurnCompleted()

public TurnCompletedEvent getTurnCompleted()

The turn has ended. Sent as the last event of every turn, on the original stream and on every attached or resumed stream, so clients can end the turn on an explicit signal instead of inferring it from stream closure.

.google.cloud.ces.v1beta.TurnCompletedEvent turn_completed = 19;

Returns
Type Description
TurnCompletedEvent

The turnCompleted.

getTurnCompletedOrBuilder()

public TurnCompletedEventOrBuilder getTurnCompletedOrBuilder()

The turn has ended. Sent as the last event of every turn, on the original stream and on every attached or resumed stream, so clients can end the turn on an explicit signal instead of inferring it from stream closure.

.google.cloud.ces.v1beta.TurnCompletedEvent turn_completed = 19;

Returns
Type Description
TurnCompletedEventOrBuilder

getTurnInProgress()

public boolean getTurnInProgress()

Optional. Indicates whether the turn is still actively running in the background.

bool turn_in_progress = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The turnInProgress.

getTurnMetadata()

public TurnMetadata getTurnMetadata()

Optional. Turn-level metadata and intent categorization.

.google.cloud.ces.v1beta.TurnMetadata turn_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TurnMetadata

The turnMetadata.

getTurnMetadataOrBuilder()

public TurnMetadataOrBuilder getTurnMetadataOrBuilder()

Optional. Turn-level metadata and intent categorization.

.google.cloud.ces.v1beta.TurnMetadata turn_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TurnMetadataOrBuilder

getUiEvent()

public UiEvent getUiEvent()

Optional. UI event payload.

.google.cloud.ces.v1beta.UiEvent ui_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UiEvent

The uiEvent.

getUiEventOrBuilder()

public UiEventOrBuilder getUiEventOrBuilder()

Optional. UI event payload.

.google.cloud.ces.v1beta.UiEvent ui_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UiEventOrBuilder

hasArtifactChunk()

public boolean hasArtifactChunk()

Generated-document artifact event (live preview deltas + final GCS pointer).

.google.cloud.ces.v1beta.ArtifactChunk artifact_chunk = 9;

Returns
Type Description
boolean

Whether the artifactChunk field is set.

hasConfirmationRequest()

public boolean hasConfirmationRequest()

A blocking confirmation the agent paused on. The agent resumes when the answer arrives on a later request's confirmation_response. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request.

.google.cloud.ces.v1beta.AssistantConfirmationRequest confirmation_request = 12;

Returns
Type Description
boolean

Whether the confirmationRequest field is set.

hasEventTime()

public boolean hasEventTime()

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Returns
Type Description
boolean

Whether the eventTime field is set.

hasHandoff()

public boolean hasHandoff()

Tells the client to silently reconnect with resume_from_sequence_number: the task serving this stream is going away and the turn will continue elsewhere. Not an error; the stream completes normally after this event.

.google.cloud.ces.v1beta.TurnHandoffEvent handoff = 18;

Returns
Type Description
boolean

Whether the handoff field is set.

hasOptionQuestionsChunk()

public boolean hasOptionQuestionsChunk()

Structured clarification options parsed out of the model turn. The console renders these as a selectable option list instead of raw text.

.google.cloud.ces.v1beta.OptionQuestionsChunk option_questions_chunk = 10;

Returns
Type Description
boolean

Whether the optionQuestionsChunk field is set.

hasResumeSnapshot()

public boolean hasResumeSnapshot()

A compacted replay of an in-flight turn, sent as the first event of every attach or resume before any live event. The client replaces any locally rendered state for this turn with the snapshot's contents.

.google.cloud.ces.v1beta.TurnResumeSnapshot resume_snapshot = 17;

Returns
Type Description
boolean

Whether the resumeSnapshot field is set.

hasSessionCheckpoint()

public boolean hasSessionCheckpoint()

Session checkpoint/compaction recap event containing user intent and rolling summary.

.google.cloud.ces.v1beta.SessionCheckpoint session_checkpoint = 13;

Returns
Type Description
boolean

Whether the sessionCheckpoint field is set.

hasStatus()

public boolean hasStatus()

Simple status update.

.google.rpc.Status status = 4;

Returns
Type Description
boolean

Whether the status field is set.

hasTextChunk()

public boolean hasTextChunk()

Text Token (for streaming Gemini responses word-by-word).

string text_chunk = 3;

Returns
Type Description
boolean

Whether the textChunk field is set.

hasThoughtChunk()

public boolean hasThoughtChunk()

Thought text chunk (agent's reasoning before generating response).

string thought_chunk = 6;

Returns
Type Description
boolean

Whether the thoughtChunk field is set.

hasToolCall()

public boolean hasToolCall()

Tool call execution event.

.google.cloud.ces.v1beta.ToolCall tool_call = 7;

Returns
Type Description
boolean

Whether the toolCall field is set.

hasToolResponse()

public boolean hasToolResponse()

Tool call response event.

.google.cloud.ces.v1beta.ToolResponse tool_response = 8;

Returns
Type Description
boolean

Whether the toolResponse field is set.

hasTurnCompleted()

public boolean hasTurnCompleted()

The turn has ended. Sent as the last event of every turn, on the original stream and on every attached or resumed stream, so clients can end the turn on an explicit signal instead of inferring it from stream closure.

.google.cloud.ces.v1beta.TurnCompletedEvent turn_completed = 19;

Returns
Type Description
boolean

Whether the turnCompleted field is set.

hasTurnMetadata()

public boolean hasTurnMetadata()

Optional. Turn-level metadata and intent categorization.

.google.cloud.ces.v1beta.TurnMetadata turn_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the turnMetadata field is set.

hasUiEvent()

public boolean hasUiEvent()

Optional. UI event payload.

.google.cloud.ces.v1beta.UiEvent ui_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the uiEvent 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 StreamChatAiAssistantResponse.Builder newBuilderForType()
Returns
Type Description
StreamChatAiAssistantResponse.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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