Class StreamChatAiAssistantRequest (0.19.0)

public final class StreamChatAiAssistantRequest extends GeneratedMessage implements StreamChatAiAssistantRequestOrBuilder

Request message for SessionService.StreamChatAiAssistant.

Protobuf type google.cloud.ces.v1beta.StreamChatAiAssistantRequest

Inheritance

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

Static Fields

ATTACHED_GCS_URIS_FIELD_NUMBER

public static final int ATTACHED_GCS_URIS_FIELD_NUMBER
Field Value
Type Description
int

ATTACH_ONLY_FIELD_NUMBER

public static final int ATTACH_ONLY_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_CAPABILITIES_FIELD_NUMBER

public static final int CLIENT_CAPABILITIES_FIELD_NUMBER
Field Value
Type Description
int

CONFIRMATION_RESPONSE_FIELD_NUMBER

public static final int CONFIRMATION_RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

CONTEXT_TOKEN_FIELD_NUMBER

public static final int CONTEXT_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_COMPLETED_EVENT_FIELD_NUMBER

public static final int OPERATION_COMPLETED_EVENT_FIELD_NUMBER
Field Value
Type Description
int

RESUME_FROM_SEQUENCE_NUMBER_FIELD_NUMBER

public static final int RESUME_FROM_SEQUENCE_NUMBER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StreamChatAiAssistantRequest getDefaultInstance()
Returns
Type Description
StreamChatAiAssistantRequest

getDescriptor()

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

newBuilder()

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

newBuilder(StreamChatAiAssistantRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAttachOnly()

public boolean getAttachOnly()

Optional. Optional flag to attach to an existing in-flight turn without submitting a new message.

bool attach_only = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The attachOnly.

getAttachedGcsUris(int index)

public String getAttachedGcsUris(int index)

Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"

repeated string attached_gcs_uris = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The attachedGcsUris at the given index.

getAttachedGcsUrisBytes(int index)

public ByteString getAttachedGcsUrisBytes(int index)

Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"

repeated string attached_gcs_uris = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the attachedGcsUris at the given index.

getAttachedGcsUrisCount()

public int getAttachedGcsUrisCount()

Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"

repeated string attached_gcs_uris = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of attachedGcsUris.

getAttachedGcsUrisList()

public ProtocolStringList getAttachedGcsUrisList()

Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"

repeated string attached_gcs_uris = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the attachedGcsUris.

getClientCapabilities(int index)

public StreamChatAiAssistantRequest.ClientCapability getClientCapabilities(int index)

Optional. Response features this client can render. The server only emits events that need a capability (e.g. confirmation_request) when the capability is declared, so older clients never receive events they would silently drop.

repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
StreamChatAiAssistantRequest.ClientCapability

The clientCapabilities at the given index.

getClientCapabilitiesCount()

public int getClientCapabilitiesCount()

Optional. Response features this client can render. The server only emits events that need a capability (e.g. confirmation_request) when the capability is declared, so older clients never receive events they would silently drop.

repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of clientCapabilities.

getClientCapabilitiesList()

public List<StreamChatAiAssistantRequest.ClientCapability> getClientCapabilitiesList()

Optional. Response features this client can render. The server only emits events that need a capability (e.g. confirmation_request) when the capability is declared, so older clients never receive events they would silently drop.

repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ClientCapability>

A list containing the clientCapabilities.

getClientCapabilitiesValue(int index)

public int getClientCapabilitiesValue(int index)

Optional. Response features this client can render. The server only emits events that need a capability (e.g. confirmation_request) when the capability is declared, so older clients never receive events they would silently drop.

repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of clientCapabilities at the given index.

getClientCapabilitiesValueList()

public List<Integer> getClientCapabilitiesValueList()

Optional. Response features this client can render. The server only emits events that need a capability (e.g. confirmation_request) when the capability is declared, so older clients never receive events they would silently drop.

repeated .google.cloud.ces.v1beta.StreamChatAiAssistantRequest.ClientCapability client_capabilities = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for clientCapabilities.

getConfirmationResponse()

public AssistantConfirmationResponse getConfirmationResponse()

Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.

.google.cloud.ces.v1beta.AssistantConfirmationResponse confirmation_response = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AssistantConfirmationResponse

The confirmationResponse.

getConfirmationResponseOrBuilder()

public AssistantConfirmationResponseOrBuilder getConfirmationResponseOrBuilder()

Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.

.google.cloud.ces.v1beta.AssistantConfirmationResponse confirmation_response = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AssistantConfirmationResponseOrBuilder

getContextToken()

public String getContextToken()

Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn.

string context_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The contextToken.

getContextTokenBytes()

public ByteString getContextTokenBytes()

Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn.

string context_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for contextToken.

getDefaultInstanceForType()

public StreamChatAiAssistantRequest getDefaultInstanceForType()
Returns
Type Description
StreamChatAiAssistantRequest

getMessage()

public String getMessage()

Optional. The message to send to the assistant agent. May be empty when confirmation_response is set (answering a pending confirmation without adding a new message); at least one of the two must be provided.

string message = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

Optional. The message to send to the assistant agent. May be empty when confirmation_response is set (answering a pending confirmation without adding a new message); at least one of the two must be provided.

string message = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for message.

getName()

public String getName()

Required. The assistant session to be used to run the assistant. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The assistant session to be used to run the assistant. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getOperationCompletedEvent()

public OperationCompletedEvent getOperationCompletedEvent()

Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.

.google.cloud.ces.v1beta.OperationCompletedEvent operation_completed_event = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OperationCompletedEvent

The operationCompletedEvent.

getOperationCompletedEventOrBuilder()

public OperationCompletedEventOrBuilder getOperationCompletedEventOrBuilder()

Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.

.google.cloud.ces.v1beta.OperationCompletedEvent operation_completed_event = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OperationCompletedEventOrBuilder

getParserForType()

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

getResumeFromSequenceNumber()

public long getResumeFromSequenceNumber()

Optional. Optional cursor to resume and replay events from an in-flight or completed turn.

int64 resume_from_sequence_number = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The resumeFromSequenceNumber.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasConfirmationResponse()

public boolean hasConfirmationResponse()

Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.

.google.cloud.ces.v1beta.AssistantConfirmationResponse confirmation_response = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the confirmationResponse field is set.

hasOperationCompletedEvent()

public boolean hasOperationCompletedEvent()

Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.

.google.cloud.ces.v1beta.OperationCompletedEvent operation_completed_event = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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