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

Class UpdatePhoneNumberResponse

    • Method Detail

      • phoneNumberArn

        public final String phoneNumberArn()

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

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

      • phoneNumberId

        public final String phoneNumberId()

        The unique identifier of the phone number.

        Returns:
        The unique identifier of the phone number.

      • phoneNumber

        public final String phoneNumber()

        The phone number that was updated.

        Returns:
        The phone number that was updated.

      • 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()

        Specifies if the number could be used for text messages, voice 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:
        Specifies if the number could be used for text messages, voice 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()

        Specifies if the number could be used for text messages, voice 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:
        Specifies if the number could be used for text messages, voice or both.

      • monthlyLeasingPrice

        public final String monthlyLeasingPrice()

        The monthly leasing price of the phone number, in US dollars.

        Returns:
        The monthly leasing price of the phone number, in US dollars.

      • 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 Amazon Resource Name (ARN) of the two way channel.

        Returns:
        The Amazon Resource Name (ARN) of 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()

        This is true if self managed opt-out are enabled.

        Returns:
        This is true if self managed opt-out are enabled.

      • optOutListName

        public final String optOutListName()

        The name of the OptOutList associated with the phone number.

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

      • deletionProtectionEnabled

        public final Boolean deletionProtectionEnabled()

        When set to true the phone number can't be deleted.

        Returns:
        When set to true the phone number can't be deleted.

      • registrationId

        public final String registrationId()

        The unique identifier for the registration.

        Returns:
        The unique identifier for the registration.

      • 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