PhoneNumber (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.chime.model.PhoneNumber

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PhoneNumber.Builder,PhoneNumber>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class PhoneNumber
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PhoneNumber.Builder,PhoneNumber>
```
A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PhoneNumber.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PhoneNumber.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<PhoneNumberAssociation>`	`associations()` The phone number associations.
`static PhoneNumber.Builder`	`builder()`
`String`	`callingName()` The outbound calling name associated with the phone number.
`CallingNameStatus`	`callingNameStatus()` The outbound calling name status.
`String`	`callingNameStatusAsString()` The outbound calling name status.
`PhoneNumberCapabilities`	`capabilities()` The phone number capabilities.
`String`	`country()` The phone number country.
`Instant`	`createdTimestamp()` The phone number creation timestamp, in ISO 8601 format.
`Instant`	`deletionTimestamp()` The deleted phone number timestamp, in ISO 8601 format.
`String`	`e164PhoneNumber()` The phone number, in E.164 format.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAssociations()` For responses, this returns true if the service returned a value for the Associations property.
`int`	`hashCode()`
`String`	`phoneNumberId()` The phone number ID.
`PhoneNumberProductType`	`productType()` The phone number product type.
`String`	`productTypeAsString()` The phone number product type.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PhoneNumber.Builder>`	`serializableBuilderClass()`
`PhoneNumberStatus`	`status()` The phone number status.
`String`	`statusAsString()` The phone number status.
`PhoneNumber.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`PhoneNumberType`	`type()` The phone number type.
`String`	`typeAsString()` The phone number type.
`Instant`	`updatedTimestamp()` The updated phone number timestamp, 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
  - phoneNumberId
```
public final String phoneNumberId()
```
    The phone number ID.
    
    Returns:
    
    The phone number 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 country. Format: ISO 3166-1 alpha-2.
    
    Returns:
    
    The phone number country. Format: ISO 3166-1 alpha-2.
  - type
```
public final PhoneNumberType type()
```
    The phone number 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 type.
    
    See Also:
    
    PhoneNumberType
  - typeAsString
```
public final String typeAsString()
```
    The phone number 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 type.
    
    See Also:
    
    PhoneNumberType
  - productType
```
public final PhoneNumberProductType productType()
```
    The phone number 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 product type.
    
    See Also:
    
    PhoneNumberProductType
  - productTypeAsString
```
public final String productTypeAsString()
```
    The phone number 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 product type.
    
    See Also:
    
    PhoneNumberProductType
  - status
```
public final PhoneNumberStatus status()
```
    The phone number 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 status.
    
    See Also:
    
    PhoneNumberStatus
  - statusAsString
```
public final String statusAsString()
```
    The phone number 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 status.
    
    See Also:
    
    PhoneNumberStatus
  - capabilities
```
public final PhoneNumberCapabilities capabilities()
```
    The phone number capabilities.
    
    Returns:
    
    The phone number 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 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 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:
    
    CallingNameStatus
  - 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:
    
    CallingNameStatus
  - 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.
  - toBuilder
```
public PhoneNumber.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PhoneNumber.Builder,PhoneNumber>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class PhoneNumber

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

phoneNumberId

e164PhoneNumber

country

type

typeAsString

productType

productTypeAsString

status

statusAsString

capabilities

hasAssociations

associations

callingName

callingNameStatus

callingNameStatusAsString

createdTimestamp

updatedTimestamp

deletionTimestamp

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields