Class RegistrationInformation

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

Provides information about the requested registration.

See Also:

  • Method Details

    • registrationArn

      public final String registrationArn()

      The Amazon Resource Name (ARN) for the registration.

      Returns:
      The Amazon Resource Name (ARN) for the registration.

    • registrationId

      public final String registrationId()

      The unique identifier for the registration.

      Returns:
      The unique identifier for the registration.

    • registrationType

      public final String registrationType()

      The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

      Returns:
      The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    • registrationStatus

      public final RegistrationStatus registrationStatus()

      The status of the registration.

      • CREATED: Your registration is created but not submitted.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • COMPLETE: Your registration has been approved and and your origination identity has been created.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • DELETED: The registration has been deleted.

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

      Returns:
      The status of the registration.

      • CREATED: Your registration is created but not submitted.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • COMPLETE: Your registration has been approved and and your origination identity has been created.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • DELETED: The registration has been deleted.

      See Also:

    • registrationStatusAsString

      public final String registrationStatusAsString()

      The status of the registration.

      • CREATED: Your registration is created but not submitted.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • COMPLETE: Your registration has been approved and and your origination identity has been created.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • DELETED: The registration has been deleted.

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

      Returns:
      The status of the registration.

      • CREATED: Your registration is created but not submitted.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • COMPLETE: Your registration has been approved and and your origination identity has been created.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • DELETED: The registration has been deleted.

      See Also:

    • currentVersionNumber

      public final Long currentVersionNumber()

      The current version number of the registration.

      Returns:
      The current version number of the registration.

    • approvedVersionNumber

      public final Long approvedVersionNumber()

      The version number of the registration that was approved.

      Returns:
      The version number of the registration that was approved.

    • latestDeniedVersionNumber

      public final Long latestDeniedVersionNumber()

      The latest version number of the registration that was denied.

      Returns:
      The latest version number of the registration that was denied.

    • hasAdditionalAttributes

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

    • additionalAttributes

      public final Map<String,String> additionalAttributes()

      Metadata about a given registration which is specific to that registration type.

      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 hasAdditionalAttributes() method.

      Returns:
      Metadata about a given registration which is specific to that registration type.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time when the registration was created, in UNIX epoch time format.

      Returns:
      The time when the registration was created, in UNIX epoch time format.

    • toBuilder

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

    • builder

      public static RegistrationInformation.Builder builder()

    • serializableBuilderClass

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