Class CarrierLookupResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response
software.amazon.awssdk.services.pinpointsmsvoicev2.model.CarrierLookupResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CarrierLookupResponse.Builder,CarrierLookupResponse>
@Generated("software.amazon.awssdk:codegen") public final class CarrierLookupResponse extends PinpointSmsVoiceV2Response implements ToCopyableBuilder<CarrierLookupResponse.Builder,CarrierLookupResponse>

  • Method Details

    • e164PhoneNumber

      public final String e164PhoneNumber()

      The phone number in E164 format, sanitized from the original input by removing any formatting characters.

      Returns:
      The phone number in E164 format, sanitized from the original input by removing any formatting characters.

    • dialingCountryCode

      public final String dialingCountryCode()

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

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

    • isoCountryCode

      public final String isoCountryCode()

      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.

    • country

      public final String country()

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

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

    • mcc

      public final String mcc()

      The phone number's mobile country code, for mobile phone number types

      Returns:
      The phone number's mobile country code, for mobile phone number types

    • mnc

      public final String mnc()

      The phone number's mobile network code, for mobile phone number types.

      Returns:
      The phone number's mobile network code, for mobile phone number types.

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

    • phoneNumberType

      public final PhoneNumberType phoneNumberType()

      Describes the type of phone number. Valid values are: MOBILE, LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone numbers, as these numbers are unlikely to belong to actual recipients.

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

      Returns:
      Describes the type of phone number. Valid values are: MOBILE, LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone numbers, as these numbers are unlikely to belong to actual recipients.
      See Also:

    • phoneNumberTypeAsString

      public final String phoneNumberTypeAsString()

      Describes the type of phone number. Valid values are: MOBILE, LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone numbers, as these numbers are unlikely to belong to actual recipients.

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

      Returns:
      Describes the type of phone number. Valid values are: MOBILE, LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone numbers, as these numbers are unlikely to belong to actual recipients.
      See Also:

    • toBuilder

      public CarrierLookupResponse.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<CarrierLookupResponse.Builder,CarrierLookupResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CarrierLookupResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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