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

Class Example

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.Example
All Implemented Interfaces:
ExampleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Example extends com.google.protobuf.GeneratedMessage implements ExampleOrBuilder
 Example represents a sample execution of the playbook in the conversation.

 An example consists of a list of ordered actions performed by end user
 or Dialogflow agent according the playbook instructions to fulfill the task.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Example
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int 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:

    • ACTIONS_FIELD_NUMBER

      public static final int ACTIONS_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • TOKEN_COUNT_FIELD_NUMBER

      public static final int TOKEN_COUNT_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • CONVERSATION_STATE_FIELD_NUMBER

      public static final int CONVERSATION_STATE_FIELD_NUMBER
      See Also:

    • LANGUAGE_CODE_FIELD_NUMBER

      public static final int LANGUAGE_CODE_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

    • getName

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

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface ExampleOrBuilder
      Returns:
      The bytes for name.

    • hasPlaybookInput

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

    • getPlaybookInput

      public 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];
      Specified by:
      getPlaybookInput in interface ExampleOrBuilder
      Returns:
      The playbookInput.

    • getPlaybookInputOrBuilder

      public 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];
      Specified by:
      getPlaybookInputOrBuilder in interface ExampleOrBuilder

    • hasPlaybookOutput

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

    • getPlaybookOutput

      public 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];
      Specified by:
      getPlaybookOutput in interface ExampleOrBuilder
      Returns:
      The playbookOutput.

    • getPlaybookOutputOrBuilder

      public 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];
      Specified by:
      getPlaybookOutputOrBuilder in interface ExampleOrBuilder

    • getActionsList

      public 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];
      Specified by:
      getActionsList in interface ExampleOrBuilder

    • getActionsOrBuilderList

      public 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];
      Specified by:
      getActionsOrBuilderList in interface ExampleOrBuilder

    • getActionsCount

      public 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];
      Specified by:
      getActionsCount in interface ExampleOrBuilder

    • getActions

      public 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];
      Specified by:
      getActions in interface ExampleOrBuilder

    • getActionsOrBuilder

      public 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];
      Specified by:
      getActionsOrBuilder in interface ExampleOrBuilder

    • getDisplayName

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

    • getDisplayNameBytes

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

    • getDescription

      public 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];
      Specified by:
      getDescription in interface ExampleOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public 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];
      Specified by:
      getDescriptionBytes in interface ExampleOrBuilder
      Returns:
      The bytes for description.

    • getTokenCount

      public 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];
      Specified by:
      getTokenCount in interface ExampleOrBuilder
      Returns:
      The tokenCount.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The timestamp of initial example creation.
      .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ExampleOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface ExampleOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface ExampleOrBuilder

    • hasUpdateTime

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

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface ExampleOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface ExampleOrBuilder

    • getConversationStateValue

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

    • getConversationState

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

    • getLanguageCode

      public 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];
      Specified by:
      getLanguageCode in interface ExampleOrBuilder
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      public 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];
      Specified by:
      getLanguageCodeBytes in interface ExampleOrBuilder
      Returns:
      The bytes for languageCode.

    • 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 Example parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Example.Builder newBuilder()

    • newBuilder

      public static Example.Builder newBuilder(Example prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Example getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Example> 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 Example getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder