Class ChatAiAssistantRequest.Builder (0.19.0)

public static final class ChatAiAssistantRequest.Builder extends GeneratedMessage.Builder<ChatAiAssistantRequest.Builder> implements ChatAiAssistantRequestOrBuilder

Request message for AssistantService.ChatAiAssistant.

Protobuf type google.cloud.ces.v1beta.ChatAiAssistantRequest

Static Methods

getDescriptor()

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

Methods

addAllAttachedGcsUris(Iterable<String> values)

public ChatAiAssistantRequest.Builder addAllAttachedGcsUris(Iterable<String> values)

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
values Iterable<String>

The attachedGcsUris to add.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

addAttachedGcsUris(String value)

public ChatAiAssistantRequest.Builder addAttachedGcsUris(String value)

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
value String

The attachedGcsUris to add.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

addAttachedGcsUrisBytes(ByteString value)

public ChatAiAssistantRequest.Builder addAttachedGcsUrisBytes(ByteString value)

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
value ByteString

The bytes of the attachedGcsUris to add.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

build()

public ChatAiAssistantRequest build()
Returns
Type Description
ChatAiAssistantRequest

buildPartial()

public ChatAiAssistantRequest buildPartial()
Returns
Type Description
ChatAiAssistantRequest

clear()

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

clearApp()

public ChatAiAssistantRequest.Builder clearApp()

Required. The app to run assistant for. Format: projects/{project}/locations/{location}/apps/{app}

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

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

clearAssistantSession()

public ChatAiAssistantRequest.Builder clearAssistantSession()

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

string assistant_session = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

clearAttachedGcsUris()

public ChatAiAssistantRequest.Builder clearAttachedGcsUris()

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

This builder for chaining.

clearContextToken()

public ChatAiAssistantRequest.Builder clearContextToken()

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

This builder for chaining.

clearMessage()

public ChatAiAssistantRequest.Builder clearMessage()

Required. The message to send to the assistant agent.

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

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

getApp()

public String getApp()

Required. The app to run assistant for. Format: projects/{project}/locations/{location}/apps/{app}

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

Returns
Type Description
String

The app.

getAppBytes()

public ByteString getAppBytes()

Required. The app to run assistant for. Format: projects/{project}/locations/{location}/apps/{app}

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

Returns
Type Description
ByteString

The bytes for app.

getAssistantSession()

public String getAssistantSession()

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

string assistant_session = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The assistantSession.

getAssistantSessionBytes()

public ByteString getAssistantSessionBytes()

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

string assistant_session = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for assistantSession.

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.

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 ChatAiAssistantRequest getDefaultInstanceForType()
Returns
Type Description
ChatAiAssistantRequest

getDescriptorForType()

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

getMessage()

public String getMessage()

Required. The message to send to the assistant agent.

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

Returns
Type Description
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

Required. The message to send to the assistant agent.

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

Returns
Type Description
ByteString

The bytes for message.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ChatAiAssistantRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setApp(String value)

public ChatAiAssistantRequest.Builder setApp(String value)

Required. The app to run assistant for. Format: projects/{project}/locations/{location}/apps/{app}

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

Parameter
Name Description
value String

The app to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

setAppBytes(ByteString value)

public ChatAiAssistantRequest.Builder setAppBytes(ByteString value)

Required. The app to run assistant for. Format: projects/{project}/locations/{location}/apps/{app}

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

Parameter
Name Description
value ByteString

The bytes for app to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

setAssistantSession(String value)

public ChatAiAssistantRequest.Builder setAssistantSession(String value)

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

string assistant_session = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The assistantSession to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

setAssistantSessionBytes(ByteString value)

public ChatAiAssistantRequest.Builder setAssistantSessionBytes(ByteString value)

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

string assistant_session = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for assistantSession to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

setAttachedGcsUris(int index, String value)

public ChatAiAssistantRequest.Builder setAttachedGcsUris(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The attachedGcsUris to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

setContextToken(String value)

public ChatAiAssistantRequest.Builder setContextToken(String value)

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];

Parameter
Name Description
value String

The contextToken to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

setContextTokenBytes(ByteString value)

public ChatAiAssistantRequest.Builder setContextTokenBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for contextToken to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

setMessage(String value)

public ChatAiAssistantRequest.Builder setMessage(String value)

Required. The message to send to the assistant agent.

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

Parameter
Name Description
value String

The message to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.

setMessageBytes(ByteString value)

public ChatAiAssistantRequest.Builder setMessageBytes(ByteString value)

Required. The message to send to the assistant agent.

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

Parameter
Name Description
value ByteString

The bytes for message to set.

Returns
Type Description
ChatAiAssistantRequest.Builder

This builder for chaining.