Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Class RegistrationFieldDefinition

java.lang.Object

software.amazon.awssdk.services.pinpointsmsvoicev2.model.RegistrationFieldDefinition

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class RegistrationFieldDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RegistrationFieldDefinition.Builder,RegistrationFieldDefinition>

Provides a description of the specified field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegistrationFieldDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static RegistrationFieldDefinition.Builder	builder()
RegistrationFieldDisplayHints	displayHints()	An array of RegistrationFieldDisplayHints objects for the field.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fieldPath()	The path to the registration form field.
FieldRequirement	fieldRequirement()	Specifies if the field for the registration form is required, conditional or optional.
String	fieldRequirementAsString()	Specifies if the field for the registration form is required, conditional or optional.
FieldType	fieldType()	The type of field.
String	fieldTypeAsString()	The type of field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
String	sectionPath()	The section path of the field.
SelectValidation	selectValidation()	The validation rules for a select field.
static Class<? extends RegistrationFieldDefinition.Builder>	serializableBuilderClass()
TextValidation	textValidation()	The validation rules for a text field.
RegistrationFieldDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

sectionPath

public final String sectionPath()

The section path of the field.

Returns:

The section path of the field.

fieldPath

public final String fieldPath()

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

Returns:

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

fieldType

public final FieldType fieldType()

The type of field.

If the service returns an enum value that is not available in the current SDK version, fieldType will return FieldType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fieldTypeAsString().

Returns:

The type of field.

See Also:

FieldType

fieldTypeAsString

public final String fieldTypeAsString()

The type of field.

If the service returns an enum value that is not available in the current SDK version, fieldType will return FieldType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fieldTypeAsString().

Returns:

The type of field.

See Also:

FieldType

fieldRequirement

public final FieldRequirement fieldRequirement()

Specifies if the field for the registration form is required, conditional or optional.

If the service returns an enum value that is not available in the current SDK version, fieldRequirement will return FieldRequirement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fieldRequirementAsString().

Returns:

Specifies if the field for the registration form is required, conditional or optional.

See Also:

FieldRequirement

fieldRequirementAsString

public final String fieldRequirementAsString()

Specifies if the field for the registration form is required, conditional or optional.

If the service returns an enum value that is not available in the current SDK version, fieldRequirement will return FieldRequirement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fieldRequirementAsString().

Returns:

Specifies if the field for the registration form is required, conditional or optional.

See Also:

FieldRequirement

selectValidation

public final SelectValidation selectValidation()

The validation rules for a select field.

Returns:

The validation rules for a select field.

textValidation

public final TextValidation textValidation()

The validation rules for a text field.

Returns:

The validation rules for a text field.

displayHints

public final RegistrationFieldDisplayHints displayHints()

An array of RegistrationFieldDisplayHints objects for the field.

Returns:

An array of RegistrationFieldDisplayHints objects for the field.

toBuilder

public RegistrationFieldDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegistrationFieldDefinition.Builder,RegistrationFieldDefinition>

builder

public static RegistrationFieldDefinition.Builder builder()

serializableBuilderClass

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