Class Agent.RemoteDialogflowAgent.Builder (0.1.0)

public static final class Agent.RemoteDialogflowAgent.Builder extends GeneratedMessage.Builder<Agent.RemoteDialogflowAgent.Builder> 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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Agent.RemoteDialogflowAgent.Builder

Implements

Agent.RemoteDialogflowAgentOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public Agent.RemoteDialogflowAgent build()

Returns
Type	Description
Agent.RemoteDialogflowAgent

buildPartial()

public Agent.RemoteDialogflowAgent buildPartial()

Returns
Type	Description
Agent.RemoteDialogflowAgent

clear()

public Agent.RemoteDialogflowAgent.Builder clear()

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAgent()

public Agent.RemoteDialogflowAgent.Builder clearAgent()

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
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

clearEnvironmentId()

public Agent.RemoteDialogflowAgent.Builder clearEnvironmentId()

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
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

clearFlowId()

public Agent.RemoteDialogflowAgent.Builder clearFlowId()

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

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

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

clearInputVariableMapping()

public Agent.RemoteDialogflowAgent.Builder clearInputVariableMapping()

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

clearOutputVariableMapping()

public Agent.RemoteDialogflowAgent.Builder clearOutputVariableMapping()

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

clearRespectResponseInterruptionSettings()

public Agent.RemoteDialogflowAgent.Builder clearRespectResponseInterruptionSettings()

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
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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()

Use #getInputVariableMappingMap() instead.

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

getMutableInputVariableMapping() (deprecated)

public Map<String,String> getMutableInputVariableMapping()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getMutableOutputVariableMapping() (deprecated)

public Map<String,String> getMutableOutputVariableMapping()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getOutputVariableMapping() (deprecated)

public Map<String,String> getOutputVariableMapping()

Use #getOutputVariableMappingMap() instead.

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(Agent.RemoteDialogflowAgent other)

public Agent.RemoteDialogflowAgent.Builder mergeFrom(Agent.RemoteDialogflowAgent other)

Parameter
Name	Description
other	Agent.RemoteDialogflowAgent

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Agent.RemoteDialogflowAgent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Agent.RemoteDialogflowAgent.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

putAllInputVariableMapping(Map<String,String> values)

public Agent.RemoteDialogflowAgent.Builder putAllInputVariableMapping(Map<String,String> values)

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
values	Map<String,String>

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

putAllOutputVariableMapping(Map<String,String> values)

public Agent.RemoteDialogflowAgent.Builder putAllOutputVariableMapping(Map<String,String> values)

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
values	Map<String,String>

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

putInputVariableMapping(String key, String value)

public Agent.RemoteDialogflowAgent.Builder putInputVariableMapping(String key, String value)

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

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

putOutputVariableMapping(String key, String value)

public Agent.RemoteDialogflowAgent.Builder putOutputVariableMapping(String key, String value)

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

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder

removeInputVariableMapping(String key)

public Agent.RemoteDialogflowAgent.Builder removeInputVariableMapping(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
Agent.RemoteDialogflowAgent.Builder

removeOutputVariableMapping(String key)

public Agent.RemoteDialogflowAgent.Builder removeOutputVariableMapping(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
Agent.RemoteDialogflowAgent.Builder

setAgent(String value)

public Agent.RemoteDialogflowAgent.Builder setAgent(String value)

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) = { ... }

Parameter
Name	Description
value	String The agent to set.

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

setAgentBytes(ByteString value)

public Agent.RemoteDialogflowAgent.Builder setAgentBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for agent to set.

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

setEnvironmentId(String value)

public Agent.RemoteDialogflowAgent.Builder setEnvironmentId(String value)

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

Parameter
Name	Description
value	String The environmentId to set.

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

setEnvironmentIdBytes(ByteString value)

public Agent.RemoteDialogflowAgent.Builder setEnvironmentIdBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for environmentId to set.

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

setFlowId(String value)

public Agent.RemoteDialogflowAgent.Builder setFlowId(String value)

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

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

Parameter
Name	Description
value	String The flowId to set.

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

setFlowIdBytes(ByteString value)

public Agent.RemoteDialogflowAgent.Builder setFlowIdBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for flowId to set.

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.

setRespectResponseInterruptionSettings(boolean value)

public Agent.RemoteDialogflowAgent.Builder setRespectResponseInterruptionSettings(boolean value)

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

Parameter
Name	Description
value	boolean The respectResponseInterruptionSettings to set.

Returns
Type	Description
Agent.RemoteDialogflowAgent.Builder	This builder for chaining.