Class PhoneNumber
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PhoneNumber.Builder,
PhoneNumber>
A phone number used to call an Amazon Chime SDK Voice Connector.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<PhoneNumberAssociation> The phone number's associations.static PhoneNumber.Builder
builder()
final String
The outbound calling name associated with the phone number.final CallingNameStatus
The outbound calling name status.final String
The outbound calling name status.final PhoneNumberCapabilities
The phone number's capabilities.final String
country()
The phone number's country.final Instant
The phone number creation timestamp, in ISO 8601 format.final Instant
The deleted phone number timestamp, in ISO 8601 format.final String
The phone number, in E.164 format.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Associations property.final int
hashCode()
final String
name()
The name of the phone number.final String
orderId()
The phone number's order ID.final String
The phone number's ID.final PhoneNumberProductType
The phone number's product type.final String
The phone number's product type.static Class
<? extends PhoneNumber.Builder> final PhoneNumberStatus
status()
The phone number's status.final String
The phone number's status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final PhoneNumberType
type()
The phone number's type.final String
The phone number's type.final Instant
The updated phone number timestamp, in ISO 8601 format.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
phoneNumberId
The phone number's ID.
- Returns:
- The phone number's ID.
-
e164PhoneNumber
The phone number, in E.164 format.
- Returns:
- The phone number, in E.164 format.
-
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
The phone number's type.
If the service returns an enum value that is not available in the current SDK version,
type
will returnPhoneNumberType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The phone number's type.
- See Also:
-
typeAsString
The phone number's type.
If the service returns an enum value that is not available in the current SDK version,
type
will returnPhoneNumberType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The phone number's type.
- See Also:
-
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 returnPhoneNumberProductType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproductTypeAsString()
.- Returns:
- The phone number's product type.
- See Also:
-
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 returnPhoneNumberProductType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproductTypeAsString()
.- Returns:
- The phone number's product type.
- See Also:
-
status
The phone number's status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnPhoneNumberStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The phone number's status.
- See Also:
-
statusAsString
The phone number's status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnPhoneNumberStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The phone number's status.
- See Also:
-
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 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. -
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
The outbound calling name associated with the phone number.
- Returns:
- The outbound calling name associated with the phone number.
-
callingNameStatus
The outbound calling name status.
If the service returns an enum value that is not available in the current SDK version,
callingNameStatus
will returnCallingNameStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcallingNameStatusAsString()
.- Returns:
- The outbound calling name status.
- See Also:
-
callingNameStatusAsString
The outbound calling name status.
If the service returns an enum value that is not available in the current SDK version,
callingNameStatus
will returnCallingNameStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcallingNameStatusAsString()
.- Returns:
- The outbound calling name status.
- See Also:
-
createdTimestamp
The phone number creation timestamp, in ISO 8601 format.
- Returns:
- The phone number creation timestamp, in ISO 8601 format.
-
updatedTimestamp
The updated phone number timestamp, in ISO 8601 format.
- Returns:
- The updated phone number timestamp, in ISO 8601 format.
-
deletionTimestamp
The deleted phone number timestamp, in ISO 8601 format.
- Returns:
- The deleted phone number timestamp, in ISO 8601 format.
-
orderId
The phone number's order ID.
- Returns:
- The phone number's order ID.
-
name
The name of the phone number.
- Returns:
- The name of the phone number.
-
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 interfaceToCopyableBuilder<PhoneNumber.Builder,
PhoneNumber> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-