Class PhoneNumberOrder

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

The details of an Amazon Chime SDK phone number order.

See Also:

  • Method Details

    • phoneNumberOrderId

      public final String phoneNumberOrderId()

      The ID of the phone order.

      Returns:
      The ID of the phone order.

    • productType

      public final PhoneNumberProductType productType()

      The phone number order 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 order product type.
      See Also:

    • productTypeAsString

      public final String productTypeAsString()

      The phone number order 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 order product type.
      See Also:

    • status

      public final PhoneNumberOrderStatus status()

      The status of the phone number order.

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

      Returns:
      The status of the phone number order.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the phone number order.

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

      Returns:
      The status of the phone number order.
      See Also:

    • orderType

      public final PhoneNumberOrderType orderType()

      The type of phone number being ordered, local or toll-free.

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

      Returns:
      The type of phone number being ordered, local or toll-free.
      See Also:

    • orderTypeAsString

      public final String orderTypeAsString()

      The type of phone number being ordered, local or toll-free.

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

      Returns:
      The type of phone number being ordered, local or toll-free.
      See Also:

    • hasOrderedPhoneNumbers

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

    • orderedPhoneNumbers

      public final List<OrderedPhoneNumber> orderedPhoneNumbers()

      The ordered phone number details, such as the phone number in E.164 format and the phone number status.

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

      Returns:
      The ordered phone number details, such as the phone number in E.164 format and the phone number status.

    • createdTimestamp

      public final Instant createdTimestamp()

      The phone number order creation time stamp, in ISO 8601 format.

      Returns:
      The phone number order creation time stamp, in ISO 8601 format.

    • updatedTimestamp

      public final Instant updatedTimestamp()

      The updated phone number order time stamp, in ISO 8601 format.

      Returns:
      The updated phone number order time stamp, in ISO 8601 format.

    • focDate

      public final Instant focDate()

      The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order.

      Returns:
      The Firm Order Commitment (FOC) date for phone number porting orders. This field is null if a phone number order is not a porting order.

    • toBuilder

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

    • builder

      public static PhoneNumberOrder.Builder builder()

    • serializableBuilderClass

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