Class NumberValidateResponse

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.NumberValidateResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NumberValidateResponse.Builder,NumberValidateResponse>
@Generated("software.amazon.awssdk:codegen") public final class NumberValidateResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NumberValidateResponse.Builder,NumberValidateResponse>

Provides information about a phone number.

See Also:

  • Method Details

    • carrier

      public final String carrier()

      The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

      Returns:
      The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

    • city

      public final String city()

      The name of the city where the phone number was originally registered.

      Returns:
      The name of the city where the phone number was originally registered.

    • cleansedPhoneNumberE164

      public final String cleansedPhoneNumberE164()

      The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

      Returns:
      The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

    • cleansedPhoneNumberNational

      public final String cleansedPhoneNumberNational()

      The cleansed phone number, in the format for the location where the phone number was originally registered.

      Returns:
      The cleansed phone number, in the format for the location where the phone number was originally registered.

    • country

      public final String country()

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

      Returns:
      The name of the country or region where the phone number was originally registered.

    • countryCodeIso2

      public final String countryCodeIso2()

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

      Returns:
      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

    • countryCodeNumeric

      public final 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 final String county()

      The name of the county where the phone number was originally registered.

      Returns:
      The name of the county where the phone number was originally registered.

    • originalCountryCodeIso2

      public final String originalCountryCodeIso2()

      The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

      Returns:
      The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

    • originalPhoneNumber

      public final String originalPhoneNumber()

      The phone number that was sent in the request body.

      Returns:
      The phone number that was sent in the request body.

    • phoneType

      public final String phoneType()

      The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

      Returns:
      The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

    • phoneTypeCode

      public final Integer phoneTypeCode()

      The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

      Returns:
      The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

    • timezone

      public final 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 final String zipCode()

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

      Returns:
      The postal or ZIP 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 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.