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

Class RequestPhoneNumberResponse

    • Method Detail

      • phoneNumberArn

        public final String phoneNumberArn()

        The Amazon Resource Name (ARN) of the requested phone number.

        Returns:
        The Amazon Resource Name (ARN) of the requested phone number.

      • phoneNumberId

        public final String phoneNumberId()

        The unique identifier of the new phone number.

        Returns:
        The unique identifier of the new phone number.

      • phoneNumber

        public final String phoneNumber()

        The new phone number that was requested.

        Returns:
        The new phone number that was requested.

      • statusAsString

        public final String statusAsString()

        The current status of the request.

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

        Returns:
        The current status of the request.
        See Also:
        NumberStatus

      • isoCountryCode

        public final String isoCountryCode()

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

        Returns:
        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

      • messageType

        public final MessageType messageType()

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

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

        Returns:
        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
        See Also:
        MessageType

      • messageTypeAsString

        public final String messageTypeAsString()

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

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

        Returns:
        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
        See Also:
        MessageType

      • numberCapabilities

        public final List<NumberCapability> numberCapabilities()

        Indicates if the phone number will be used for text messages, voice messages or both.

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

        Returns:
        Indicates if the phone number will be used for text messages, voice messages or both.

      • hasNumberCapabilities

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

      • numberCapabilitiesAsStrings

        public final List<String> numberCapabilitiesAsStrings()

        Indicates if the phone number will be used for text messages, voice messages or both.

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

        Returns:
        Indicates if the phone number will be used for text messages, voice messages or both.

      • monthlyLeasingPrice

        public final String monthlyLeasingPrice()

        The monthly price, in US dollars, to lease the phone number.

        Returns:
        The monthly price, in US dollars, to lease the phone number.

      • twoWayEnabled

        public final Boolean twoWayEnabled()

        By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

        Returns:
        By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

      • twoWayChannelArn

        public final String twoWayChannelArn()

        The ARN used to identify the two way channel.

        Returns:
        The ARN used to identify the two way channel.

      • twoWayChannelRole

        public final String twoWayChannelRole()

        An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

        Returns:
        An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

      • selfManagedOptOutsEnabled

        public final Boolean selfManagedOptOutsEnabled()

        By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

        Returns:
        By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

      • optOutListName

        public final String optOutListName()

        The name of the OptOutList that is associated with the requested phone number.

        Returns:
        The name of the OptOutList that is associated with the requested phone number.

      • deletionProtectionEnabled

        public final Boolean deletionProtectionEnabled()

        By default this is set to false. When set to true the phone number can't be deleted.

        Returns:
        By default this is set to false. When set to true the phone number can't be deleted.

      • poolId

        public final String poolId()

        The unique identifier of the pool associated with the phone number

        Returns:
        The unique identifier of the pool associated with the phone number

      • registrationId

        public final String registrationId()

        The unique identifier for the registration.

        Returns:
        The unique identifier for the registration.

      • 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 key and value pair tags that are associated with the phone number.

        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 key and value pair tags that are associated with the phone number.

      • createdTimestamp

        public final Instant createdTimestamp()

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

        Returns:
        The time when the phone number 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