Package com.google.cloud.dialogflow.cx.v3

Class Form.Parameter

  • All Implemented Interfaces:
    Form.ParameterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Form
    public static final class Form.Parameter
extends com.google.protobuf.GeneratedMessageV3
implements Form.ParameterOrBuilder
     Represents a form parameter.
    Protobuf type google.cloud.dialogflow.cx.v3.Form.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

      • getDisplayName

        public String getDisplayName()
         Required. The human-readable name of the parameter, unique within the
 form.
        string display_name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface Form.ParameterOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The human-readable name of the parameter, unique within the
 form.
        string display_name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface Form.ParameterOrBuilder
        Returns:
        The bytes for displayName.

      • getRequired

        public boolean getRequired()
         Indicates whether the parameter is required. Optional parameters will not
 trigger prompts; however, they are filled if the user specifies them.
 Required parameters must be filled before form filling concludes.
        bool required = 2;
        Specified by:
        getRequired in interface Form.ParameterOrBuilder
        Returns:
        The required.

      • getEntityType

        public String getEntityType()
         Required. The entity type of the parameter.
 Format: `projects/-/locations/-/agents/-/entityTypes/<System Entity Type
 ID>` for system entity types (for example,
 `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
 `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/entityTypes/<Entity Type ID>` for developer entity types.
        string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getEntityType in interface Form.ParameterOrBuilder
        Returns:
        The entityType.

      • getEntityTypeBytes

        public com.google.protobuf.ByteString getEntityTypeBytes()
         Required. The entity type of the parameter.
 Format: `projects/-/locations/-/agents/-/entityTypes/<System Entity Type
 ID>` for system entity types (for example,
 `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
 `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/entityTypes/<Entity Type ID>` for developer entity types.
        string entity_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getEntityTypeBytes in interface Form.ParameterOrBuilder
        Returns:
        The bytes for entityType.

      • getIsList

        public boolean getIsList()
         Indicates whether the parameter represents a list of values.
        bool is_list = 4;
        Specified by:
        getIsList in interface Form.ParameterOrBuilder
        Returns:
        The isList.

      • hasFillBehavior

        public boolean hasFillBehavior()
         Required. Defines fill behavior for the parameter.
        .google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasFillBehavior in interface Form.ParameterOrBuilder
        Returns:
        Whether the fillBehavior field is set.

      • getFillBehavior

        public Form.Parameter.FillBehavior getFillBehavior()
         Required. Defines fill behavior for the parameter.
        .google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFillBehavior in interface Form.ParameterOrBuilder
        Returns:
        The fillBehavior.

      • hasDefaultValue

        public boolean hasDefaultValue()
         The default value of an optional parameter. If the parameter is required,
 the default value will be ignored.
        .google.protobuf.Value default_value = 9;
        Specified by:
        hasDefaultValue in interface Form.ParameterOrBuilder
        Returns:
        Whether the defaultValue field is set.

      • getDefaultValue

        public com.google.protobuf.Value getDefaultValue()
         The default value of an optional parameter. If the parameter is required,
 the default value will be ignored.
        .google.protobuf.Value default_value = 9;
        Specified by:
        getDefaultValue in interface Form.ParameterOrBuilder
        Returns:
        The defaultValue.

      • getDefaultValueOrBuilder

        public com.google.protobuf.ValueOrBuilder getDefaultValueOrBuilder()
         The default value of an optional parameter. If the parameter is required,
 the default value will be ignored.
        .google.protobuf.Value default_value = 9;
        Specified by:
        getDefaultValueOrBuilder in interface Form.ParameterOrBuilder

      • getRedact

        public boolean getRedact()
         Indicates whether the parameter content should be redacted in log.  If
 redaction is enabled, the parameter content will be replaced by parameter
 name during logging.
 Note: the parameter content is subject to redaction if either parameter
 level redaction or [entity type level
 redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.
        bool redact = 11;
        Specified by:
        getRedact in interface Form.ParameterOrBuilder
        Returns:
        The redact.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Form.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 Form.Parameter parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Form.Parameter getDefaultInstance()

      • parser

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

      • getParserForType

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