Class PhoneNumberInformation

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

The information for a phone number, in E.164 format, in an Amazon Web Services account.

See Also:

  • Method Details

    • phoneNumberArn

      public final String phoneNumberArn()

      The Amazon Resource Name (ARN) associated with the phone number.

      Returns:
      The Amazon Resource Name (ARN) associated with the phone number.

    • phoneNumberId

      public final String phoneNumberId()

      The unique identifier for the phone number.

      Returns:
      The unique identifier for the phone number.

    • phoneNumber

      public final String phoneNumber()

      The phone number in E.164 format.

      Returns:
      The phone number in E.164 format.

    • status

      public final NumberStatus status()

      The current status of the phone number.

      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 phone number.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the phone number.

      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 phone number.
      See Also:

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

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

    • numberCapabilities

      public final List<NumberCapability> numberCapabilities()

      Describes if the origination identity can be used for text messages, voice calls 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:
      Describes if the origination identity can be used for text messages, voice calls 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()

      Describes if the origination identity can be used for text messages, voice calls 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:
      Describes if the origination identity can be used for text messages, voice calls or both.

    • numberType

      public final NumberType numberType()

      The type of phone number.

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

      Returns:
      The type of phone number.
      See Also:

    • numberTypeAsString

      public final String numberTypeAsString()

      The type of phone number.

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

      Returns:
      The type of phone number.
      See Also:

    • monthlyLeasingPrice

      public final String monthlyLeasingPrice()

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

      Returns:
      The 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 using the TwoWayChannelArn.

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

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

      When set to false 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 request. For more information see Self-managed opt-outs

      Returns:
      When set to false 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 request. For more information see Self-managed opt-outs

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

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

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

    • toBuilder

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

    • builder

      public static PhoneNumberInformation.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.