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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePhoneNumberOrder.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PhoneNumberOrder.Builderbuilder()InstantcreatedTimestamp()The phone number order creation time stamp, in ISO 8601 format.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasOrderedPhoneNumbers()For responses, this returns true if the service returned a value for the OrderedPhoneNumbers property.List<OrderedPhoneNumber>orderedPhoneNumbers()The ordered phone number details, such as the phone number in E.164 format and the phone number status.PhoneNumberOrderTypeorderType()The type of phone number being ordered, local or toll-free.StringorderTypeAsString()The type of phone number being ordered, local or toll-free.StringphoneNumberOrderId()The ID of the phone order.PhoneNumberProductTypeproductType()The phone number order product type.StringproductTypeAsString()The phone number order product type.List<SdkField<?>>sdkFields()static Class<? extends PhoneNumberOrder.Builder>serializableBuilderClass()PhoneNumberOrderStatusstatus()The status of the phone number order.StringstatusAsString()The status of the phone number order.PhoneNumberOrder.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedTimestamp()The updated phone number order time stamp, in ISO 8601 format.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
productTypewill returnPhoneNumberProductType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromproductTypeAsString().- Returns:
- The phone number order product type.
- See Also:
PhoneNumberProductType
-
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,
productTypewill returnPhoneNumberProductType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromproductTypeAsString().- Returns:
- The phone number order product type.
- See Also:
PhoneNumberProductType
-
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,
statuswill returnPhoneNumberOrderStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the phone number order.
- See Also:
PhoneNumberOrderStatus
-
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,
statuswill returnPhoneNumberOrderStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the phone number order.
- See Also:
PhoneNumberOrderStatus
-
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,
orderTypewill returnPhoneNumberOrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromorderTypeAsString().- Returns:
- The type of phone number being ordered, local or toll-free.
- See Also:
PhoneNumberOrderType
-
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,
orderTypewill returnPhoneNumberOrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromorderTypeAsString().- Returns:
- The type of phone number being ordered, local or toll-free.
- See Also:
PhoneNumberOrderType
-
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 theisEmpty()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.
-
toBuilder
public PhoneNumberOrder.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PhoneNumberOrder.Builder,PhoneNumberOrder>
-
builder
public static PhoneNumberOrder.Builder builder()
-
serializableBuilderClass
public static Class<? extends PhoneNumberOrder.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-