Interface PlaybookInvocationOrBuilder (0.89.0)

public interface PlaybookInvocationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisplayName()

public abstract String getDisplayName()

Output only. The display name of the playbook.

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

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Output only. The display name of the playbook.

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

Returns
Type	Description
`ByteString`	The bytes for displayName.

getPlaybook()

public abstract 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
Type	Description
`String`	The playbook.

getPlaybookBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for playbook.

getPlaybookInput()

public abstract PlaybookInput getPlaybookInput()

Optional. Input of the child playbook invocation.

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

Returns
Type	Description
`PlaybookInput`	The playbookInput.

getPlaybookInputOrBuilder()

public abstract PlaybookInputOrBuilder getPlaybookInputOrBuilder()

Optional. Input of the child playbook invocation.

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

Returns
Type	Description
`PlaybookInputOrBuilder`

getPlaybookOutput()

public abstract PlaybookOutput getPlaybookOutput()

Optional. Output of the child playbook invocation.

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

Returns
Type	Description
`PlaybookOutput`	The playbookOutput.

getPlaybookOutputOrBuilder()

public abstract PlaybookOutputOrBuilder getPlaybookOutputOrBuilder()

Optional. Output of the child playbook invocation.

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

Returns
Type	Description
`PlaybookOutputOrBuilder`

getPlaybookState()

public abstract OutputState getPlaybookState()

Required. Playbook invocation's output state.

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

Returns
Type	Description
`OutputState`	The playbookState.

getPlaybookStateValue()

public abstract int getPlaybookStateValue()

Required. Playbook invocation's output state.

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

Returns
Type	Description
`int`	The enum numeric value on the wire for playbookState.

hasPlaybookInput()

public abstract boolean hasPlaybookInput()

Optional. Input of the child playbook invocation.

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

Returns
Type	Description
`boolean`	Whether the playbookInput field is set.

hasPlaybookOutput()

public abstract boolean hasPlaybookOutput()

Optional. Output of the child playbook invocation.

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

Returns
Type	Description
`boolean`	Whether the playbookOutput field is set.