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

Class Form.Parameter.Builder

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

    • Method Detail

      • 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.Builder<Form.Parameter.Builder>

      • clear

        public Form.Parameter.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Form.Parameter.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • setField

        public Form.Parameter.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • clearField

        public Form.Parameter.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • clearOneof

        public Form.Parameter.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • setRepeatedField

        public Form.Parameter.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • addRepeatedField

        public Form.Parameter.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • mergeFrom

        public Form.Parameter.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Form.Parameter.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • mergeFrom

        public Form.Parameter.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Form.Parameter.Builder>
        Throws:
        IOException

      • 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.

      • setDisplayName

        public Form.Parameter.Builder setDisplayName​(String value)
         Required. The human-readable name of the parameter, unique within the
 form.
        string display_name = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public Form.Parameter.Builder clearDisplayName()
         Required. The human-readable name of the parameter, unique within the
 form.
        string display_name = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setDisplayNameBytes

        public Form.Parameter.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         Required. The human-readable name of the parameter, unique within the
 form.
        string display_name = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setRequired

        public Form.Parameter.Builder setRequired​(boolean value)
         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;
        Parameters:
        value - The required to set.
        Returns:
        This builder for chaining.

      • clearRequired

        public Form.Parameter.Builder clearRequired()
         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;
        Returns:
        This builder for chaining.

      • 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.

      • setEntityType

        public Form.Parameter.Builder setEntityType​(String value)
         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) = { ... }
        Parameters:
        value - The entityType to set.
        Returns:
        This builder for chaining.

      • clearEntityType

        public Form.Parameter.Builder clearEntityType()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setEntityTypeBytes

        public Form.Parameter.Builder setEntityTypeBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for entityType to set.
        Returns:
        This builder for chaining.

      • 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.

      • setIsList

        public Form.Parameter.Builder setIsList​(boolean value)
         Indicates whether the parameter represents a list of values.
        bool is_list = 4;
        Parameters:
        value - The isList to set.
        Returns:
        This builder for chaining.

      • clearIsList

        public Form.Parameter.Builder clearIsList()
         Indicates whether the parameter represents a list of values.
        bool is_list = 4;
        Returns:
        This builder for chaining.

      • 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.

      • setFillBehavior

        public Form.Parameter.Builder setFillBehavior​(Form.Parameter.FillBehavior value)
         Required. Defines fill behavior for the parameter.
        .google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

      • setFillBehavior

        public Form.Parameter.Builder setFillBehavior​(Form.Parameter.FillBehavior.Builder builderForValue)
         Required. Defines fill behavior for the parameter.
        .google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

      • mergeFillBehavior

        public Form.Parameter.Builder mergeFillBehavior​(Form.Parameter.FillBehavior value)
         Required. Defines fill behavior for the parameter.
        .google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

      • clearFillBehavior

        public Form.Parameter.Builder clearFillBehavior()
         Required. Defines fill behavior for the parameter.
        .google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

      • getFillBehaviorBuilder

        public Form.Parameter.FillBehavior.Builder getFillBehaviorBuilder()
         Required. Defines fill behavior for the parameter.
        .google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];

      • 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.

      • setDefaultValue

        public Form.Parameter.Builder setDefaultValue​(com.google.protobuf.Value value)
         The default value of an optional parameter. If the parameter is required,
 the default value will be ignored.
        .google.protobuf.Value default_value = 9;

      • setDefaultValue

        public Form.Parameter.Builder setDefaultValue​(com.google.protobuf.Value.Builder builderForValue)
         The default value of an optional parameter. If the parameter is required,
 the default value will be ignored.
        .google.protobuf.Value default_value = 9;

      • mergeDefaultValue

        public Form.Parameter.Builder mergeDefaultValue​(com.google.protobuf.Value value)
         The default value of an optional parameter. If the parameter is required,
 the default value will be ignored.
        .google.protobuf.Value default_value = 9;

      • clearDefaultValue

        public Form.Parameter.Builder clearDefaultValue()
         The default value of an optional parameter. If the parameter is required,
 the default value will be ignored.
        .google.protobuf.Value default_value = 9;

      • getDefaultValueBuilder

        public com.google.protobuf.Value.Builder getDefaultValueBuilder()
         The default value of an optional parameter. If the parameter is required,
 the default value will be ignored.
        .google.protobuf.Value default_value = 9;

      • 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.

      • setRedact

        public Form.Parameter.Builder setRedact​(boolean value)
         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;
        Parameters:
        value - The redact to set.
        Returns:
        This builder for chaining.

      • clearRedact

        public Form.Parameter.Builder clearRedact()
         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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Form.Parameter.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>

      • mergeUnknownFields

        public final Form.Parameter.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Form.Parameter.Builder>