Class PhoneNumberStatus

java.lang.Object

software.amazon.awssdk.services.connect.model.PhoneNumberStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PhoneNumberStatus.Builder,PhoneNumberStatus>

@Generated("software.amazon.awssdk:codegen")
public final class PhoneNumberStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PhoneNumberStatus.Builder,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 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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PhoneNumberStatus.Builder

Method Summary

Modifier and Type	Method	Description
static PhoneNumberStatus.Builder	builder()
final boolean	equals(Object obj)
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 String	message()	The status message.
final List<SdkField<?>>	sdkFields()
static Class<? extends PhoneNumberStatus.Builder>	serializableBuilderClass()
final PhoneNumberWorkflowStatus	status()	The status.
final String	statusAsString()	The status.
PhoneNumberStatus.Builder	toBuilder()	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

status

public final PhoneNumberWorkflowStatus status()

The status.

If the service returns an enum value that is not available in the current SDK version, status will return PhoneNumberWorkflowStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status.

See Also:

• PhoneNumberWorkflowStatus

statusAsString

public final String statusAsString()

The status.

If the service returns an enum value that is not available in the current SDK version, status will return PhoneNumberWorkflowStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status.

See Also:

• PhoneNumberWorkflowStatus

message

public final String message()

The status message.

Returns:

The status message.

toBuilder

public PhoneNumberStatus.Builder 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 interface ToCopyableBuilder<PhoneNumberStatus.Builder,PhoneNumberStatus>

Returns:

a builder for type T

builder

public static PhoneNumberStatus.Builder builder()

serializableBuilderClass

public static Class<? extends PhoneNumberStatus.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)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.