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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFieldInputConfig.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FieldInputConfig.Builderbuilder()BooleandefaultChecked()Specifies whether a field has a default value.StringdefaultCountryCode()The default country code for a phone number.StringdefaultValue()The default value for the field.StringdescriptiveText()The text to display to describe the field.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FileUploaderFieldConfigfileUploaderConfig()The configuration for the file uploader field.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()BooleanisArray()Specifies whether to render the field as an array.FloatmaxValue()The maximum value to display for the field.FloatminValue()The minimum value to display for the field.Stringname()The name of the field.Stringplaceholder()The text to display as a placeholder for the field.BooleanreadOnly()Specifies a read only field.Booleanrequired()Specifies a field that requires input.List<SdkField<?>>sdkFields()static Class<? extends FieldInputConfig.Builder>serializableBuilderClass()Floatstep()The stepping increment for a numeric value in a field.FieldInputConfig.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringtype()The input type for the field.Stringvalue()The value for the field.ValueMappingsvalueMappings()The information to use to customize the input fields with data at runtime.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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
dataSourceTypefor the form is a Data Store.- Returns:
- Specifies whether to render the field as an array. This property is ignored if the
dataSourceTypefor 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FieldInputConfig.Builder,FieldInputConfig>
-
builder
public static FieldInputConfig.Builder builder()
-
serializableBuilderClass
public static Class<? extends FieldInputConfig.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-