Class FieldConfig
- java.lang.Object
-
- software.amazon.awssdk.services.amplifyuibuilder.model.FieldConfig
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FieldConfig.Builder,FieldConfig>
@Generated("software.amazon.awssdk:codegen") public final class FieldConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FieldConfig.Builder,FieldConfig>
Describes the configuration information for a field in a table.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFieldConfig.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FieldConfig.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Booleanexcluded()Specifies whether to hide a field.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasValidations()For responses, this returns true if the service returned a value for the Validations property.FieldInputConfiginputType()Describes the configuration for the default input value to display for a field.Stringlabel()The label for the field.FieldPositionposition()Specifies the field position.List<SdkField<?>>sdkFields()static Class<? extends FieldConfig.Builder>serializableBuilderClass()FieldConfig.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<FieldValidationConfiguration>validations()The validations to perform on the value in the field.-
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
-
label
public final String label()
The label for the field.
- Returns:
- The label for the field.
-
position
public final FieldPosition position()
Specifies the field position.
- Returns:
- Specifies the field position.
-
excluded
public final Boolean excluded()
Specifies whether to hide a field.
- Returns:
- Specifies whether to hide a field.
-
inputType
public final FieldInputConfig inputType()
Describes the configuration for the default input value to display for a field.
- Returns:
- Describes the configuration for the default input value to display for a field.
-
hasValidations
public final boolean hasValidations()
For responses, this returns true if the service returned a value for the Validations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
validations
public final List<FieldValidationConfiguration> validations()
The validations to perform on the value in the field.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasValidations()method.- Returns:
- The validations to perform on the value in the field.
-
toBuilder
public FieldConfig.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FieldConfig.Builder,FieldConfig>
-
builder
public static FieldConfig.Builder builder()
-
serializableBuilderClass
public static Class<? extends FieldConfig.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.
-
-