Class PhoneNumber

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

A phone number used to call an Amazon Chime SDK Voice Connector.

See Also:

  • Method Details

    • phoneNumberId

      public final String phoneNumberId()

      The phone number's ID.

      Returns:
      The phone number's ID.

    • e164PhoneNumber

      public final String e164PhoneNumber()

      The phone number, in E.164 format.

      Returns:
      The phone number, in E.164 format.

    • country

      public final String country()

      The phone number's country. Format: ISO 3166-1 alpha-2.

      Returns:
      The phone number's country. Format: ISO 3166-1 alpha-2.

    • type

      public final PhoneNumberType type()

      The phone number's type.

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

      Returns:
      The phone number's type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The phone number's type.

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

      Returns:
      The phone number's type.
      See Also:

    • productType

      public final PhoneNumberProductType productType()

      The phone number's product type.

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

      Returns:
      The phone number's product type.
      See Also:

    • productTypeAsString

      public final String productTypeAsString()

      The phone number's product type.

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

      Returns:
      The phone number's product type.
      See Also:

    • status

      public final PhoneNumberStatus status()

      The phone number's status.

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

      Returns:
      The phone number's status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The phone number's status.

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

      Returns:
      The phone number's status.
      See Also:

    • capabilities

      public final PhoneNumberCapabilities capabilities()

      The phone number's capabilities.

      Returns:
      The phone number's capabilities.

    • hasAssociations

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

    • associations

      public final List<PhoneNumberAssociation> associations()

      The phone number's associations.

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

      Returns:
      The phone number's associations.

    • callingName

      public final String callingName()

      The outbound calling name associated with the phone number.

      Returns:
      The outbound calling name associated with the phone number.

    • callingNameStatus

      public final CallingNameStatus callingNameStatus()

      The outbound calling name status.

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

      Returns:
      The outbound calling name status.
      See Also:

    • callingNameStatusAsString

      public final String callingNameStatusAsString()

      The outbound calling name status.

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

      Returns:
      The outbound calling name status.
      See Also:

    • createdTimestamp

      public final Instant createdTimestamp()

      The phone number creation timestamp, in ISO 8601 format.

      Returns:
      The phone number creation timestamp, in ISO 8601 format.

    • updatedTimestamp

      public final Instant updatedTimestamp()

      The updated phone number timestamp, in ISO 8601 format.

      Returns:
      The updated phone number timestamp, in ISO 8601 format.

    • deletionTimestamp

      public final Instant deletionTimestamp()

      The deleted phone number timestamp, in ISO 8601 format.

      Returns:
      The deleted phone number timestamp, in ISO 8601 format.

    • orderId

      public final String orderId()

      The phone number's order ID.

      Returns:
      The phone number's order ID.

    • name

      public final String name()

      The name of the phone number.

      Returns:
      The name of the phone number.

    • toBuilder

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

    • builder

      public static PhoneNumber.Builder builder()

    • serializableBuilderClass

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