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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<RegistrationFieldDefinition.Builder,RegistrationFieldDefinition>
      Returns:
      a builder for type T

    • 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)
      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.