Class CreateRegistrationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response
software.amazon.awssdk.services.pinpointsmsvoicev2.model.CreateRegistrationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRegistrationResponse.Builder,CreateRegistrationResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateRegistrationResponse extends PinpointSmsVoiceV2Response implements ToCopyableBuilder<CreateRegistrationResponse.Builder,CreateRegistrationResponse>

  • 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 to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

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

    • registrationStatus

      public final RegistrationStatus registrationStatus()

      The status of the registration.

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

      • CREATED: Your registration is created but not submitted.

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

      • DELETED: The registration has been deleted.

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

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

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

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

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

      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.

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

      • CREATED: Your registration is created but not submitted.

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

      • DELETED: The registration has been deleted.

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

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

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

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

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

      See Also:

    • registrationStatusAsString

      public final String registrationStatusAsString()

      The status of the registration.

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

      • CREATED: Your registration is created but not submitted.

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

      • DELETED: The registration has been deleted.

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

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

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

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

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

      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.

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

      • CREATED: Your registration is created but not submitted.

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

      • DELETED: The registration has been deleted.

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

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

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

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

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

      See Also:

    • currentVersionNumber

      public final Long currentVersionNumber()

      The current version number of the registration.

      Returns:
      The current version number of the registration.

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

    • hasTags

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

    • tags

      public final List<Tag> tags()

      An array of tags (key and value pairs) to associate with the registration.

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

      Returns:
      An array of tags (key and value pairs) to associate with the registration.

    • 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 CreateRegistrationResponse.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<CreateRegistrationResponse.Builder,CreateRegistrationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateRegistrationResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateRegistrationResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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