Interface ActionOrBuilder (0.89.0)

Version latest

• 0.89.0 (latest)
• 0.87.0
• 0.86.0
• 0.85.0
• 0.84.0
• 0.83.0
• 0.81.0
• 0.79.0
• 0.78.0
• 0.75.0
• 0.74.0
• 0.73.0
• 0.71.0
• 0.70.0
• 0.69.0
• 0.68.0
• 0.67.0
• 0.66.0
• 0.65.0
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public interface ActionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActionCase()

public abstract Action.ActionCase getActionCase()

Returns
Type	Description
Action.ActionCase

getAgentUtterance()

public abstract AgentUtterance getAgentUtterance()

Optional. Action performed by the agent as a message.

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

Returns
Type	Description
AgentUtterance	The agentUtterance.

getAgentUtteranceOrBuilder()

public abstract AgentUtteranceOrBuilder getAgentUtteranceOrBuilder()

Optional. Action performed by the agent as a message.

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

Returns
Type	Description
AgentUtteranceOrBuilder

getCompleteTime()

public abstract Timestamp getCompleteTime()

Output only. Timestamp of the completion of the agent action.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The completeTime.

getCompleteTimeOrBuilder()

public abstract TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. Timestamp of the completion of the agent action.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Output only. The display name of the action.

string display_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Output only. The display name of the action.

string display_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for displayName.

getEvent()

public abstract Event getEvent()

Optional. The agent received an event from the customer or a system event is emitted.

.google.cloud.dialogflow.cx.v3beta1.Event event = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Event	The event.

getEventOrBuilder()

public abstract EventOrBuilder getEventOrBuilder()

Optional. The agent received an event from the customer or a system event is emitted.

.google.cloud.dialogflow.cx.v3beta1.Event event = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EventOrBuilder

getFlowInvocation()

public abstract FlowInvocation getFlowInvocation()

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

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

Returns
Type	Description
FlowInvocation	The flowInvocation.

getFlowInvocationOrBuilder()

public abstract FlowInvocationOrBuilder getFlowInvocationOrBuilder()

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

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

Returns
Type	Description
FlowInvocationOrBuilder

getFlowStateUpdate()

public abstract Action.FlowStateUpdate getFlowStateUpdate()

Optional. Output only. The state machine update in flows.

.google.cloud.dialogflow.cx.v3beta1.Action.FlowStateUpdate flow_state_update = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Action.FlowStateUpdate	The flowStateUpdate.

getFlowStateUpdateOrBuilder()

public abstract Action.FlowStateUpdateOrBuilder getFlowStateUpdateOrBuilder()

Optional. Output only. The state machine update in flows.

.google.cloud.dialogflow.cx.v3beta1.Action.FlowStateUpdate flow_state_update = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Action.FlowStateUpdateOrBuilder

getFlowTransition()

public abstract FlowTransition getFlowTransition()

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

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

Returns
Type	Description
FlowTransition	The flowTransition.

getFlowTransitionOrBuilder()

public abstract FlowTransitionOrBuilder getFlowTransitionOrBuilder()

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

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

Returns
Type	Description
FlowTransitionOrBuilder

getIntentMatch()

public abstract Action.IntentMatch getIntentMatch()

Optional. Output only. Intent Match in flows.

.google.cloud.dialogflow.cx.v3beta1.Action.IntentMatch intent_match = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Action.IntentMatch	The intentMatch.

getIntentMatchOrBuilder()

public abstract Action.IntentMatchOrBuilder getIntentMatchOrBuilder()

Optional. Output only. Intent Match in flows.

.google.cloud.dialogflow.cx.v3beta1.Action.IntentMatch intent_match = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Action.IntentMatchOrBuilder

getLlmCall()

public abstract LlmCall getLlmCall()

Optional. Output only. LLM call performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.LlmCall llm_call = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LlmCall	The llmCall.

getLlmCallOrBuilder()

public abstract LlmCallOrBuilder getLlmCallOrBuilder()

Optional. Output only. LLM call performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.LlmCall llm_call = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LlmCallOrBuilder

getPlaybookInvocation()

public abstract PlaybookInvocation getPlaybookInvocation()

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

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

Returns
Type	Description
PlaybookInvocation	The playbookInvocation.

getPlaybookInvocationOrBuilder()

public abstract PlaybookInvocationOrBuilder getPlaybookInvocationOrBuilder()

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

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

Returns
Type	Description
PlaybookInvocationOrBuilder

getPlaybookTransition()

public abstract PlaybookTransition getPlaybookTransition()

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

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

Returns
Type	Description
PlaybookTransition	The playbookTransition.

getPlaybookTransitionOrBuilder()

public abstract PlaybookTransitionOrBuilder getPlaybookTransitionOrBuilder()

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

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

Returns
Type	Description
PlaybookTransitionOrBuilder

getStartTime()

public abstract Timestamp getStartTime()

Output only. Timestamp of the start of the agent action.

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Output only. Timestamp of the start of the agent action.

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getStatus()

public abstract Status getStatus()

Optional. Output only. The status of the action.

.google.cloud.dialogflow.cx.v3beta1.Status status = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Status	The status.

getStatusOrBuilder()

public abstract StatusOrBuilder getStatusOrBuilder()

Optional. Output only. The status of the action.

.google.cloud.dialogflow.cx.v3beta1.Status status = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
StatusOrBuilder

getStt()

public abstract Action.STT getStt()

Optional. Speech-to-text action performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.Action.STT stt = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Action.STT	The stt.

getSttOrBuilder()

public abstract Action.STTOrBuilder getSttOrBuilder()

Optional. Speech-to-text action performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.Action.STT stt = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Action.STTOrBuilder

getSubExecutionSteps(int index)

public abstract Span getSubExecutionSteps(int index)

Optional. The detailed tracing information for sub execution steps of the action.

repeated .google.cloud.dialogflow.cx.v3beta1.Span sub_execution_steps = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Span

getSubExecutionStepsCount()

public abstract int getSubExecutionStepsCount()

Optional. The detailed tracing information for sub execution steps of the action.

repeated .google.cloud.dialogflow.cx.v3beta1.Span sub_execution_steps = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getSubExecutionStepsList()

public abstract List<Span> getSubExecutionStepsList()

Optional. The detailed tracing information for sub execution steps of the action.

repeated .google.cloud.dialogflow.cx.v3beta1.Span sub_execution_steps = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Span>

getSubExecutionStepsOrBuilder(int index)

public abstract SpanOrBuilder getSubExecutionStepsOrBuilder(int index)

Optional. The detailed tracing information for sub execution steps of the action.

repeated .google.cloud.dialogflow.cx.v3beta1.Span sub_execution_steps = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
SpanOrBuilder

getSubExecutionStepsOrBuilderList()

public abstract List<? extends SpanOrBuilder> getSubExecutionStepsOrBuilderList()

Optional. The detailed tracing information for sub execution steps of the action.

repeated .google.cloud.dialogflow.cx.v3beta1.Span sub_execution_steps = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.SpanOrBuilder>

getToolUse()

public abstract ToolUse getToolUse()

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

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

Returns
Type	Description
ToolUse	The toolUse.

getToolUseOrBuilder()

public abstract ToolUseOrBuilder getToolUseOrBuilder()

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

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

Returns
Type	Description
ToolUseOrBuilder

getTts()

public abstract Action.TTS getTts()

Optional. Text-to-speech action performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.Action.TTS tts = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Action.TTS	The tts.

getTtsOrBuilder()

public abstract Action.TTSOrBuilder getTtsOrBuilder()

Optional. Text-to-speech action performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.Action.TTS tts = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Action.TTSOrBuilder

getUserUtterance()

public abstract UserUtterance getUserUtterance()

Optional. Agent obtained a message from the customer.

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

Returns
Type	Description
UserUtterance	The userUtterance.

getUserUtteranceOrBuilder()

public abstract UserUtteranceOrBuilder getUserUtteranceOrBuilder()

Optional. Agent obtained a message from the customer.

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

Returns
Type	Description
UserUtteranceOrBuilder

hasAgentUtterance()

public abstract boolean hasAgentUtterance()

Optional. Action performed by the agent as a message.

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

Returns
Type	Description
boolean	Whether the agentUtterance field is set.

hasCompleteTime()

public abstract boolean hasCompleteTime()

Output only. Timestamp of the completion of the agent action.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the completeTime field is set.

hasEvent()

public abstract boolean hasEvent()

Optional. The agent received an event from the customer or a system event is emitted.

.google.cloud.dialogflow.cx.v3beta1.Event event = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the event field is set.

hasFlowInvocation()

public abstract boolean hasFlowInvocation()

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

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

Returns
Type	Description
boolean	Whether the flowInvocation field is set.

hasFlowStateUpdate()

public abstract boolean hasFlowStateUpdate()

Optional. Output only. The state machine update in flows.

.google.cloud.dialogflow.cx.v3beta1.Action.FlowStateUpdate flow_state_update = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the flowStateUpdate field is set.

hasFlowTransition()

public abstract boolean hasFlowTransition()

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

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

Returns
Type	Description
boolean	Whether the flowTransition field is set.

hasIntentMatch()

public abstract boolean hasIntentMatch()

Optional. Output only. Intent Match in flows.

.google.cloud.dialogflow.cx.v3beta1.Action.IntentMatch intent_match = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the intentMatch field is set.

hasLlmCall()

public abstract boolean hasLlmCall()

Optional. Output only. LLM call performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.LlmCall llm_call = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the llmCall field is set.

hasPlaybookInvocation()

public abstract boolean hasPlaybookInvocation()

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

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

Returns
Type	Description
boolean	Whether the playbookInvocation field is set.

hasPlaybookTransition()

public abstract boolean hasPlaybookTransition()

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

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

Returns
Type	Description
boolean	Whether the playbookTransition field is set.

hasStartTime()

public abstract boolean hasStartTime()

Output only. Timestamp of the start of the agent action.

.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the startTime field is set.

hasStatus()

public abstract boolean hasStatus()

Optional. Output only. The status of the action.

.google.cloud.dialogflow.cx.v3beta1.Status status = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the status field is set.

hasStt()

public abstract boolean hasStt()

Optional. Speech-to-text action performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.Action.STT stt = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the stt field is set.

hasToolUse()

public abstract boolean hasToolUse()

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

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

Returns
Type	Description
boolean	Whether the toolUse field is set.

hasTts()

public abstract boolean hasTts()

Optional. Text-to-speech action performed by the agent.

.google.cloud.dialogflow.cx.v3beta1.Action.TTS tts = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the tts field is set.

hasUserUtterance()

public abstract boolean hasUserUtterance()

Optional. Agent obtained a message from the customer.

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

Returns
Type	Description
boolean	Whether the userUtterance field is set.