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

Class CreateRegistrationResponse

    • Method Detail

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

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

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

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

      • 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