software.amazon.awssdk.services.pinpoint.model

Class NumberValidateResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.NumberValidateResponse

All Implemented Interfaces:

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

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

Phone Number Validate response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NumberValidateResponse.Builder

Method Summary

Modifier and Type	Method and Description
static NumberValidateResponse.Builder	builder()
String	carrier() The carrier or servive provider that the phone number is currently registered with.
String	city() The city where the phone number was originally registered.
String	cleansedPhoneNumberE164() The cleansed phone number, shown in E.164 format.
String	cleansedPhoneNumberNational() The cleansed phone number, shown in the local phone number format.
String	country() The country or region where the phone number was originally registered.
String	countryCodeIso2() The two-character ISO code for the country or region where the phone number was originally registered.
String	countryCodeNumeric() The numeric code for the country or region where the phone number was originally registered.
String	county() The county where the phone number was originally registered.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	originalCountryCodeIso2() The two-character code (in ISO 3166-1 alpha-2 format) for the country or region in the request body.
String	originalPhoneNumber() The phone number that you included in the request body.
String	phoneType() A description of the phone type.
Integer	phoneTypeCode() The phone type, represented by an integer.
List<SdkField<?>>	sdkFields()
static Class<? extends NumberValidateResponse.Builder>	serializableBuilderClass()
String	timezone() The time zone for the location where the phone number was originally registered.
NumberValidateResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	zipCode() The postal code for the location where the phone number was originally registered.

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 Detail

carrier

public String carrier()

The carrier or servive provider that the phone number is currently registered with.

Returns:

The carrier or servive provider that the phone number is currently registered with.

city

public String city()

The city where the phone number was originally registered.

Returns:

The city where the phone number was originally registered.

cleansedPhoneNumberE164

public String cleansedPhoneNumberE164()

The cleansed phone number, shown in E.164 format.

Returns:

The cleansed phone number, shown in E.164 format.

cleansedPhoneNumberNational

public String cleansedPhoneNumberNational()

The cleansed phone number, shown in the local phone number format.

Returns:

The cleansed phone number, shown in the local phone number format.

country

public String country()

The country or region where the phone number was originally registered.

Returns:

The country or region where the phone number was originally registered.

countryCodeIso2

public String countryCodeIso2()

The two-character ISO code for the country or region where the phone number was originally registered.

Returns:

The two-character ISO code for the country or region where the phone number was originally registered.

countryCodeNumeric

public String countryCodeNumeric()

The numeric code for the country or region where the phone number was originally registered.

Returns:

The numeric code for the country or region where the phone number was originally registered.

county

public String county()

The county where the phone number was originally registered.

Returns:

The county where the phone number was originally registered.

originalCountryCodeIso2

public String originalCountryCodeIso2()

The two-character code (in ISO 3166-1 alpha-2 format) for the country or region in the request body.

Returns:

The two-character code (in ISO 3166-1 alpha-2 format) for the country or region in the request body.

originalPhoneNumber

public String originalPhoneNumber()

The phone number that you included in the request body.

Returns:

The phone number that you included in the request body.

phoneType

public String phoneType()

A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

Returns:

A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

phoneTypeCode

public Integer phoneTypeCode()

The phone type, represented by an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID).

Returns:

The phone type, represented by an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID).

timezone

public String timezone()

The time zone for the location where the phone number was originally registered.

Returns:

The time zone for the location where the phone number was originally registered.

zipCode

public String zipCode()

The postal code for the location where the phone number was originally registered.

Returns:

The postal code for the location where the phone number was originally registered.

toBuilder

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

Returns:

a builder for type T

builder

public static NumberValidateResponse.Builder builder()

serializableBuilderClass

public static Class<? extends NumberValidateResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.