Package software.amazon.awssdk.services.connect.model

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()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	message()	The status message.
List<SdkField<?>>	sdkFields()
static Class<? extends PhoneNumberStatus.Builder>	serializableBuilderClass()
PhoneNumberWorkflowStatus	status()	The status.
String	statusAsString()	The status.
PhoneNumberStatus.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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<PhoneNumberStatus.Builder,PhoneNumberStatus>

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)

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