Class PlaybookInvocation (0.87.0)
Version 0.87.0keyboard_arrow_down
public final class PlaybookInvocation extends GeneratedMessageV3 implements PlaybookInvocationOrBuilder
Stores metadata of the invocation of a child playbook.
Protobuf type google.cloud.dialogflow.cx.v3beta1.PlaybookInvocation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
PLAYBOOK_FIELD_NUMBER
public static final int PLAYBOOK_FIELD_NUMBER
Field Value
Type Description
int
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static PlaybookInvocation . Builder newBuilder ()
newBuilder(PlaybookInvocation prototype)
public static PlaybookInvocation . Builder newBuilder ( PlaybookInvocation prototype )
public static PlaybookInvocation parseDelimitedFrom ( InputStream input )
public static PlaybookInvocation parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static PlaybookInvocation parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PlaybookInvocation parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static PlaybookInvocation parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PlaybookInvocation parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static PlaybookInvocation parseFrom ( CodedInputStream input )
public static PlaybookInvocation parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static PlaybookInvocation parseFrom ( InputStream input )
public static PlaybookInvocation parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static PlaybookInvocation parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PlaybookInvocation parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<PlaybookInvocation> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public PlaybookInvocation getDefaultInstanceForType ()
getDisplayName()
public 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 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.
getParserForType()
public Parser<PlaybookInvocation> getParserForType ()
Overrides
getPlaybook()
public 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 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.
public PlaybookInput getPlaybookInput ()
Optional. Input of the child playbook invocation.
.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];
public PlaybookInputOrBuilder getPlaybookInputOrBuilder ()
Optional. Input of the child playbook invocation.
.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
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
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public PlaybookInvocation . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PlaybookInvocation . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public PlaybookInvocation . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
