Class PlaybookInvocation (0.54.0)

public final class PlaybookInvocation extends GeneratedMessageV3 implements PlaybookInvocationOrBuilder

Stores metadata of the invocation of a child playbook. Next Id: 5

Protobuf type google.cloud.dialogflow.cx.v3beta1.PlaybookInvocation

Static Fields

PLAYBOOK_FIELD_NUMBER

public static final int PLAYBOOK_FIELD_NUMBER
Field Value
Type Description
int

PLAYBOOK_INPUT_FIELD_NUMBER

public static final int PLAYBOOK_INPUT_FIELD_NUMBER
Field Value
Type Description
int

PLAYBOOK_OUTPUT_FIELD_NUMBER

public static final int PLAYBOOK_OUTPUT_FIELD_NUMBER
Field Value
Type Description
int

PLAYBOOK_STATE_FIELD_NUMBER

public static final int PLAYBOOK_STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PlaybookInvocation getDefaultInstance()
Returns
Type Description
PlaybookInvocation

getDescriptor()

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

newBuilder()

public static PlaybookInvocation.Builder newBuilder()
Returns
Type Description
PlaybookInvocation.Builder

newBuilder(PlaybookInvocation prototype)

public static PlaybookInvocation.Builder newBuilder(PlaybookInvocation prototype)
Parameter
Name Description
prototype PlaybookInvocation
Returns
Type Description
PlaybookInvocation.Builder

parseDelimitedFrom(InputStream input)

public static PlaybookInvocation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PlaybookInvocation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PlaybookInvocation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PlaybookInvocation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PlaybookInvocation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PlaybookInvocation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlaybookInvocation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PlaybookInvocation> parser()
Returns
Type Description
Parser<PlaybookInvocation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PlaybookInvocation getDefaultInstanceForType()
Returns
Type Description
PlaybookInvocation

getParserForType()

public Parser<PlaybookInvocation> getParserForType()
Returns
Type Description
Parser<PlaybookInvocation>
Overrides

getPlaybook()

public String getPlaybook()

Required. The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

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

Returns
Type Description
String

The playbook.

getPlaybookBytes()

public ByteString getPlaybookBytes()

Required. The unique identifier of the playbook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

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

Returns
Type Description
ByteString

The bytes for playbook.

getPlaybookInput()

public 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 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 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 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 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 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPlaybookInput()

public 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PlaybookInvocation.Builder newBuilderForType()
Returns
Type Description
PlaybookInvocation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PlaybookInvocation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PlaybookInvocation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PlaybookInvocation.Builder toBuilder()
Returns
Type Description
PlaybookInvocation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException