Interface StreamChatAiAssistantResponseOrBuilder (0.19.0)

public interface StreamChatAiAssistantResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArtifactChunk()

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

getEventCase()

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

getEventId()

public abstract String getEventId()

Unique identifier for the event.

string event_id = 1;

Returns
Type Description
String

The eventId.

getEventIdBytes()

public abstract ByteString getEventIdBytes()

Unique identifier for the event.

string event_id = 1;

Returns
Type Description
ByteString

The bytes for eventId.

getEventTime()

public abstract Timestamp getEventTime()

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Returns
Type Description
Timestamp

The eventTime.

getEventTimeOrBuilder()

public abstract TimestampOrBuilder getEventTimeOrBuilder()

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Returns
Type Description
TimestampOrBuilder

getHandoff()

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

getResumeSnapshot()

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

getSessionCheckpoint()

public abstract 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 abstract 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 abstract Status getStatus()

Simple status update.

.google.rpc.Status status = 4;

Returns
Type Description
com.google.rpc.Status

The status.

getStatusOrBuilder()

public abstract StatusOrBuilder getStatusOrBuilder()

Simple status update.

.google.rpc.Status status = 4;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getTextChunk()

public abstract String getTextChunk()

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

string text_chunk = 3;

Returns
Type Description
String

The textChunk.

getTextChunkBytes()

public abstract 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 abstract String getThoughtChunk()

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

string thought_chunk = 6;

Returns
Type Description
String

The thoughtChunk.

getThoughtChunkBytes()

public abstract 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 abstract ToolCall getToolCall()

Tool call execution event.

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

Returns
Type Description
ToolCall

The toolCall.

getToolCallOrBuilder()

public abstract ToolCallOrBuilder getToolCallOrBuilder()

Tool call execution event.

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

Returns
Type Description
ToolCallOrBuilder

getToolResponse()

public abstract ToolResponse getToolResponse()

Tool call response event.

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

Returns
Type Description
ToolResponse

The toolResponse.

getToolResponseOrBuilder()

public abstract ToolResponseOrBuilder getToolResponseOrBuilder()

Tool call response event.

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

Returns
Type Description
ToolResponseOrBuilder

getTurnCompleted()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasStatus()

Simple status update.

.google.rpc.Status status = 4;

Returns
Type Description
boolean

Whether the status field is set.

hasTextChunk()

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