Class Agent.RemoteDialogflowAgent (0.1.0)

public static final class Agent.RemoteDialogflowAgent extends GeneratedMessage implements Agent.RemoteDialogflowAgentOrBuilder

The agent which will transfer execution to a remote Dialogflow CX agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.

Protobuf type google.cloud.ces.v1.Agent.RemoteDialogflowAgent

Static Fields

AGENT_FIELD_NUMBER

public static final int AGENT_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_ID_FIELD_NUMBER

public static final int ENVIRONMENT_ID_FIELD_NUMBER
Field Value
Type Description
int

FLOW_ID_FIELD_NUMBER

public static final int FLOW_ID_FIELD_NUMBER
Field Value
Type Description
int

INPUT_VARIABLE_MAPPING_FIELD_NUMBER

public static final int INPUT_VARIABLE_MAPPING_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_VARIABLE_MAPPING_FIELD_NUMBER

public static final int OUTPUT_VARIABLE_MAPPING_FIELD_NUMBER
Field Value
Type Description
int

RESPECT_RESPONSE_INTERRUPTION_SETTINGS_FIELD_NUMBER

public static final int RESPECT_RESPONSE_INTERRUPTION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Agent.RemoteDialogflowAgent getDefaultInstance()
Returns
Type Description
Agent.RemoteDialogflowAgent

getDescriptor()

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

newBuilder()

public static Agent.RemoteDialogflowAgent.Builder newBuilder()
Returns
Type Description
Agent.RemoteDialogflowAgent.Builder

newBuilder(Agent.RemoteDialogflowAgent prototype)

public static Agent.RemoteDialogflowAgent.Builder newBuilder(Agent.RemoteDialogflowAgent prototype)
Parameter
Name Description
prototype Agent.RemoteDialogflowAgent
Returns
Type Description
Agent.RemoteDialogflowAgent.Builder

parseDelimitedFrom(InputStream input)

public static Agent.RemoteDialogflowAgent parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent.RemoteDialogflowAgent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Agent.RemoteDialogflowAgent parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Agent.RemoteDialogflowAgent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Agent.RemoteDialogflowAgent parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Agent.RemoteDialogflowAgent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Agent.RemoteDialogflowAgent parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent.RemoteDialogflowAgent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Agent.RemoteDialogflowAgent parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent.RemoteDialogflowAgent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Agent.RemoteDialogflowAgent parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Agent.RemoteDialogflowAgent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent.RemoteDialogflowAgent
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Agent.RemoteDialogflowAgent> parser()
Returns
Type Description
Parser<RemoteDialogflowAgent>

Methods

containsInputVariableMapping(String key)

public boolean containsInputVariableMapping(String key)

Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

map<string, string> input_variable_mapping = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsOutputVariableMapping(String key)

public boolean containsOutputVariableMapping(String key)

Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.

map<string, string> output_variable_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAgent()

public String getAgent()

Required. The Dialogflow agent resource name. Format: projects/{project}/locations/{location}/agents/{agent}

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

Returns
Type Description
String

The agent.

getAgentBytes()

public ByteString getAgentBytes()

Required. The Dialogflow agent resource name. Format: projects/{project}/locations/{location}/agents/{agent}

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

Returns
Type Description
ByteString

The bytes for agent.

getDefaultInstanceForType()

public Agent.RemoteDialogflowAgent getDefaultInstanceForType()
Returns
Type Description
Agent.RemoteDialogflowAgent

getEnvironmentId()

public String getEnvironmentId()

Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.

string environment_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The environmentId.

getEnvironmentIdBytes()

public ByteString getEnvironmentIdBytes()

Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.

string environment_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for environmentId.

getFlowId()

public String getFlowId()

Optional. The flow ID of the flow in the Dialogflow agent.

string flow_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The flowId.

getFlowIdBytes()

public ByteString getFlowIdBytes()

Optional. The flow ID of the flow in the Dialogflow agent.

string flow_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for flowId.

getInputVariableMapping() (deprecated)

public Map<String,String> getInputVariableMapping()
Returns
Type Description
Map<String,String>

getInputVariableMappingCount()

public int getInputVariableMappingCount()

Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

map<string, string> input_variable_mapping = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getInputVariableMappingMap()

public Map<String,String> getInputVariableMappingMap()

Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

map<string, string> input_variable_mapping = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getInputVariableMappingOrDefault(String key, String defaultValue)

public String getInputVariableMappingOrDefault(String key, String defaultValue)

Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

map<string, string> input_variable_mapping = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getInputVariableMappingOrThrow(String key)

public String getInputVariableMappingOrThrow(String key)

Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.

map<string, string> input_variable_mapping = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getOutputVariableMapping() (deprecated)

public Map<String,String> getOutputVariableMapping()
Returns
Type Description
Map<String,String>

getOutputVariableMappingCount()

public int getOutputVariableMappingCount()

Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.

map<string, string> output_variable_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getOutputVariableMappingMap()

public Map<String,String> getOutputVariableMappingMap()

Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.

map<string, string> output_variable_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getOutputVariableMappingOrDefault(String key, String defaultValue)

public String getOutputVariableMappingOrDefault(String key, String defaultValue)

Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.

map<string, string> output_variable_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getOutputVariableMappingOrThrow(String key)

public String getOutputVariableMappingOrThrow(String key)

Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.

map<string, string> output_variable_mapping = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<Agent.RemoteDialogflowAgent> getParserForType()
Returns
Type Description
Parser<RemoteDialogflowAgent>
Overrides

getRespectResponseInterruptionSettings()

public boolean getRespectResponseInterruptionSettings()

Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent.

  • If false: all response messages from the Dialogflow agent follow the app-level barge-in settings.
  • If true: only response messages with allow_playback_interruption set to true will be interruptable, all other messages follow the app-level barge-in settings.

bool respect_response_interruption_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The respectResponseInterruptionSettings.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Agent.RemoteDialogflowAgent.Builder newBuilderForType()
Returns
Type Description
Agent.RemoteDialogflowAgent.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Agent.RemoteDialogflowAgent.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Agent.RemoteDialogflowAgent.Builder
Overrides

toBuilder()

public Agent.RemoteDialogflowAgent.Builder toBuilder()
Returns
Type Description
Agent.RemoteDialogflowAgent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException