public static final class SessionConfig.Builder extends GeneratedMessage.Builder<SessionConfig.Builder> implements SessionConfigOrBuilderThe configuration for the session.
Protobuf type google.cloud.ces.v1.SessionConfig
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SessionConfig.BuilderImplements
SessionConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllHistoricalContexts(Iterable<? extends Message> values)
public SessionConfig.Builder addAllHistoricalContexts(Iterable<? extends Message> values)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.ces.v1.Message> |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
addHistoricalContexts(Message value)
public SessionConfig.Builder addHistoricalContexts(Message value)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Message |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
addHistoricalContexts(Message.Builder builderForValue)
public SessionConfig.Builder addHistoricalContexts(Message.Builder builderForValue)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Message.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
addHistoricalContexts(int index, Message value)
public SessionConfig.Builder addHistoricalContexts(int index, Message value)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Message |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
addHistoricalContexts(int index, Message.Builder builderForValue)
public SessionConfig.Builder addHistoricalContexts(int index, Message.Builder builderForValue)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Message.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
addHistoricalContextsBuilder()
public Message.Builder addHistoricalContextsBuilder()Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Message.Builder |
|
addHistoricalContextsBuilder(int index)
public Message.Builder addHistoricalContextsBuilder(int index)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Message.Builder |
|
build()
public SessionConfig build()| Returns | |
|---|---|
| Type | Description |
SessionConfig |
|
buildPartial()
public SessionConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
SessionConfig |
|
clear()
public SessionConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
clearDeployment()
public SessionConfig.Builder clearDeployment() Optional. The deployment of the app to use for the session.
Format:
projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
string deployment = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
clearEntryAgent()
public SessionConfig.Builder clearEntryAgent() Optional. The entry agent to handle the session. If not specified, the
session will be handled by the root
agent of the app. Format:
projects/{project}/locations/{location}/agents/{agent}
string entry_agent = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
clearHistoricalContexts()
public SessionConfig.Builder clearHistoricalContexts()Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
clearInputAudioConfig()
public SessionConfig.Builder clearInputAudioConfig()Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
clearOutputAudioConfig()
public SessionConfig.Builder clearOutputAudioConfig()Optional. Configuration for generating the output audio.
.google.cloud.ces.v1.OutputAudioConfig output_audio_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
clearRemoteDialogflowQueryParameters()
public SessionConfig.Builder clearRemoteDialogflowQueryParameters()Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
.google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters remote_dialogflow_query_parameters = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
clearSession()
public SessionConfig.Builder clearSession() Required. The unique identifier of the session.
Format:
projects/{project}/locations/{location}/apps/{app}/sessions/{session}
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
clearTimeZone()
public SessionConfig.Builder clearTimeZone()Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings.
The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
string time_zone = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public SessionConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SessionConfig |
|
getDeployment()
public String getDeployment() Optional. The deployment of the app to use for the session.
Format:
projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
string deployment = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The deployment. |
getDeploymentBytes()
public ByteString getDeploymentBytes() Optional. The deployment of the app to use for the session.
Format:
projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
string deployment = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for deployment. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEntryAgent()
public String getEntryAgent() Optional. The entry agent to handle the session. If not specified, the
session will be handled by the root
agent of the app. Format:
projects/{project}/locations/{location}/agents/{agent}
string entry_agent = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The entryAgent. |
getEntryAgentBytes()
public ByteString getEntryAgentBytes() Optional. The entry agent to handle the session. If not specified, the
session will be handled by the root
agent of the app. Format:
projects/{project}/locations/{location}/agents/{agent}
string entry_agent = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for entryAgent. |
getHistoricalContexts(int index)
public Message getHistoricalContexts(int index)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Message |
|
getHistoricalContextsBuilder(int index)
public Message.Builder getHistoricalContextsBuilder(int index)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Message.Builder |
|
getHistoricalContextsBuilderList()
public List<Message.Builder> getHistoricalContextsBuilderList()Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getHistoricalContextsCount()
public int getHistoricalContextsCount()Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getHistoricalContextsList()
public List<Message> getHistoricalContextsList()Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Message> |
|
getHistoricalContextsOrBuilder(int index)
public MessageOrBuilder getHistoricalContextsOrBuilder(int index)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MessageOrBuilder |
|
getHistoricalContextsOrBuilderList()
public List<? extends MessageOrBuilder> getHistoricalContextsOrBuilderList()Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.ces.v1.MessageOrBuilder> |
|
getInputAudioConfig()
public InputAudioConfig getInputAudioConfig()Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
InputAudioConfig |
The inputAudioConfig. |
getInputAudioConfigBuilder()
public InputAudioConfig.Builder getInputAudioConfigBuilder()Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
InputAudioConfig.Builder |
|
getInputAudioConfigOrBuilder()
public InputAudioConfigOrBuilder getInputAudioConfigOrBuilder()Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
InputAudioConfigOrBuilder |
|
getOutputAudioConfig()
public OutputAudioConfig getOutputAudioConfig()Optional. Configuration for generating the output audio.
.google.cloud.ces.v1.OutputAudioConfig output_audio_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OutputAudioConfig |
The outputAudioConfig. |
getOutputAudioConfigBuilder()
public OutputAudioConfig.Builder getOutputAudioConfigBuilder()Optional. Configuration for generating the output audio.
.google.cloud.ces.v1.OutputAudioConfig output_audio_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OutputAudioConfig.Builder |
|
getOutputAudioConfigOrBuilder()
public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()Optional. Configuration for generating the output audio.
.google.cloud.ces.v1.OutputAudioConfig output_audio_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OutputAudioConfigOrBuilder |
|
getRemoteDialogflowQueryParameters()
public SessionConfig.RemoteDialogflowQueryParameters getRemoteDialogflowQueryParameters()Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
.google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters remote_dialogflow_query_parameters = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.RemoteDialogflowQueryParameters |
The remoteDialogflowQueryParameters. |
getRemoteDialogflowQueryParametersBuilder()
public SessionConfig.RemoteDialogflowQueryParameters.Builder getRemoteDialogflowQueryParametersBuilder()Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
.google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters remote_dialogflow_query_parameters = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.RemoteDialogflowQueryParameters.Builder |
|
getRemoteDialogflowQueryParametersOrBuilder()
public SessionConfig.RemoteDialogflowQueryParametersOrBuilder getRemoteDialogflowQueryParametersOrBuilder()Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
.google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters remote_dialogflow_query_parameters = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SessionConfig.RemoteDialogflowQueryParametersOrBuilder |
|
getSession()
public String getSession() Required. The unique identifier of the session.
Format:
projects/{project}/locations/{location}/apps/{app}/sessions/{session}
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The session. |
getSessionBytes()
public ByteString getSessionBytes() Required. The unique identifier of the session.
Format:
projects/{project}/locations/{location}/apps/{app}/sessions/{session}
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for session. |
getTimeZone()
public String getTimeZone()Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings.
The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
string time_zone = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The timeZone. |
getTimeZoneBytes()
public ByteString getTimeZoneBytes()Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings.
The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
string time_zone = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for timeZone. |
hasInputAudioConfig()
public boolean hasInputAudioConfig()Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the inputAudioConfig field is set. |
hasOutputAudioConfig()
public boolean hasOutputAudioConfig()Optional. Configuration for generating the output audio.
.google.cloud.ces.v1.OutputAudioConfig output_audio_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the outputAudioConfig field is set. |
hasRemoteDialogflowQueryParameters()
public boolean hasRemoteDialogflowQueryParameters()Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
.google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters remote_dialogflow_query_parameters = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the remoteDialogflowQueryParameters field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SessionConfig other)
public SessionConfig.Builder mergeFrom(SessionConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
SessionConfig |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SessionConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SessionConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
mergeInputAudioConfig(InputAudioConfig value)
public SessionConfig.Builder mergeInputAudioConfig(InputAudioConfig value)Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
InputAudioConfig |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
mergeOutputAudioConfig(OutputAudioConfig value)
public SessionConfig.Builder mergeOutputAudioConfig(OutputAudioConfig value)Optional. Configuration for generating the output audio.
.google.cloud.ces.v1.OutputAudioConfig output_audio_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
OutputAudioConfig |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
mergeRemoteDialogflowQueryParameters(SessionConfig.RemoteDialogflowQueryParameters value)
public SessionConfig.Builder mergeRemoteDialogflowQueryParameters(SessionConfig.RemoteDialogflowQueryParameters value)Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
.google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters remote_dialogflow_query_parameters = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SessionConfig.RemoteDialogflowQueryParameters |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
removeHistoricalContexts(int index)
public SessionConfig.Builder removeHistoricalContexts(int index)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setDeployment(String value)
public SessionConfig.Builder setDeployment(String value) Optional. The deployment of the app to use for the session.
Format:
projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
string deployment = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe deployment to set. |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
setDeploymentBytes(ByteString value)
public SessionConfig.Builder setDeploymentBytes(ByteString value) Optional. The deployment of the app to use for the session.
Format:
projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
string deployment = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for deployment to set. |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
setEntryAgent(String value)
public SessionConfig.Builder setEntryAgent(String value) Optional. The entry agent to handle the session. If not specified, the
session will be handled by the root
agent of the app. Format:
projects/{project}/locations/{location}/agents/{agent}
string entry_agent = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe entryAgent to set. |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
setEntryAgentBytes(ByteString value)
public SessionConfig.Builder setEntryAgentBytes(ByteString value) Optional. The entry agent to handle the session. If not specified, the
session will be handled by the root
agent of the app. Format:
projects/{project}/locations/{location}/agents/{agent}
string entry_agent = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for entryAgent to set. |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
setHistoricalContexts(int index, Message value)
public SessionConfig.Builder setHistoricalContexts(int index, Message value)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Message |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setHistoricalContexts(int index, Message.Builder builderForValue)
public SessionConfig.Builder setHistoricalContexts(int index, Message.Builder builderForValue)Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
repeated .google.cloud.ces.v1.Message historical_contexts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Message.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setInputAudioConfig(InputAudioConfig value)
public SessionConfig.Builder setInputAudioConfig(InputAudioConfig value)Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
InputAudioConfig |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setInputAudioConfig(InputAudioConfig.Builder builderForValue)
public SessionConfig.Builder setInputAudioConfig(InputAudioConfig.Builder builderForValue)Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
InputAudioConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setOutputAudioConfig(OutputAudioConfig value)
public SessionConfig.Builder setOutputAudioConfig(OutputAudioConfig value)Optional. Configuration for generating the output audio.
.google.cloud.ces.v1.OutputAudioConfig output_audio_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
OutputAudioConfig |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)
public SessionConfig.Builder setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)Optional. Configuration for generating the output audio.
.google.cloud.ces.v1.OutputAudioConfig output_audio_config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
OutputAudioConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setRemoteDialogflowQueryParameters(SessionConfig.RemoteDialogflowQueryParameters value)
public SessionConfig.Builder setRemoteDialogflowQueryParameters(SessionConfig.RemoteDialogflowQueryParameters value)Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
.google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters remote_dialogflow_query_parameters = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SessionConfig.RemoteDialogflowQueryParameters |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setRemoteDialogflowQueryParameters(SessionConfig.RemoteDialogflowQueryParameters.Builder builderForValue)
public SessionConfig.Builder setRemoteDialogflowQueryParameters(SessionConfig.RemoteDialogflowQueryParameters.Builder builderForValue)Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
.google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters remote_dialogflow_query_parameters = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SessionConfig.RemoteDialogflowQueryParameters.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
|
setSession(String value)
public SessionConfig.Builder setSession(String value) Required. The unique identifier of the session.
Format:
projects/{project}/locations/{location}/apps/{app}/sessions/{session}
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe session to set. |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
setSessionBytes(ByteString value)
public SessionConfig.Builder setSessionBytes(ByteString value) Required. The unique identifier of the session.
Format:
projects/{project}/locations/{location}/apps/{app}/sessions/{session}
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for session to set. |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
setTimeZone(String value)
public SessionConfig.Builder setTimeZone(String value)Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings.
The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
string time_zone = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe timeZone to set. |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |
setTimeZoneBytes(ByteString value)
public SessionConfig.Builder setTimeZoneBytes(ByteString value)Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings.
The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
string time_zone = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for timeZone to set. |
| Returns | |
|---|---|
| Type | Description |
SessionConfig.Builder |
This builder for chaining. |