Class StreamChatAiAssistantResponse.Builder (0.19.0)

public static final class StreamChatAiAssistantResponse.Builder extends GeneratedMessage.Builder<StreamChatAiAssistantResponse.Builder> implements StreamChatAiAssistantResponseOrBuilder

Response message for SessionService.StreamChatAiAssistant.

Protobuf type google.cloud.ces.v1beta.StreamChatAiAssistantResponse

Static Methods

getDescriptor()

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

Methods

build()

public StreamChatAiAssistantResponse build()
Returns
Type Description
StreamChatAiAssistantResponse

buildPartial()

public StreamChatAiAssistantResponse buildPartial()
Returns
Type Description
StreamChatAiAssistantResponse

clear()

public StreamChatAiAssistantResponse.Builder clear()
Returns
Type Description
StreamChatAiAssistantResponse.Builder
Overrides

clearArtifactChunk()

public StreamChatAiAssistantResponse.Builder clearArtifactChunk()

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

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

Returns
Type Description
StreamChatAiAssistantResponse.Builder

clearConfirmationRequest()

public StreamChatAiAssistantResponse.Builder clearConfirmationRequest()

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
StreamChatAiAssistantResponse.Builder

clearEvent()

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

clearEventId()

public StreamChatAiAssistantResponse.Builder clearEventId()

Unique identifier for the event.

string event_id = 1;

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

clearEventTime()

public StreamChatAiAssistantResponse.Builder clearEventTime()

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Returns
Type Description
StreamChatAiAssistantResponse.Builder

clearHandoff()

public StreamChatAiAssistantResponse.Builder clearHandoff()

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
StreamChatAiAssistantResponse.Builder

clearOptionQuestionsChunk()

public StreamChatAiAssistantResponse.Builder clearOptionQuestionsChunk()

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
StreamChatAiAssistantResponse.Builder

clearResumeSnapshot()

public StreamChatAiAssistantResponse.Builder clearResumeSnapshot()

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
StreamChatAiAssistantResponse.Builder

clearSequenceNumber()

public StreamChatAiAssistantResponse.Builder clearSequenceNumber()

Optional. Monotonically increasing sequence number for this session turn.

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

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

clearSessionCheckpoint()

public StreamChatAiAssistantResponse.Builder clearSessionCheckpoint()

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

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

Returns
Type Description
StreamChatAiAssistantResponse.Builder

clearStatus()

public StreamChatAiAssistantResponse.Builder clearStatus()

Simple status update.

.google.rpc.Status status = 4;

Returns
Type Description
StreamChatAiAssistantResponse.Builder

clearTextChunk()

public StreamChatAiAssistantResponse.Builder clearTextChunk()

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

string text_chunk = 3;

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

clearThoughtChunk()

public StreamChatAiAssistantResponse.Builder clearThoughtChunk()

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

string thought_chunk = 6;

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

clearToolCall()

public StreamChatAiAssistantResponse.Builder clearToolCall()

Tool call execution event.

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

Returns
Type Description
StreamChatAiAssistantResponse.Builder

clearToolResponse()

public StreamChatAiAssistantResponse.Builder clearToolResponse()

Tool call response event.

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

Returns
Type Description
StreamChatAiAssistantResponse.Builder

clearTurnCompleted()

public StreamChatAiAssistantResponse.Builder clearTurnCompleted()

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
StreamChatAiAssistantResponse.Builder

clearTurnInProgress()

public StreamChatAiAssistantResponse.Builder clearTurnInProgress()

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
StreamChatAiAssistantResponse.Builder

This builder for chaining.

clearTurnMetadata()

public StreamChatAiAssistantResponse.Builder clearTurnMetadata()

Optional. Turn-level metadata and intent categorization.

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

Returns
Type Description
StreamChatAiAssistantResponse.Builder

clearUiEvent()

public StreamChatAiAssistantResponse.Builder clearUiEvent()

Optional. UI event payload.

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

Returns
Type Description
StreamChatAiAssistantResponse.Builder

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.

getArtifactChunkBuilder()

public ArtifactChunk.Builder getArtifactChunkBuilder()

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

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

Returns
Type Description
ArtifactChunk.Builder

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.

getConfirmationRequestBuilder()

public AssistantConfirmationRequest.Builder getConfirmationRequestBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getEventTimeBuilder()

public Timestamp.Builder getEventTimeBuilder()

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Returns
Type Description
Builder

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.

getHandoffBuilder()

public TurnHandoffEvent.Builder getHandoffBuilder()

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.Builder

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.

getOptionQuestionsChunkBuilder()

public OptionQuestionsChunk.Builder getOptionQuestionsChunkBuilder()

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.Builder

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

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.

getResumeSnapshotBuilder()

public TurnResumeSnapshot.Builder getResumeSnapshotBuilder()

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.Builder

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.

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.

getSessionCheckpointBuilder()

public SessionCheckpoint.Builder getSessionCheckpointBuilder()

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

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

Returns
Type Description
SessionCheckpoint.Builder

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.

getStatusBuilder()

public Status.Builder getStatusBuilder()

Simple status update.

.google.rpc.Status status = 4;

Returns
Type Description
com.google.rpc.Status.Builder

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.

getToolCallBuilder()

public ToolCall.Builder getToolCallBuilder()

Tool call execution event.

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

Returns
Type Description
ToolCall.Builder

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.

getToolResponseBuilder()

public ToolResponse.Builder getToolResponseBuilder()

Tool call response event.

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

Returns
Type Description
ToolResponse.Builder

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.

getTurnCompletedBuilder()

public TurnCompletedEvent.Builder getTurnCompletedBuilder()

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.Builder

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.

getTurnMetadataBuilder()

public TurnMetadata.Builder getTurnMetadataBuilder()

Optional. Turn-level metadata and intent categorization.

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

Returns
Type Description
TurnMetadata.Builder

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.

getUiEventBuilder()

public UiEvent.Builder getUiEventBuilder()

Optional. UI event payload.

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

Returns
Type Description
UiEvent.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeArtifactChunk(ArtifactChunk value)

public StreamChatAiAssistantResponse.Builder mergeArtifactChunk(ArtifactChunk value)

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

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

Parameter
Name Description
value ArtifactChunk
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeConfirmationRequest(AssistantConfirmationRequest value)

public StreamChatAiAssistantResponse.Builder mergeConfirmationRequest(AssistantConfirmationRequest value)

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;

Parameter
Name Description
value AssistantConfirmationRequest
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeEventTime(Timestamp value)

public StreamChatAiAssistantResponse.Builder mergeEventTime(Timestamp value)

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeFrom(StreamChatAiAssistantResponse other)

public StreamChatAiAssistantResponse.Builder mergeFrom(StreamChatAiAssistantResponse other)
Parameter
Name Description
other StreamChatAiAssistantResponse
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StreamChatAiAssistantResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamChatAiAssistantResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeHandoff(TurnHandoffEvent value)

public StreamChatAiAssistantResponse.Builder mergeHandoff(TurnHandoffEvent value)

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;

Parameter
Name Description
value TurnHandoffEvent
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeOptionQuestionsChunk(OptionQuestionsChunk value)

public StreamChatAiAssistantResponse.Builder mergeOptionQuestionsChunk(OptionQuestionsChunk value)

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;

Parameter
Name Description
value OptionQuestionsChunk
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeResumeSnapshot(TurnResumeSnapshot value)

public StreamChatAiAssistantResponse.Builder mergeResumeSnapshot(TurnResumeSnapshot value)

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;

Parameter
Name Description
value TurnResumeSnapshot
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeSessionCheckpoint(SessionCheckpoint value)

public StreamChatAiAssistantResponse.Builder mergeSessionCheckpoint(SessionCheckpoint value)

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

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

Parameter
Name Description
value SessionCheckpoint
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeStatus(Status value)

public StreamChatAiAssistantResponse.Builder mergeStatus(Status value)

Simple status update.

.google.rpc.Status status = 4;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeToolCall(ToolCall value)

public StreamChatAiAssistantResponse.Builder mergeToolCall(ToolCall value)

Tool call execution event.

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

Parameter
Name Description
value ToolCall
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeToolResponse(ToolResponse value)

public StreamChatAiAssistantResponse.Builder mergeToolResponse(ToolResponse value)

Tool call response event.

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

Parameter
Name Description
value ToolResponse
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeTurnCompleted(TurnCompletedEvent value)

public StreamChatAiAssistantResponse.Builder mergeTurnCompleted(TurnCompletedEvent value)

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;

Parameter
Name Description
value TurnCompletedEvent
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeTurnMetadata(TurnMetadata value)

public StreamChatAiAssistantResponse.Builder mergeTurnMetadata(TurnMetadata value)

Optional. Turn-level metadata and intent categorization.

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

Parameter
Name Description
value TurnMetadata
Returns
Type Description
StreamChatAiAssistantResponse.Builder

mergeUiEvent(UiEvent value)

public StreamChatAiAssistantResponse.Builder mergeUiEvent(UiEvent value)

Optional. UI event payload.

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

Parameter
Name Description
value UiEvent
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setArtifactChunk(ArtifactChunk value)

public StreamChatAiAssistantResponse.Builder setArtifactChunk(ArtifactChunk value)

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

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

Parameter
Name Description
value ArtifactChunk
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setArtifactChunk(ArtifactChunk.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setArtifactChunk(ArtifactChunk.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue ArtifactChunk.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setConfirmationRequest(AssistantConfirmationRequest value)

public StreamChatAiAssistantResponse.Builder setConfirmationRequest(AssistantConfirmationRequest value)

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;

Parameter
Name Description
value AssistantConfirmationRequest
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setConfirmationRequest(AssistantConfirmationRequest.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setConfirmationRequest(AssistantConfirmationRequest.Builder builderForValue)

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;

Parameter
Name Description
builderForValue AssistantConfirmationRequest.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setEventId(String value)

public StreamChatAiAssistantResponse.Builder setEventId(String value)

Unique identifier for the event.

string event_id = 1;

Parameter
Name Description
value String

The eventId to set.

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

setEventIdBytes(ByteString value)

public StreamChatAiAssistantResponse.Builder setEventIdBytes(ByteString value)

Unique identifier for the event.

string event_id = 1;

Parameter
Name Description
value ByteString

The bytes for eventId to set.

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

setEventTime(Timestamp value)

public StreamChatAiAssistantResponse.Builder setEventTime(Timestamp value)

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setEventTime(Timestamp.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setEventTime(Timestamp.Builder builderForValue)

Timestamp when the event occurred.

.google.protobuf.Timestamp event_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setHandoff(TurnHandoffEvent value)

public StreamChatAiAssistantResponse.Builder setHandoff(TurnHandoffEvent value)

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;

Parameter
Name Description
value TurnHandoffEvent
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setHandoff(TurnHandoffEvent.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setHandoff(TurnHandoffEvent.Builder builderForValue)

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;

Parameter
Name Description
builderForValue TurnHandoffEvent.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setOptionQuestionsChunk(OptionQuestionsChunk value)

public StreamChatAiAssistantResponse.Builder setOptionQuestionsChunk(OptionQuestionsChunk value)

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;

Parameter
Name Description
value OptionQuestionsChunk
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setOptionQuestionsChunk(OptionQuestionsChunk.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setOptionQuestionsChunk(OptionQuestionsChunk.Builder builderForValue)

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;

Parameter
Name Description
builderForValue OptionQuestionsChunk.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setResumeSnapshot(TurnResumeSnapshot value)

public StreamChatAiAssistantResponse.Builder setResumeSnapshot(TurnResumeSnapshot value)

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;

Parameter
Name Description
value TurnResumeSnapshot
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setResumeSnapshot(TurnResumeSnapshot.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setResumeSnapshot(TurnResumeSnapshot.Builder builderForValue)

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;

Parameter
Name Description
builderForValue TurnResumeSnapshot.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setSequenceNumber(long value)

public StreamChatAiAssistantResponse.Builder setSequenceNumber(long value)

Optional. Monotonically increasing sequence number for this session turn.

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

Parameter
Name Description
value long

The sequenceNumber to set.

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

setSessionCheckpoint(SessionCheckpoint value)

public StreamChatAiAssistantResponse.Builder setSessionCheckpoint(SessionCheckpoint value)

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

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

Parameter
Name Description
value SessionCheckpoint
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setSessionCheckpoint(SessionCheckpoint.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setSessionCheckpoint(SessionCheckpoint.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue SessionCheckpoint.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setStatus(Status value)

public StreamChatAiAssistantResponse.Builder setStatus(Status value)

Simple status update.

.google.rpc.Status status = 4;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setStatus(Status.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setStatus(Status.Builder builderForValue)

Simple status update.

.google.rpc.Status status = 4;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setTextChunk(String value)

public StreamChatAiAssistantResponse.Builder setTextChunk(String value)

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

string text_chunk = 3;

Parameter
Name Description
value String

The textChunk to set.

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

setTextChunkBytes(ByteString value)

public StreamChatAiAssistantResponse.Builder setTextChunkBytes(ByteString value)

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

string text_chunk = 3;

Parameter
Name Description
value ByteString

The bytes for textChunk to set.

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

setThoughtChunk(String value)

public StreamChatAiAssistantResponse.Builder setThoughtChunk(String value)

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

string thought_chunk = 6;

Parameter
Name Description
value String

The thoughtChunk to set.

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

setThoughtChunkBytes(ByteString value)

public StreamChatAiAssistantResponse.Builder setThoughtChunkBytes(ByteString value)

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

string thought_chunk = 6;

Parameter
Name Description
value ByteString

The bytes for thoughtChunk to set.

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

setToolCall(ToolCall value)

public StreamChatAiAssistantResponse.Builder setToolCall(ToolCall value)

Tool call execution event.

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

Parameter
Name Description
value ToolCall
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setToolCall(ToolCall.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setToolCall(ToolCall.Builder builderForValue)

Tool call execution event.

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

Parameter
Name Description
builderForValue ToolCall.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setToolResponse(ToolResponse value)

public StreamChatAiAssistantResponse.Builder setToolResponse(ToolResponse value)

Tool call response event.

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

Parameter
Name Description
value ToolResponse
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setToolResponse(ToolResponse.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setToolResponse(ToolResponse.Builder builderForValue)

Tool call response event.

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

Parameter
Name Description
builderForValue ToolResponse.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setTurnCompleted(TurnCompletedEvent value)

public StreamChatAiAssistantResponse.Builder setTurnCompleted(TurnCompletedEvent value)

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;

Parameter
Name Description
value TurnCompletedEvent
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setTurnCompleted(TurnCompletedEvent.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setTurnCompleted(TurnCompletedEvent.Builder builderForValue)

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;

Parameter
Name Description
builderForValue TurnCompletedEvent.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setTurnInProgress(boolean value)

public StreamChatAiAssistantResponse.Builder setTurnInProgress(boolean value)

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

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

Parameter
Name Description
value boolean

The turnInProgress to set.

Returns
Type Description
StreamChatAiAssistantResponse.Builder

This builder for chaining.

setTurnMetadata(TurnMetadata value)

public StreamChatAiAssistantResponse.Builder setTurnMetadata(TurnMetadata value)

Optional. Turn-level metadata and intent categorization.

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

Parameter
Name Description
value TurnMetadata
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setTurnMetadata(TurnMetadata.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setTurnMetadata(TurnMetadata.Builder builderForValue)

Optional. Turn-level metadata and intent categorization.

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

Parameter
Name Description
builderForValue TurnMetadata.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setUiEvent(UiEvent value)

public StreamChatAiAssistantResponse.Builder setUiEvent(UiEvent value)

Optional. UI event payload.

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

Parameter
Name Description
value UiEvent
Returns
Type Description
StreamChatAiAssistantResponse.Builder

setUiEvent(UiEvent.Builder builderForValue)

public StreamChatAiAssistantResponse.Builder setUiEvent(UiEvent.Builder builderForValue)

Optional. UI event payload.

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

Parameter
Name Description
builderForValue UiEvent.Builder
Returns
Type Description
StreamChatAiAssistantResponse.Builder