ClaimedPhoneNumberSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.connect.model.ClaimedPhoneNumberSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClaimedPhoneNumberSummary.Builder,ClaimedPhoneNumberSummary>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ClaimedPhoneNumberSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClaimedPhoneNumberSummary.Builder,ClaimedPhoneNumberSummary>
```
Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ClaimedPhoneNumberSummary.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ClaimedPhoneNumberSummary.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`phoneNumber()` The phone number.
`String`	`phoneNumberArn()` The Amazon Resource Name (ARN) of the phone number.
`PhoneNumberCountryCode`	`phoneNumberCountryCode()` The ISO country code.
`String`	`phoneNumberCountryCodeAsString()` The ISO country code.
`String`	`phoneNumberDescription()` The description of the phone number.
`String`	`phoneNumberId()` A unique identifier for the phone number.
`PhoneNumberStatus`	`phoneNumberStatus()` The status of the phone number.
`PhoneNumberType`	`phoneNumberType()` The type of phone number.
`String`	`phoneNumberTypeAsString()` The type of phone number.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ClaimedPhoneNumberSummary.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tags used to organize, track, or control access for this resource.
`String`	`targetArn()` The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
`ClaimedPhoneNumberSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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()
```
    A unique identifier for the phone number.
    
    Returns:
    
    A unique identifier for the phone number.
  - phoneNumberArn
```
public final String phoneNumberArn()
```
    The Amazon Resource Name (ARN) of the phone number.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the phone number.
  - phoneNumber
```
public final String phoneNumber()
```
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    
    Returns:
    
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
  - phoneNumberCountryCode
```
public final PhoneNumberCountryCode phoneNumberCountryCode()
```
    The ISO country code.
    
    If the service returns an enum value that is not available in the current SDK version, phoneNumberCountryCode will return PhoneNumberCountryCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phoneNumberCountryCodeAsString().
    
    Returns:
    
    The ISO country code.
    
    See Also:
    
    PhoneNumberCountryCode
  - phoneNumberCountryCodeAsString
```
public final String phoneNumberCountryCodeAsString()
```
    The ISO country code.
    
    If the service returns an enum value that is not available in the current SDK version, phoneNumberCountryCode will return PhoneNumberCountryCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phoneNumberCountryCodeAsString().
    
    Returns:
    
    The ISO country code.
    
    See Also:
    
    PhoneNumberCountryCode
  - phoneNumberType
```
public final PhoneNumberType phoneNumberType()
```
    The type of phone number.
    
    If the service returns an enum value that is not available in the current SDK version, phoneNumberType will return PhoneNumberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phoneNumberTypeAsString().
    
    Returns:
    
    The type of phone number.
    
    See Also:
    
    PhoneNumberType
  - phoneNumberTypeAsString
```
public final String phoneNumberTypeAsString()
```
    The type of phone number.
    
    If the service returns an enum value that is not available in the current SDK version, phoneNumberType will return PhoneNumberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phoneNumberTypeAsString().
    
    Returns:
    
    The type of phone number.
    
    See Also:
    
    PhoneNumberType
  - phoneNumberDescription
```
public final String phoneNumberDescription()
```
    The description of the phone number.
    
    Returns:
    
    The description of the phone number.
  - targetArn
```
public final String targetArn()
```
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
    
    Returns:
    
    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final Map<String,String> tags()
```
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
    
    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 hasTags() method.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
  - phoneNumberStatus
```
public final PhoneNumberStatus phoneNumberStatus()
```
    The status of the phone number.
    - CLAIMED means the previous ClaimedPhoneNumber or UpdatePhoneNumber operation succeeded.
    - IN_PROGRESS means a ClaimedPhoneNumber or UpdatePhoneNumber operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
    - FAILED indicates that the previous ClaimedPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
    You will not be billed for the phone number during the 1-day period if number claiming fails.
    Returns:
    The status of the phone number.
    
    CLAIMED means the previous ClaimedPhoneNumber or UpdatePhoneNumber operation succeeded.
    
    IN_PROGRESS means a ClaimedPhoneNumber or UpdatePhoneNumber operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.
    
    FAILED indicates that the previous ClaimedPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.
    
    You will not be billed for the phone number during the 1-day period if number claiming fails.
  - toBuilder
```
public ClaimedPhoneNumberSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ClaimedPhoneNumberSummary.Builder,ClaimedPhoneNumberSummary>
  - builder
```
public static ClaimedPhoneNumberSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ClaimedPhoneNumberSummary.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 ClaimedPhoneNumberSummary

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

phoneNumberArn

phoneNumber

phoneNumberCountryCode

phoneNumberCountryCodeAsString

phoneNumberType

phoneNumberTypeAsString

phoneNumberDescription

targetArn

hasTags

tags

phoneNumberStatus

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields