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

Class RegistrationFieldValueInformation

java.lang.Object
software.amazon.awssdk.services.pinpointsmsvoicev2.model.RegistrationFieldValueInformation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RegistrationFieldValueInformation.Builder,RegistrationFieldValueInformation>
@Generated("software.amazon.awssdk:codegen") public final class RegistrationFieldValueInformation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RegistrationFieldValueInformation.Builder,RegistrationFieldValueInformation>

Provides the values of the specified field.

See Also:

  • Method Details

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

    • hasSelectChoices

      public final boolean hasSelectChoices()
      For responses, this returns true if the service returned a value for the SelectChoices 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.

    • selectChoices

      public final List<String> selectChoices()

      An array of values for the form 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 hasSelectChoices() method.

      Returns:
      An array of values for the form field.

    • textValue

      public final String textValue()

      The text data for a free form field.

      Returns:
      The text data for a free form field.

    • registrationAttachmentId

      public final String registrationAttachmentId()

      The unique identifier for the registration attachment.

      Returns:
      The unique identifier for the registration attachment.

    • deniedReason

      public final String deniedReason()

      A description of why the registration was denied.

      Returns:
      A description of why the registration was denied.

    • toBuilder

      public RegistrationFieldValueInformation.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<RegistrationFieldValueInformation.Builder,RegistrationFieldValueInformation>
      Returns:
      a builder for type T

    • builder

      public static RegistrationFieldValueInformation.Builder builder()

    • serializableBuilderClass

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