Package com.google.cloud.dialogflow.cx.v3beta1

Class PlaybookInvocation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.PlaybookInvocation
All Implemented Interfaces:
PlaybookInvocationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PlaybookInvocation extends com.google.protobuf.GeneratedMessage implements PlaybookInvocationOrBuilder
 Stores metadata of the invocation of a child playbook. Playbook invocation
 actions enter the child playbook.
Protobuf type google.cloud.dialogflow.cx.v3beta1.PlaybookInvocation
See Also:

  • Field Details

    • PLAYBOOK_FIELD_NUMBER

      public static final int PLAYBOOK_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • PLAYBOOK_INPUT_FIELD_NUMBER

      public static final int PLAYBOOK_INPUT_FIELD_NUMBER
      See Also:

    • PLAYBOOK_OUTPUT_FIELD_NUMBER

      public static final int PLAYBOOK_OUTPUT_FIELD_NUMBER
      See Also:

    • PLAYBOOK_STATE_FIELD_NUMBER

      public static final int PLAYBOOK_STATE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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) = { ... }
      Specified by:
      getPlaybook in interface PlaybookInvocationOrBuilder
      Returns:
      The playbook.

    • getPlaybookBytes

      public 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) = { ... }
      Specified by:
      getPlaybookBytes in interface PlaybookInvocationOrBuilder
      Returns:
      The bytes for playbook.

    • getDisplayName

      public String getDisplayName()
       Output only. The display name of the playbook.
      string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDisplayName in interface PlaybookInvocationOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Output only. The display name of the playbook.
      string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDisplayNameBytes in interface PlaybookInvocationOrBuilder
      Returns:
      The bytes for displayName.

    • 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];
      Specified by:
      hasPlaybookInput in interface PlaybookInvocationOrBuilder
      Returns:
      Whether the playbookInput field is set.

    • 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];
      Specified by:
      getPlaybookInput in interface PlaybookInvocationOrBuilder
      Returns:
      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];
      Specified by:
      getPlaybookInputOrBuilder in interface PlaybookInvocationOrBuilder

    • 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];
      Specified by:
      hasPlaybookOutput in interface PlaybookInvocationOrBuilder
      Returns:
      Whether the playbookOutput field is set.

    • 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];
      Specified by:
      getPlaybookOutput in interface PlaybookInvocationOrBuilder
      Returns:
      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];
      Specified by:
      getPlaybookOutputOrBuilder in interface PlaybookInvocationOrBuilder

    • getPlaybookStateValue

      public int getPlaybookStateValue()
       Required. Playbook invocation's output state.
      .google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlaybookStateValue in interface PlaybookInvocationOrBuilder
      Returns:
      The enum numeric value on the wire for playbookState.

    • getPlaybookState

      public OutputState getPlaybookState()
       Required. Playbook invocation's output state.
      .google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlaybookState in interface PlaybookInvocationOrBuilder
      Returns:
      The playbookState.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PlaybookInvocation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlaybookInvocation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlaybookInvocation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlaybookInvocation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlaybookInvocation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlaybookInvocation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PlaybookInvocation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PlaybookInvocation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PlaybookInvocation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PlaybookInvocation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PlaybookInvocation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PlaybookInvocation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PlaybookInvocation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PlaybookInvocation.Builder newBuilder()

    • newBuilder

      public static PlaybookInvocation.Builder newBuilder(PlaybookInvocation prototype)

    • toBuilder

      public PlaybookInvocation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PlaybookInvocation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PlaybookInvocation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PlaybookInvocation> parser()

    • getParserForType

      public com.google.protobuf.Parser<PlaybookInvocation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PlaybookInvocation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder