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

Interface ExampleOrBuilder

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

  • Method Details

    • getName

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

    • getNameBytes

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

    • hasPlaybookInput

      boolean hasPlaybookInput()
       Optional. The input to the playbook in the example.
      .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the playbookInput field is set.

    • getPlaybookInput

      PlaybookInput getPlaybookInput()
       Optional. The input to the playbook in the example.
      .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The playbookInput.

    • getPlaybookInputOrBuilder

      PlaybookInputOrBuilder getPlaybookInputOrBuilder()
       Optional. The input to the playbook in the example.
      .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];

    • hasPlaybookOutput

      boolean hasPlaybookOutput()
       Optional. The output of the playbook in the example.
      .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the playbookOutput field is set.

    • getPlaybookOutput

      PlaybookOutput getPlaybookOutput()
       Optional. The output of the playbook in the example.
      .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The playbookOutput.

    • getPlaybookOutputOrBuilder

      PlaybookOutputOrBuilder getPlaybookOutputOrBuilder()
       Optional. The output of the playbook in the example.
      .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getActionsList

      List<Action> getActionsList()
       Required. The ordered list of actions performed by the end user and the
 Dialogflow agent.
      repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getActions

      Action getActions(int index)
       Required. The ordered list of actions performed by the end user and the
 Dialogflow agent.
      repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getActionsCount

      int getActionsCount()
       Required. The ordered list of actions performed by the end user and the
 Dialogflow agent.
      repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getActionsOrBuilderList

      List<? extends ActionOrBuilder> getActionsOrBuilderList()
       Required. The ordered list of actions performed by the end user and the
 Dialogflow agent.
      repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getActionsOrBuilder

      ActionOrBuilder getActionsOrBuilder(int index)
       Required. The ordered list of actions performed by the end user and the
 Dialogflow agent.
      repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

    • getDisplayName

      String getDisplayName()
       Required. The display name of the example.
      string display_name = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the example.
      string display_name = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Optional. The high level concise description of the example. The max number
 of characters is 200.
      string description = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The high level concise description of the example. The max number
 of characters is 200.
      string description = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getTokenCount

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

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The timestamp of initial example creation.
      .google.protobuf.Timestamp create_time = 10 [(.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 example creation.
      .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

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

    • hasUpdateTime

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

    • getUpdateTime

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

    • getUpdateTimeOrBuilder

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

    • getConversationStateValue

      int getConversationStateValue()
       Required. Example's output state.
      .google.cloud.dialogflow.cx.v3beta1.OutputState conversation_state = 12 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for conversationState.

    • getConversationState

      OutputState getConversationState()
       Required. Example's output state.
      .google.cloud.dialogflow.cx.v3beta1.OutputState conversation_state = 12 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The conversationState.

    • getLanguageCode

      String getLanguageCode()
       Optional. The language code of the example.
 If not specified, the agent's default language is used.
 Note: languages must be enabled in the agent before they can be used.
 Note: example's language code is not currently used in dialogflow agents.
      string language_code = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      com.google.protobuf.ByteString getLanguageCodeBytes()
       Optional. The language code of the example.
 If not specified, the agent's default language is used.
 Note: languages must be enabled in the agent before they can be used.
 Note: example's language code is not currently used in dialogflow agents.
      string language_code = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for languageCode.