Class FieldInputConfig

java.lang.Object
software.amazon.awssdk.services.amplifyuibuilder.model.FieldInputConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FieldInputConfig.Builder,FieldInputConfig>
@Generated("software.amazon.awssdk:codegen") public final class FieldInputConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FieldInputConfig.Builder,FieldInputConfig>

Describes the configuration for the default input values to display for a field.

See Also:

  • Method Details

    • type

      public final String type()

      The input type for the field.

      Returns:
      The input type for the field.

    • required

      public final Boolean required()

      Specifies a field that requires input.

      Returns:
      Specifies a field that requires input.

    • readOnly

      public final Boolean readOnly()

      Specifies a read only field.

      Returns:
      Specifies a read only field.

    • placeholder

      public final String placeholder()

      The text to display as a placeholder for the field.

      Returns:
      The text to display as a placeholder for the field.

    • defaultValue

      public final String defaultValue()

      The default value for the field.

      Returns:
      The default value for the field.

    • descriptiveText

      public final String descriptiveText()

      The text to display to describe the field.

      Returns:
      The text to display to describe the field.

    • defaultChecked

      public final Boolean defaultChecked()

      Specifies whether a field has a default value.

      Returns:
      Specifies whether a field has a default value.

    • defaultCountryCode

      public final String defaultCountryCode()

      The default country code for a phone number.

      Returns:
      The default country code for a phone number.

    • valueMappings

      public final ValueMappings valueMappings()

      The information to use to customize the input fields with data at runtime.

      Returns:
      The information to use to customize the input fields with data at runtime.

    • name

      public final String name()

      The name of the field.

      Returns:
      The name of the field.

    • minValue

      public final Float minValue()

      The minimum value to display for the field.

      Returns:
      The minimum value to display for the field.

    • maxValue

      public final Float maxValue()

      The maximum value to display for the field.

      Returns:
      The maximum value to display for the field.

    • step

      public final Float step()

      The stepping increment for a numeric value in a field.

      Returns:
      The stepping increment for a numeric value in a field.

    • value

      public final String value()

      The value for the field.

      Returns:
      The value for the field.

    • isArray

      public final Boolean isArray()

      Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

      Returns:
      Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

    • fileUploaderConfig

      public final FileUploaderFieldConfig fileUploaderConfig()

      The configuration for the file uploader field.

      Returns:
      The configuration for the file uploader field.

    • toBuilder

      public FieldInputConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FieldInputConfig.Builder,FieldInputConfig>
      Returns:
      a builder for type T

    • builder

      public static FieldInputConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FieldInputConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.