Class PlaybookInvocation (0.52.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
TypeDescription
int

PLAYBOOK_INPUT_FIELD_NUMBER

public static final int PLAYBOOK_INPUT_FIELD_NUMBER
Field Value
TypeDescription
int

PLAYBOOK_OUTPUT_FIELD_NUMBER

public static final int PLAYBOOK_OUTPUT_FIELD_NUMBER
Field Value
TypeDescription
int

PLAYBOOK_STATE_FIELD_NUMBER

public static final int PLAYBOOK_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PlaybookInvocation getDefaultInstance()
Returns
TypeDescription
PlaybookInvocation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PlaybookInvocation.Builder newBuilder()
Returns
TypeDescription
PlaybookInvocation.Builder

newBuilder(PlaybookInvocation prototype)

public static PlaybookInvocation.Builder newBuilder(PlaybookInvocation prototype)
Parameter
NameDescription
prototypePlaybookInvocation
Returns
TypeDescription
PlaybookInvocation.Builder

parseDelimitedFrom(InputStream input)

public static PlaybookInvocation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PlaybookInvocation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PlaybookInvocation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PlaybookInvocation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PlaybookInvocation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PlaybookInvocation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PlaybookInvocation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PlaybookInvocation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PlaybookInvocation> parser()
Returns
TypeDescription
Parser<PlaybookInvocation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PlaybookInvocation getDefaultInstanceForType()
Returns
TypeDescription
PlaybookInvocation

getParserForType()

public Parser<PlaybookInvocation> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for playbookState.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the playbookOutput field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PlaybookInvocation.Builder newBuilderForType()
Returns
TypeDescription
PlaybookInvocation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PlaybookInvocation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PlaybookInvocation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PlaybookInvocation.Builder toBuilder()
Returns
TypeDescription
PlaybookInvocation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException