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

Class Form.Parameter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.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.GeneratedMessage implements Form.ParameterOrBuilder
 Represents a form parameter.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Form.Parameter
See Also:

  • Field Details

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • REQUIRED_FIELD_NUMBER

      public static final int REQUIRED_FIELD_NUMBER
      See Also:

    • ENTITY_TYPE_FIELD_NUMBER

      public static final int ENTITY_TYPE_FIELD_NUMBER
      See Also:

    • IS_LIST_FIELD_NUMBER

      public static final int IS_LIST_FIELD_NUMBER
      See Also:

    • FILL_BEHAVIOR_FIELD_NUMBER

      public static final int FILL_BEHAVIOR_FIELD_NUMBER
      See Also:

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:

    • REDACT_FIELD_NUMBER

      public static final int REDACT_FIELD_NUMBER
      See Also:

    • ADVANCED_SETTINGS_FIELD_NUMBER

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

    • 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/<SystemEntityTypeID>` for
 system entity types (for example,
 `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
 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/<SystemEntityTypeID>` for
 system entity types (for example,
 `projects/-/locations/-/agents/-/entityTypes/sys.date`), or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`
 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.v3beta1.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.v3beta1.Form.Parameter.FillBehavior fill_behavior = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFillBehavior in interface Form.ParameterOrBuilder
      Returns:
      The fillBehavior.

    • getFillBehaviorOrBuilder

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

    • 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.v3beta1.EntityType.redact] is
 enabled.
      bool redact = 11;
      Specified by:
      getRedact in interface Form.ParameterOrBuilder
      Returns:
      The redact.

    • hasAdvancedSettings

      public boolean hasAdvancedSettings()
       Hierarchical advanced settings for this parameter. The settings exposed
 at the lower level overrides the settings exposed at the higher level.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 12;
      Specified by:
      hasAdvancedSettings in interface Form.ParameterOrBuilder
      Returns:
      Whether the advancedSettings field is set.

    • getAdvancedSettings

      public AdvancedSettings getAdvancedSettings()
       Hierarchical advanced settings for this parameter. The settings exposed
 at the lower level overrides the settings exposed at the higher level.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 12;
      Specified by:
      getAdvancedSettings in interface Form.ParameterOrBuilder
      Returns:
      The advancedSettings.

    • getAdvancedSettingsOrBuilder

      public AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()
       Hierarchical advanced settings for this parameter. The settings exposed
 at the lower level overrides the settings exposed at the higher level.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 12;
      Specified by:
      getAdvancedSettingsOrBuilder in interface Form.ParameterOrBuilder

    • 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 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Form.Parameter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static Form.Parameter.Builder newBuilder()

    • newBuilder

      public static Form.Parameter.Builder newBuilder(Form.Parameter prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

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

    • getDefaultInstanceForType

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