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

Interface PlaybookOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Playbook, Playbook.Builder
@Generated public interface PlaybookOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The unique identifier of the playbook.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The unique identifier of the playbook.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string name = 1;
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Required. The human-readable name of the playbook, unique within an agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The human-readable name of the playbook, unique within an agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • getGoal

      String getGoal()
       Required. High level description of the goal the playbook intend to
 accomplish. A goal should be concise since it's visible to other playbooks
 that may reference this playbook.
      string goal = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The goal.

    • getGoalBytes

      com.google.protobuf.ByteString getGoalBytes()
       Required. High level description of the goal the playbook intend to
 accomplish. A goal should be concise since it's visible to other playbooks
 that may reference this playbook.
      string goal = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for goal.

    • getInputParameterDefinitionsList

      List<ParameterDefinition> getInputParameterDefinitionsList()
       Optional. Defined structured input parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getInputParameterDefinitions

      ParameterDefinition getInputParameterDefinitions(int index)
       Optional. Defined structured input parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getInputParameterDefinitionsCount

      int getInputParameterDefinitionsCount()
       Optional. Defined structured input parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getInputParameterDefinitionsOrBuilderList

      List<? extends ParameterDefinitionOrBuilder> getInputParameterDefinitionsOrBuilderList()
       Optional. Defined structured input parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getInputParameterDefinitionsOrBuilder

      ParameterDefinitionOrBuilder getInputParameterDefinitionsOrBuilder(int index)
       Optional. Defined structured input parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getOutputParameterDefinitionsList

      List<ParameterDefinition> getOutputParameterDefinitionsList()
       Optional. Defined structured output parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getOutputParameterDefinitions

      ParameterDefinition getOutputParameterDefinitions(int index)
       Optional. Defined structured output parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getOutputParameterDefinitionsCount

      int getOutputParameterDefinitionsCount()
       Optional. Defined structured output parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getOutputParameterDefinitionsOrBuilderList

      List<? extends ParameterDefinitionOrBuilder> getOutputParameterDefinitionsOrBuilderList()
       Optional. Defined structured output parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getOutputParameterDefinitionsOrBuilder

      ParameterDefinitionOrBuilder getOutputParameterDefinitionsOrBuilder(int index)
       Optional. Defined structured output parameters for this playbook.
      repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasInstruction

      boolean hasInstruction()
       Instruction to accomplish target goal.
      .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
      Returns:
      Whether the instruction field is set.

    • getInstruction

      Playbook.Instruction getInstruction()
       Instruction to accomplish target goal.
      .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
      Returns:
      The instruction.

    • getInstructionOrBuilder

      Playbook.InstructionOrBuilder getInstructionOrBuilder()
       Instruction to accomplish target goal.
      .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;

    • getTokenCount

      long getTokenCount()
       Output only. Estimated number of tokes current playbook takes when sent to
 the LLM.
      int64 token_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The tokenCount.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The timestamp of initial playbook creation.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp of initial playbook creation.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp of initial playbook creation.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Last time the playbook version was updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Last time the playbook version was updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Last time the playbook version was updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getReferencedPlaybooksList

      List<String> getReferencedPlaybooksList()
       Output only. The resource name of other playbooks referenced by the current
 playbook in the instructions.
      repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the referencedPlaybooks.

    • getReferencedPlaybooksCount

      int getReferencedPlaybooksCount()
       Output only. The resource name of other playbooks referenced by the current
 playbook in the instructions.
      repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The count of referencedPlaybooks.

    • getReferencedPlaybooks

      String getReferencedPlaybooks(int index)
       Output only. The resource name of other playbooks referenced by the current
 playbook in the instructions.
      repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The referencedPlaybooks at the given index.

    • getReferencedPlaybooksBytes

      com.google.protobuf.ByteString getReferencedPlaybooksBytes(int index)
       Output only. The resource name of other playbooks referenced by the current
 playbook in the instructions.
      repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the referencedPlaybooks at the given index.

    • getReferencedFlowsList

      List<String> getReferencedFlowsList()
       Output only. The resource name of flows referenced by the current playbook
 in the instructions.
      repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the referencedFlows.

    • getReferencedFlowsCount

      int getReferencedFlowsCount()
       Output only. The resource name of flows referenced by the current playbook
 in the instructions.
      repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The count of referencedFlows.

    • getReferencedFlows

      String getReferencedFlows(int index)
       Output only. The resource name of flows referenced by the current playbook
 in the instructions.
      repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The referencedFlows at the given index.

    • getReferencedFlowsBytes

      com.google.protobuf.ByteString getReferencedFlowsBytes(int index)
       Output only. The resource name of flows referenced by the current playbook
 in the instructions.
      repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the referencedFlows at the given index.

    • getReferencedToolsList

      List<String> getReferencedToolsList()
       Optional. The resource name of tools referenced by the current playbook in
 the instructions. If not provided explicitly, they are will
 be implied using the tool being referenced in goal and steps.
      repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the referencedTools.

    • getReferencedToolsCount

      int getReferencedToolsCount()
       Optional. The resource name of tools referenced by the current playbook in
 the instructions. If not provided explicitly, they are will
 be implied using the tool being referenced in goal and steps.
      repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The count of referencedTools.

    • getReferencedTools

      String getReferencedTools(int index)
       Optional. The resource name of tools referenced by the current playbook in
 the instructions. If not provided explicitly, they are will
 be implied using the tool being referenced in goal and steps.
      repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The referencedTools at the given index.

    • getReferencedToolsBytes

      com.google.protobuf.ByteString getReferencedToolsBytes(int index)
       Optional. The resource name of tools referenced by the current playbook in
 the instructions. If not provided explicitly, they are will
 be implied using the tool being referenced in goal and steps.
      repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the referencedTools at the given index.

    • getInlineActionsList

      List<String> getInlineActionsList()
       Optional. Output only. Names of inline actions scoped to this playbook.
 These actions are in addition to those belonging to referenced tools, child
 playbooks, and flows, e.g. actions that are defined in the playbook's code
 block.
      repeated string inline_actions = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the inlineActions.

    • getInlineActionsCount

      int getInlineActionsCount()
       Optional. Output only. Names of inline actions scoped to this playbook.
 These actions are in addition to those belonging to referenced tools, child
 playbooks, and flows, e.g. actions that are defined in the playbook's code
 block.
      repeated string inline_actions = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of inlineActions.

    • getInlineActions

      String getInlineActions(int index)
       Optional. Output only. Names of inline actions scoped to this playbook.
 These actions are in addition to those belonging to referenced tools, child
 playbooks, and flows, e.g. actions that are defined in the playbook's code
 block.
      repeated string inline_actions = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The inlineActions at the given index.

    • getInlineActionsBytes

      com.google.protobuf.ByteString getInlineActionsBytes(int index)
       Optional. Output only. Names of inline actions scoped to this playbook.
 These actions are in addition to those belonging to referenced tools, child
 playbooks, and flows, e.g. actions that are defined in the playbook's code
 block.
      repeated string inline_actions = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the inlineActions at the given index.

    • hasCodeBlock

      boolean hasCodeBlock()
       Optional. The playbook's scoped code block, which may implement handlers
 and actions.
      .google.cloud.dialogflow.cx.v3beta1.CodeBlock code_block = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the codeBlock field is set.

    • getCodeBlock

      CodeBlock getCodeBlock()
       Optional. The playbook's scoped code block, which may implement handlers
 and actions.
      .google.cloud.dialogflow.cx.v3beta1.CodeBlock code_block = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The codeBlock.

    • getCodeBlockOrBuilder

      CodeBlockOrBuilder getCodeBlockOrBuilder()
       Optional. The playbook's scoped code block, which may implement handlers
 and actions.
      .google.cloud.dialogflow.cx.v3beta1.CodeBlock code_block = 21 [(.google.api.field_behavior) = OPTIONAL];

    • hasLlmModelSettings

      boolean hasLlmModelSettings()
       Optional. Llm model settings for the playbook.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the llmModelSettings field is set.

    • getLlmModelSettings

      LlmModelSettings getLlmModelSettings()
       Optional. Llm model settings for the playbook.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The llmModelSettings.

    • getLlmModelSettingsOrBuilder

      LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder()
       Optional. Llm model settings for the playbook.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • hasSpeechSettings

      boolean hasSpeechSettings()
       Optional. Playbook level Settings for speech to text detection.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the speechSettings field is set.

    • getSpeechSettings

      AdvancedSettings.SpeechSettings getSpeechSettings()
       Optional. Playbook level Settings for speech to text detection.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The speechSettings.

    • getSpeechSettingsOrBuilder

      AdvancedSettings.SpeechSettingsOrBuilder getSpeechSettingsOrBuilder()
       Optional. Playbook level Settings for speech to text detection.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];

    • getHandlersList

      List<Handler> getHandlersList()
       Optional. A list of registered handlers to execute based on the specified
 triggers.
      repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];

    • getHandlers

      Handler getHandlers(int index)
       Optional. A list of registered handlers to execute based on the specified
 triggers.
      repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];

    • getHandlersCount

      int getHandlersCount()
       Optional. A list of registered handlers to execute based on the specified
 triggers.
      repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];

    • getHandlersOrBuilderList

      List<? extends HandlerOrBuilder> getHandlersOrBuilderList()
       Optional. A list of registered handlers to execute based on the specified
 triggers.
      repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];

    • getHandlersOrBuilder

      HandlerOrBuilder getHandlersOrBuilder(int index)
       Optional. A list of registered handlers to execute based on the specified
 triggers.
      repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];

    • getPlaybookTypeValue

      int getPlaybookTypeValue()
       Optional. Type of the playbook.
      .google.cloud.dialogflow.cx.v3beta1.Playbook.PlaybookType playbook_type = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for playbookType.

    • getPlaybookType

      Playbook.PlaybookType getPlaybookType()
       Optional. Type of the playbook.
      .google.cloud.dialogflow.cx.v3beta1.Playbook.PlaybookType playbook_type = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The playbookType.