Interface SessionConfigOrBuilder (0.1.0)

public interface SessionConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDeployment()

public abstract 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 abstract 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.

getEntryAgent()

public abstract 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 abstract 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 abstract 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`

getHistoricalContextsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getInputAudioConfigOrBuilder()

public abstract 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 abstract 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.

getOutputAudioConfigOrBuilder()

public abstract 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 abstract 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.

getRemoteDialogflowQueryParametersOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-27 UTC.