Class SMSSandboxPhoneNumber

java.lang.Object

software.amazon.awssdk.services.sns.model.SMSSandboxPhoneNumber

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class SMSSandboxPhoneNumber
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SMSSandboxPhoneNumber.Builder,SMSSandboxPhoneNumber>

A verified or pending destination phone number in the SMS sandbox.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SMSSandboxPhoneNumber.Builder

Method Summary

Modifier and Type	Method	Description
static SMSSandboxPhoneNumber.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	phoneNumber()	The destination phone number.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends SMSSandboxPhoneNumber.Builder>	serializableBuilderClass()
final SMSSandboxPhoneNumberVerificationStatus	status()	The destination phone number's verification status.
final String	statusAsString()	The destination phone number's verification status.
SMSSandboxPhoneNumber.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

phoneNumber

public final String phoneNumber()

The destination phone number.

Returns:

The destination phone number.

status

public final SMSSandboxPhoneNumberVerificationStatus status()

The destination phone number's verification status.

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

Returns:

The destination phone number's verification status.

See Also:

• SMSSandboxPhoneNumberVerificationStatus

statusAsString

public final String statusAsString()

The destination phone number's verification status.

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

Returns:

The destination phone number's verification status.

See Also:

• SMSSandboxPhoneNumberVerificationStatus

toBuilder

public SMSSandboxPhoneNumber.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<SMSSandboxPhoneNumber.Builder,SMSSandboxPhoneNumber>

Returns:

a builder for type T

builder

public static SMSSandboxPhoneNumber.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.