Class Action.Builder (0.94.0)

public static final class Action.Builder extends GeneratedMessage.Builder<Action.Builder> implements ActionOrBuilder

Action performed by end user or Dialogflow agent in the conversation.

Protobuf type google.cloud.dialogflow.cx.v3.Action

Implements

ActionOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public Action build()
Returns
Type Description
Action

buildPartial()

public Action buildPartial()
Returns
Type Description
Action

clear()

public Action.Builder clear()
Returns
Type Description
Action.Builder
Overrides

clearAction()

public Action.Builder clearAction()
Returns
Type Description
Action.Builder

clearAgentUtterance()

public Action.Builder clearAgentUtterance()

Optional. Action performed by the agent as a message.

.google.cloud.dialogflow.cx.v3.AgentUtterance agent_utterance = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Action.Builder

clearFlowInvocation()

public Action.Builder clearFlowInvocation()

Optional. Action performed on behalf of the agent by invoking a CX flow.

.google.cloud.dialogflow.cx.v3.FlowInvocation flow_invocation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Action.Builder

clearFlowTransition()

public Action.Builder clearFlowTransition()

Optional. Action performed on behalf of the agent by transitioning to a target CX flow.

.google.cloud.dialogflow.cx.v3.FlowTransition flow_transition = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Action.Builder

clearPlaybookInvocation()

public Action.Builder clearPlaybookInvocation()

Optional. Action performed on behalf of the agent by invoking a child playbook.

.google.cloud.dialogflow.cx.v3.PlaybookInvocation playbook_invocation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Action.Builder

clearPlaybookTransition()

public Action.Builder clearPlaybookTransition()

Optional. Action performed on behalf of the agent by transitioning to a target playbook.

.google.cloud.dialogflow.cx.v3.PlaybookTransition playbook_transition = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Action.Builder

clearToolUse()

public Action.Builder clearToolUse()

Optional. Action performed on behalf of the agent by calling a plugin tool.

.google.cloud.dialogflow.cx.v3.ToolUse tool_use = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Action.Builder

clearUserUtterance()

public Action.Builder clearUserUtterance()

Optional. Agent obtained a message from the customer.

.google.cloud.dialogflow.cx.v3.UserUtterance user_utterance = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Action.Builder

getActionCase()

public Action.ActionCase getActionCase()
Returns
Type Description
Action.ActionCase

getAgentUtterance()

public AgentUtterance getAgentUtterance()

Optional. Action performed by the agent as a message.

.google.cloud.dialogflow.cx.v3.AgentUtterance agent_utterance = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AgentUtterance

The agentUtterance.

getAgentUtteranceBuilder()

public AgentUtterance.Builder getAgentUtteranceBuilder()

Optional. Action performed by the agent as a message.

.google.cloud.dialogflow.cx.v3.AgentUtterance agent_utterance = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AgentUtterance.Builder

getAgentUtteranceOrBuilder()

public AgentUtteranceOrBuilder getAgentUtteranceOrBuilder()

Optional. Action performed by the agent as a message.

.google.cloud.dialogflow.cx.v3.AgentUtterance agent_utterance = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AgentUtteranceOrBuilder

getDefaultInstanceForType()

public Action getDefaultInstanceForType()
Returns
Type Description
Action

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFlowInvocation()

public FlowInvocation getFlowInvocation()

Optional. Action performed on behalf of the agent by invoking a CX flow.

.google.cloud.dialogflow.cx.v3.FlowInvocation flow_invocation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlowInvocation

The flowInvocation.

getFlowInvocationBuilder()

public FlowInvocation.Builder getFlowInvocationBuilder()

Optional. Action performed on behalf of the agent by invoking a CX flow.

.google.cloud.dialogflow.cx.v3.FlowInvocation flow_invocation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlowInvocation.Builder

getFlowInvocationOrBuilder()

public FlowInvocationOrBuilder getFlowInvocationOrBuilder()

Optional. Action performed on behalf of the agent by invoking a CX flow.

.google.cloud.dialogflow.cx.v3.FlowInvocation flow_invocation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlowInvocationOrBuilder

getFlowTransition()

public FlowTransition getFlowTransition()

Optional. Action performed on behalf of the agent by transitioning to a target CX flow.

.google.cloud.dialogflow.cx.v3.FlowTransition flow_transition = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlowTransition

The flowTransition.

getFlowTransitionBuilder()

public FlowTransition.Builder getFlowTransitionBuilder()

Optional. Action performed on behalf of the agent by transitioning to a target CX flow.

.google.cloud.dialogflow.cx.v3.FlowTransition flow_transition = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlowTransition.Builder

getFlowTransitionOrBuilder()

public FlowTransitionOrBuilder getFlowTransitionOrBuilder()

Optional. Action performed on behalf of the agent by transitioning to a target CX flow.

.google.cloud.dialogflow.cx.v3.FlowTransition flow_transition = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FlowTransitionOrBuilder

getPlaybookInvocation()

public PlaybookInvocation getPlaybookInvocation()

Optional. Action performed on behalf of the agent by invoking a child playbook.

.google.cloud.dialogflow.cx.v3.PlaybookInvocation playbook_invocation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookInvocation

The playbookInvocation.

getPlaybookInvocationBuilder()

public PlaybookInvocation.Builder getPlaybookInvocationBuilder()

Optional. Action performed on behalf of the agent by invoking a child playbook.

.google.cloud.dialogflow.cx.v3.PlaybookInvocation playbook_invocation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookInvocation.Builder

getPlaybookInvocationOrBuilder()

public PlaybookInvocationOrBuilder getPlaybookInvocationOrBuilder()

Optional. Action performed on behalf of the agent by invoking a child playbook.

.google.cloud.dialogflow.cx.v3.PlaybookInvocation playbook_invocation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookInvocationOrBuilder

getPlaybookTransition()

public PlaybookTransition getPlaybookTransition()

Optional. Action performed on behalf of the agent by transitioning to a target playbook.

.google.cloud.dialogflow.cx.v3.PlaybookTransition playbook_transition = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookTransition

The playbookTransition.

getPlaybookTransitionBuilder()

public PlaybookTransition.Builder getPlaybookTransitionBuilder()

Optional. Action performed on behalf of the agent by transitioning to a target playbook.

.google.cloud.dialogflow.cx.v3.PlaybookTransition playbook_transition = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookTransition.Builder

getPlaybookTransitionOrBuilder()

public PlaybookTransitionOrBuilder getPlaybookTransitionOrBuilder()

Optional. Action performed on behalf of the agent by transitioning to a target playbook.

.google.cloud.dialogflow.cx.v3.PlaybookTransition playbook_transition = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PlaybookTransitionOrBuilder

getToolUse()

public ToolUse getToolUse()

Optional. Action performed on behalf of the agent by calling a plugin tool.

.google.cloud.dialogflow.cx.v3.ToolUse tool_use = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse

The toolUse.

getToolUseBuilder()

public ToolUse.Builder getToolUseBuilder()

Optional. Action performed on behalf of the agent by calling a plugin tool.

.google.cloud.dialogflow.cx.v3.ToolUse tool_use = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.Builder

getToolUseOrBuilder()

public ToolUseOrBuilder getToolUseOrBuilder()

Optional. Action performed on behalf of the agent by calling a plugin tool.

.google.cloud.dialogflow.cx.v3.ToolUse tool_use = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUseOrBuilder

getUserUtterance()

public UserUtterance getUserUtterance()

Optional. Agent obtained a message from the customer.

.google.cloud.dialogflow.cx.v3.UserUtterance user_utterance = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserUtterance

The userUtterance.

getUserUtteranceBuilder()

public UserUtterance.Builder getUserUtteranceBuilder()

Optional. Agent obtained a message from the customer.

.google.cloud.dialogflow.cx.v3.UserUtterance user_utterance = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserUtterance.Builder

getUserUtteranceOrBuilder()

public UserUtteranceOrBuilder getUserUtteranceOrBuilder()

Optional. Agent obtained a message from the customer.

.google.cloud.dialogflow.cx.v3.UserUtterance user_utterance = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserUtteranceOrBuilder

hasAgentUtterance()

public boolean hasAgentUtterance()

Optional. Action performed by the agent as a message.

.google.cloud.dialogflow.cx.v3.AgentUtterance agent_utterance = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the agentUtterance field is set.

hasFlowInvocation()

public boolean hasFlowInvocation()

Optional. Action performed on behalf of the agent by invoking a CX flow.

.google.cloud.dialogflow.cx.v3.FlowInvocation flow_invocation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the flowInvocation field is set.

hasFlowTransition()

public boolean hasFlowTransition()

Optional. Action performed on behalf of the agent by transitioning to a target CX flow.

.google.cloud.dialogflow.cx.v3.FlowTransition flow_transition = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the flowTransition field is set.

hasPlaybookInvocation()

public boolean hasPlaybookInvocation()

Optional. Action performed on behalf of the agent by invoking a child playbook.

.google.cloud.dialogflow.cx.v3.PlaybookInvocation playbook_invocation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the playbookInvocation field is set.

hasPlaybookTransition()

public boolean hasPlaybookTransition()

Optional. Action performed on behalf of the agent by transitioning to a target playbook.

.google.cloud.dialogflow.cx.v3.PlaybookTransition playbook_transition = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the playbookTransition field is set.

hasToolUse()

public boolean hasToolUse()

Optional. Action performed on behalf of the agent by calling a plugin tool.

.google.cloud.dialogflow.cx.v3.ToolUse tool_use = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the toolUse field is set.

hasUserUtterance()

public boolean hasUserUtterance()

Optional. Agent obtained a message from the customer.

.google.cloud.dialogflow.cx.v3.UserUtterance user_utterance = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the userUtterance field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAgentUtterance(AgentUtterance value)

public Action.Builder mergeAgentUtterance(AgentUtterance value)

Optional. Action performed by the agent as a message.

.google.cloud.dialogflow.cx.v3.AgentUtterance agent_utterance = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AgentUtterance
Returns
Type Description
Action.Builder

mergeFlowInvocation(FlowInvocation value)

public Action.Builder mergeFlowInvocation(FlowInvocation value)

Optional. Action performed on behalf of the agent by invoking a CX flow.

.google.cloud.dialogflow.cx.v3.FlowInvocation flow_invocation = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FlowInvocation
Returns
Type Description
Action.Builder

mergeFlowTransition(FlowTransition value)

public Action.Builder mergeFlowTransition(FlowTransition value)

Optional. Action performed on behalf of the agent by transitioning to a target CX flow.

.google.cloud.dialogflow.cx.v3.FlowTransition flow_transition = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FlowTransition
Returns
Type Description
Action.Builder

mergeFrom(Action other)

public Action.Builder mergeFrom(Action other)
Parameter
Name Description
other Action
Returns
Type Description
Action.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Action.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Action.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Action.Builder
Overrides

mergePlaybookInvocation(PlaybookInvocation value)

public Action.Builder mergePlaybookInvocation(PlaybookInvocation value)

Optional. Action performed on behalf of the agent by invoking a child playbook.

.google.cloud.dialogflow.cx.v3.PlaybookInvocation playbook_invocation = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PlaybookInvocation
Returns
Type Description
Action.Builder

mergePlaybookTransition(PlaybookTransition value)

public Action.Builder mergePlaybookTransition(PlaybookTransition value)

Optional. Action performed on behalf of the agent by transitioning to a target playbook.

.google.cloud.dialogflow.cx.v3.PlaybookTransition playbook_transition = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PlaybookTransition
Returns
Type Description
Action.Builder

mergeToolUse(ToolUse value)

public Action.Builder mergeToolUse(ToolUse value)

Optional. Action performed on behalf of the agent by calling a plugin tool.

.google.cloud.dialogflow.cx.v3.ToolUse tool_use = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolUse
Returns
Type Description
Action.Builder

mergeUserUtterance(UserUtterance value)

public Action.Builder mergeUserUtterance(UserUtterance value)

Optional. Agent obtained a message from the customer.

.google.cloud.dialogflow.cx.v3.UserUtterance user_utterance = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value UserUtterance
Returns
Type Description
Action.Builder

setAgentUtterance(AgentUtterance value)

public Action.Builder setAgentUtterance(AgentUtterance value)

Optional. Action performed by the agent as a message.

.google.cloud.dialogflow.cx.v3.AgentUtterance agent_utterance = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AgentUtterance
Returns
Type Description
Action.Builder

setAgentUtterance(AgentUtterance.Builder builderForValue)

public Action.Builder setAgentUtterance(AgentUtterance.Builder builderForValue)

Optional. Action performed by the agent as a message.

.google.cloud.dialogflow.cx.v3.AgentUtterance agent_utterance = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AgentUtterance.Builder
Returns
Type Description
Action.Builder

setFlowInvocation(FlowInvocation value)

public Action.Builder setFlowInvocation(FlowInvocation value)

Optional. Action performed on behalf of the agent by invoking a CX flow.

.google.cloud.dialogflow.cx.v3.FlowInvocation flow_invocation = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FlowInvocation
Returns
Type Description
Action.Builder

setFlowInvocation(FlowInvocation.Builder builderForValue)

public Action.Builder setFlowInvocation(FlowInvocation.Builder builderForValue)

Optional. Action performed on behalf of the agent by invoking a CX flow.

.google.cloud.dialogflow.cx.v3.FlowInvocation flow_invocation = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue FlowInvocation.Builder
Returns
Type Description
Action.Builder

setFlowTransition(FlowTransition value)

public Action.Builder setFlowTransition(FlowTransition value)

Optional. Action performed on behalf of the agent by transitioning to a target CX flow.

.google.cloud.dialogflow.cx.v3.FlowTransition flow_transition = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FlowTransition
Returns
Type Description
Action.Builder

setFlowTransition(FlowTransition.Builder builderForValue)

public Action.Builder setFlowTransition(FlowTransition.Builder builderForValue)

Optional. Action performed on behalf of the agent by transitioning to a target CX flow.

.google.cloud.dialogflow.cx.v3.FlowTransition flow_transition = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue FlowTransition.Builder
Returns
Type Description
Action.Builder

setPlaybookInvocation(PlaybookInvocation value)

public Action.Builder setPlaybookInvocation(PlaybookInvocation value)

Optional. Action performed on behalf of the agent by invoking a child playbook.

.google.cloud.dialogflow.cx.v3.PlaybookInvocation playbook_invocation = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PlaybookInvocation
Returns
Type Description
Action.Builder

setPlaybookInvocation(PlaybookInvocation.Builder builderForValue)

public Action.Builder setPlaybookInvocation(PlaybookInvocation.Builder builderForValue)

Optional. Action performed on behalf of the agent by invoking a child playbook.

.google.cloud.dialogflow.cx.v3.PlaybookInvocation playbook_invocation = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue PlaybookInvocation.Builder
Returns
Type Description
Action.Builder

setPlaybookTransition(PlaybookTransition value)

public Action.Builder setPlaybookTransition(PlaybookTransition value)

Optional. Action performed on behalf of the agent by transitioning to a target playbook.

.google.cloud.dialogflow.cx.v3.PlaybookTransition playbook_transition = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PlaybookTransition
Returns
Type Description
Action.Builder

setPlaybookTransition(PlaybookTransition.Builder builderForValue)

public Action.Builder setPlaybookTransition(PlaybookTransition.Builder builderForValue)

Optional. Action performed on behalf of the agent by transitioning to a target playbook.

.google.cloud.dialogflow.cx.v3.PlaybookTransition playbook_transition = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue PlaybookTransition.Builder
Returns
Type Description
Action.Builder

setToolUse(ToolUse value)

public Action.Builder setToolUse(ToolUse value)

Optional. Action performed on behalf of the agent by calling a plugin tool.

.google.cloud.dialogflow.cx.v3.ToolUse tool_use = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolUse
Returns
Type Description
Action.Builder

setToolUse(ToolUse.Builder builderForValue)

public Action.Builder setToolUse(ToolUse.Builder builderForValue)

Optional. Action performed on behalf of the agent by calling a plugin tool.

.google.cloud.dialogflow.cx.v3.ToolUse tool_use = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ToolUse.Builder
Returns
Type Description
Action.Builder

setUserUtterance(UserUtterance value)

public Action.Builder setUserUtterance(UserUtterance value)

Optional. Agent obtained a message from the customer.

.google.cloud.dialogflow.cx.v3.UserUtterance user_utterance = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value UserUtterance
Returns
Type Description
Action.Builder

setUserUtterance(UserUtterance.Builder builderForValue)

public Action.Builder setUserUtterance(UserUtterance.Builder builderForValue)

Optional. Agent obtained a message from the customer.

.google.cloud.dialogflow.cx.v3.UserUtterance user_utterance = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue UserUtterance.Builder
Returns
Type Description
Action.Builder