Package com.google.cloud.dialogflow.v2

Interface Intent.ParameterOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Intent.Parameter, Intent.Parameter.Builder
Enclosing class:
Intent
public static interface Intent.ParameterOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The unique identifier of this parameter.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The unique identifier of this parameter.
      string name = 1;
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Required. The name of the parameter.
      string display_name = 2;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The name of the parameter.
      string display_name = 2;
      Returns:
      The bytes for displayName.

    • getValue

      String getValue()
       Optional. The definition of the parameter value. It can be:

 - a constant string,
 - a parameter value defined as `$parameter_name`,
 - an original parameter value defined as `$parameter_name.original`,
 - a parameter value from some context defined as
 `#context_name.parameter_name`.
      string value = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The value.

    • getValueBytes

      com.google.protobuf.ByteString getValueBytes()
       Optional. The definition of the parameter value. It can be:

 - a constant string,
 - a parameter value defined as `$parameter_name`,
 - an original parameter value defined as `$parameter_name.original`,
 - a parameter value from some context defined as
 `#context_name.parameter_name`.
      string value = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for value.

    • getDefaultValue

      String getDefaultValue()
       Optional. The default value to use when the `value` yields an empty
 result.
 Default values can be extracted from contexts by using the following
 syntax: `#context_name.parameter_name`.
      string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      com.google.protobuf.ByteString getDefaultValueBytes()
       Optional. The default value to use when the `value` yields an empty
 result.
 Default values can be extracted from contexts by using the following
 syntax: `#context_name.parameter_name`.
      string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for defaultValue.

    • getEntityTypeDisplayName

      String getEntityTypeDisplayName()
       Optional. The name of the entity type, prefixed with `@`, that
 describes values of the parameter. If the parameter is
 required, this must be provided.
      string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The entityTypeDisplayName.

    • getEntityTypeDisplayNameBytes

      com.google.protobuf.ByteString getEntityTypeDisplayNameBytes()
       Optional. The name of the entity type, prefixed with `@`, that
 describes values of the parameter. If the parameter is
 required, this must be provided.
      string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for entityTypeDisplayName.

    • getMandatory

      boolean getMandatory()
       Optional. Indicates whether the parameter is required. That is,
 whether the intent cannot be completed without collecting the parameter
 value.
      bool mandatory = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The mandatory.

    • getPromptsList

      List<String> getPromptsList()
       Optional. The collection of prompts that the agent can present to the
 user in order to collect a value for the parameter.
      repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the prompts.

    • getPromptsCount

      int getPromptsCount()
       Optional. The collection of prompts that the agent can present to the
 user in order to collect a value for the parameter.
      repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of prompts.

    • getPrompts

      String getPrompts(int index)
       Optional. The collection of prompts that the agent can present to the
 user in order to collect a value for the parameter.
      repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The prompts at the given index.

    • getPromptsBytes

      com.google.protobuf.ByteString getPromptsBytes(int index)
       Optional. The collection of prompts that the agent can present to the
 user in order to collect a value for the parameter.
      repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the prompts at the given index.

    • getIsList

      boolean getIsList()
       Optional. Indicates whether the parameter represents a list of values.
      bool is_list = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The isList.