Class ClaimedPhoneNumberSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClaimedPhoneNumberSummary.Builder,
ClaimedPhoneNumberSummary>
Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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 int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The identifier of the Amazon Connect instance that phone numbers are claimed to.final String
The phone number.final String
The Amazon Resource Name (ARN) of the phone number.final PhoneNumberCountryCode
The ISO country code.final String
The ISO country code.final String
The description of the phone number.final String
A unique identifier for the phone number.final PhoneNumberStatus
The status of the phone number.final PhoneNumberType
The type of phone number.final String
The type of phone number.static Class
<? extends ClaimedPhoneNumberSummary.Builder> final String
The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint.tags()
The tags used to organize, track, or control access for this resource.final String
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
phoneNumberId
A unique identifier for the phone number.
- Returns:
- A unique identifier for the phone number.
-
phoneNumberArn
The Amazon Resource Name (ARN) of the phone number.
- Returns:
- The Amazon Resource Name (ARN) of the phone number.
-
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
The ISO country code.
If the service returns an enum value that is not available in the current SDK version,
phoneNumberCountryCode
will returnPhoneNumberCountryCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphoneNumberCountryCodeAsString()
.- Returns:
- The ISO country code.
- See Also:
-
phoneNumberCountryCodeAsString
The ISO country code.
If the service returns an enum value that is not available in the current SDK version,
phoneNumberCountryCode
will returnPhoneNumberCountryCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphoneNumberCountryCodeAsString()
.- Returns:
- The ISO country code.
- See Also:
-
phoneNumberType
The type of phone number.
If the service returns an enum value that is not available in the current SDK version,
phoneNumberType
will returnPhoneNumberType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphoneNumberTypeAsString()
.- Returns:
- The type of phone number.
- See Also:
-
phoneNumberTypeAsString
The type of phone number.
If the service returns an enum value that is not available in the current SDK version,
phoneNumberType
will returnPhoneNumberType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphoneNumberTypeAsString()
.- Returns:
- The type of phone number.
- See Also:
-
phoneNumberDescription
The description of the phone number.
- Returns:
- The description of the phone number.
-
targetArn
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
- Returns:
- The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
-
instanceId
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Returns:
- The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
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 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. -
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
The status of the phone number.
-
CLAIMED
means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded. -
IN_PROGRESS
means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata 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 ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that theTargetArn
value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received aFAILED
status from aClaimPhoneNumber
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 ClaimPhoneNumber or UpdatePhoneNumber operation succeeded. -
IN_PROGRESS
means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata 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 ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that theTargetArn
value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received aFAILED
status from aClaimPhoneNumber
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.
-
-
-
sourcePhoneNumberArn
The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
- Returns:
- The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
-
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<ClaimedPhoneNumberSummary.Builder,
ClaimedPhoneNumberSummary> - 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
-