com.google.cloud.dialogflow.cx.v3beta1

Interface PlaybookInvocationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PlaybookInvocation, PlaybookInvocation.Builder

public interface PlaybookInvocationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Output only.
com.google.protobuf.ByteString	getDisplayNameBytes() Output only.
String	getPlaybook() Required.
com.google.protobuf.ByteString	getPlaybookBytes() Required.
PlaybookInput	getPlaybookInput() Optional.
PlaybookInputOrBuilder	getPlaybookInputOrBuilder() Optional.
PlaybookOutput	getPlaybookOutput() Optional.
PlaybookOutputOrBuilder	getPlaybookOutputOrBuilder() Optional.
OutputState	getPlaybookState() Required.
int	getPlaybookStateValue() Required.
boolean	hasPlaybookInput() Optional.
boolean	hasPlaybookOutput() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getPlaybook

String getPlaybook()

 Required. The unique identifier of the playbook.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
 

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

Returns:

The playbook.

getPlaybookBytes

com.google.protobuf.ByteString getPlaybookBytes()

 Required. The unique identifier of the playbook.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
 

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

Returns:

The bytes for playbook.

getDisplayName

String getDisplayName()

 Output only. The display name of the playbook.
 

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

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Output only. The display name of the playbook.
 

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

Returns:

The bytes for displayName.

hasPlaybookInput

boolean hasPlaybookInput()

 Optional. Input of the child playbook invocation.
 

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

Returns:

Whether the playbookInput field is set.

getPlaybookInput

PlaybookInput getPlaybookInput()

 Optional. Input of the child playbook invocation.
 

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

Returns:

The playbookInput.

getPlaybookInputOrBuilder

PlaybookInputOrBuilder getPlaybookInputOrBuilder()

 Optional. Input of the child playbook invocation.
 

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

hasPlaybookOutput

boolean hasPlaybookOutput()

 Optional. Output of the child playbook invocation.
 

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

Returns:

Whether the playbookOutput field is set.

getPlaybookOutput

PlaybookOutput getPlaybookOutput()

 Optional. Output of the child playbook invocation.
 

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

Returns:

The playbookOutput.

getPlaybookOutputOrBuilder

PlaybookOutputOrBuilder getPlaybookOutputOrBuilder()

 Optional. Output of the child playbook invocation.
 

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

getPlaybookStateValue

int getPlaybookStateValue()

 Required. Playbook invocation's output state.
 

.google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The enum numeric value on the wire for playbookState.

getPlaybookState

OutputState getPlaybookState()

 Required. Playbook invocation's output state.
 

.google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The playbookState.