software.amazon.awssdk.services.amplifyuibuilder.model

Class FieldConfig

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.FieldConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FieldConfig.Builder,FieldConfig>

@Generated(value="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 and Description
static interface	FieldConfig.Builder

Method Summary

Modifier and Type	Method and Description
static FieldConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	excluded() Specifies whether to hide a field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValidations() For responses, this returns true if the service returned a value for the Validations property.
FieldInputConfig	inputType() Describes the configuration for the default input value to display for a field.
String	label() The label for the field.
FieldPosition	position() Specifies the field position.
List<SdkField<?>>	sdkFields()
static Class<? extends FieldConfig.Builder>	serializableBuilderClass()
FieldConfig.Builder	toBuilder()
String	toString() 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

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.

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.

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 the isEmpty() 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:

toBuilder in interface ToCopyableBuilder<FieldConfig.Builder,FieldConfig>

builder

public static FieldConfig.Builder builder()

serializableBuilderClass

public static Class<? extends FieldConfig.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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