Package com.google.cloud.dialogflow.v2

Class Intent.Parameter

  • All Implemented Interfaces:
    Intent.ParameterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Intent
    public static final class Intent.Parameter
extends com.google.protobuf.GeneratedMessageV3
implements Intent.ParameterOrBuilder
     Represents intent parameters.
    Protobuf type google.cloud.dialogflow.v2.Intent.Parameter
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The unique identifier of this parameter.
        string name = 1;
        Specified by:
        getNameBytes in interface Intent.ParameterOrBuilder
        Returns:
        The bytes for name.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The name of the parameter.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface Intent.ParameterOrBuilder
        Returns:
        The bytes for displayName.

      • getValue

        public 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];
        Specified by:
        getValue in interface Intent.ParameterOrBuilder
        Returns:
        The value.

      • getValueBytes

        public 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];
        Specified by:
        getValueBytes in interface Intent.ParameterOrBuilder
        Returns:
        The bytes for value.

      • getDefaultValue

        public 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];
        Specified by:
        getDefaultValue in interface Intent.ParameterOrBuilder
        Returns:
        The defaultValue.

      • getDefaultValueBytes

        public 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];
        Specified by:
        getDefaultValueBytes in interface Intent.ParameterOrBuilder
        Returns:
        The bytes for defaultValue.

      • getEntityTypeDisplayName

        public 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];
        Specified by:
        getEntityTypeDisplayName in interface Intent.ParameterOrBuilder
        Returns:
        The entityTypeDisplayName.

      • getEntityTypeDisplayNameBytes

        public 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];
        Specified by:
        getEntityTypeDisplayNameBytes in interface Intent.ParameterOrBuilder
        Returns:
        The bytes for entityTypeDisplayName.

      • getMandatory

        public 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];
        Specified by:
        getMandatory in interface Intent.ParameterOrBuilder
        Returns:
        The mandatory.

      • getPromptsList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getPromptsList in interface Intent.ParameterOrBuilder
        Returns:
        A list containing the prompts.

      • getPromptsCount

        public 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];
        Specified by:
        getPromptsCount in interface Intent.ParameterOrBuilder
        Returns:
        The count of prompts.

      • getPrompts

        public 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];
        Specified by:
        getPrompts in interface Intent.ParameterOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The prompts at the given index.

      • getPromptsBytes

        public 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];
        Specified by:
        getPromptsBytes in interface Intent.ParameterOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the prompts at the given index.

      • getIsList

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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

      • parseFrom

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

      • parseFrom

        public static Intent.Parameter parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Intent.Parameter.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Intent.Parameter> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public Intent.Parameter getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder