public final class SessionConfig extends GeneratedMessage implements SessionConfigOrBuilder
The configuration for the session.
Protobuf type google.cloud.ces.v1.SessionConfig
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
DEPLOYMENT_FIELD_NUMBER
public static final int DEPLOYMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENTRY_AGENT_FIELD_NUMBER
public static final int ENTRY_AGENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HISTORICAL_CONTEXTS_FIELD_NUMBER
public static final int HISTORICAL_CONTEXTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INPUT_AUDIO_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REMOTE_DIALOGFLOW_QUERY_PARAMETERS_FIELD_NUMBER
public static final int REMOTE_DIALOGFLOW_QUERY_PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SessionConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SessionConfig.Builder newBuilder()
newBuilder(SessionConfig prototype)
public static SessionConfig.Builder newBuilder(SessionConfig prototype)
public static SessionConfig parseDelimitedFrom(InputStream input)
public static SessionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SessionConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SessionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SessionConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SessionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SessionConfig parseFrom(CodedInputStream input)
public static SessionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SessionConfig parseFrom(InputStream input)
public static SessionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SessionConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SessionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SessionConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SessionConfig getDefaultInstanceForType()
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.
|
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
|
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];
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
|
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> |
|
public InputAudioConfig getInputAudioConfig()
Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
public InputAudioConfigOrBuilder getInputAudioConfigOrBuilder()
Optional. Configuration for processing the input audio.
.google.cloud.ces.v1.InputAudioConfig input_audio_config = 2 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getParserForType()
public Parser<SessionConfig> getParserForType()
Overrides
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];
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SessionConfig.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected SessionConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public SessionConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
