public final class StreamChatAiAssistantRequest extends GeneratedMessage implements StreamChatAiAssistantRequestOrBuilder
Request message for
SessionService.StreamChatAiAssistant.
Protobuf type google.cloud.ces.v1beta.StreamChatAiAssistantRequest
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static StreamChatAiAssistantRequest.Builder newBuilder()
newBuilder(StreamChatAiAssistantRequest prototype)
public static StreamChatAiAssistantRequest.Builder newBuilder(StreamChatAiAssistantRequest prototype)
public static StreamChatAiAssistantRequest parseDelimitedFrom(InputStream input)
public static StreamChatAiAssistantRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static StreamChatAiAssistantRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StreamChatAiAssistantRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static StreamChatAiAssistantRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamChatAiAssistantRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StreamChatAiAssistantRequest parseFrom(CodedInputStream input)
public static StreamChatAiAssistantRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StreamChatAiAssistantRequest parseFrom(InputStream input)
public static StreamChatAiAssistantRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static StreamChatAiAssistantRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StreamChatAiAssistantRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<StreamChatAiAssistantRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
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.
|
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];
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];
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];
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()
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()
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];
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];
getParserForType()
public Parser<StreamChatAiAssistantRequest> getParserForType()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public StreamChatAiAssistantRequest.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected StreamChatAiAssistantRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public StreamChatAiAssistantRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides