Class PlaybookInvocation.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PlaybookInvocation.Builder>
com.google.cloud.dialogflow.cx.v3beta1.PlaybookInvocation.Builder
All Implemented Interfaces:
PlaybookInvocationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PlaybookInvocation

public static final class PlaybookInvocation.Builder extends com.google.protobuf.GeneratedMessage.Builder<PlaybookInvocation.Builder> 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
  • 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.Builder<PlaybookInvocation.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<PlaybookInvocation.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PlaybookInvocation.Builder>
    • getDefaultInstanceForType

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

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

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

      public PlaybookInvocation.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PlaybookInvocation.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PlaybookInvocation.Builder>
    • mergeFrom

      public PlaybookInvocation.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PlaybookInvocation.Builder>
      Throws:
      IOException
    • 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.
    • setPlaybook

      public PlaybookInvocation.Builder setPlaybook(String value)
       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) = { ... }
      Parameters:
      value - The playbook to set.
      Returns:
      This builder for chaining.
    • clearPlaybook

      public PlaybookInvocation.Builder clearPlaybook()
       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:
      This builder for chaining.
    • setPlaybookBytes

      public PlaybookInvocation.Builder setPlaybookBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for playbook to set.
      Returns:
      This builder for chaining.
    • 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.
    • setDisplayName

      public PlaybookInvocation.Builder setDisplayName(String value)
       Output only. The display name of the playbook.
       
      string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.
    • clearDisplayName

      public PlaybookInvocation.Builder clearDisplayName()
       Output only. The display name of the playbook.
       
      string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • setDisplayNameBytes

      public PlaybookInvocation.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       Output only. The display name of the playbook.
       
      string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.
    • 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.
    • setPlaybookInput

      public PlaybookInvocation.Builder setPlaybookInput(PlaybookInput value)
       Optional. Input of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];
    • setPlaybookInput

      public PlaybookInvocation.Builder setPlaybookInput(PlaybookInput.Builder builderForValue)
       Optional. Input of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];
    • mergePlaybookInput

      public PlaybookInvocation.Builder mergePlaybookInput(PlaybookInput value)
       Optional. Input of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];
    • clearPlaybookInput

      public PlaybookInvocation.Builder clearPlaybookInput()
       Optional. Input of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];
    • getPlaybookInputBuilder

      public PlaybookInput.Builder getPlaybookInputBuilder()
       Optional. Input of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 2 [(.google.api.field_behavior) = OPTIONAL];
    • 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.
    • setPlaybookOutput

      public PlaybookInvocation.Builder setPlaybookOutput(PlaybookOutput value)
       Optional. Output of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];
    • setPlaybookOutput

      public PlaybookInvocation.Builder setPlaybookOutput(PlaybookOutput.Builder builderForValue)
       Optional. Output of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];
    • mergePlaybookOutput

      public PlaybookInvocation.Builder mergePlaybookOutput(PlaybookOutput value)
       Optional. Output of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];
    • clearPlaybookOutput

      public PlaybookInvocation.Builder clearPlaybookOutput()
       Optional. Output of the child playbook invocation.
       
      .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 3 [(.google.api.field_behavior) = OPTIONAL];
    • getPlaybookOutputBuilder

      public PlaybookOutput.Builder getPlaybookOutputBuilder()
       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];
      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.
    • setPlaybookStateValue

      public PlaybookInvocation.Builder setPlaybookStateValue(int value)
       Required. Playbook invocation's output state.
       
      .google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for playbookState to set.
      Returns:
      This builder for chaining.
    • 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.
    • setPlaybookState

      public PlaybookInvocation.Builder setPlaybookState(OutputState value)
       Required. Playbook invocation's output state.
       
      .google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The playbookState to set.
      Returns:
      This builder for chaining.
    • clearPlaybookState

      public PlaybookInvocation.Builder clearPlaybookState()
       Required. Playbook invocation's output state.
       
      .google.cloud.dialogflow.cx.v3beta1.OutputState playbook_state = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.