Package software.amazon.awssdk.services.pinpoint.model

Interface NumberValidateResponse.Builder

    • Method Detail

      • carrier

        NumberValidateResponse.Builder carrier​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • city

        NumberValidateResponse.Builder city​(String city)

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

        Parameters:
        city - The name of the city where the phone number was originally registered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cleansedPhoneNumberE164

        NumberValidateResponse.Builder cleansedPhoneNumberE164​(String cleansedPhoneNumberE164)

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

        Parameters:
        cleansedPhoneNumberE164 - The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cleansedPhoneNumberNational

        NumberValidateResponse.Builder cleansedPhoneNumberNational​(String cleansedPhoneNumberNational)

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

        Parameters:
        cleansedPhoneNumberNational - The cleansed phone number, in the format for the location where the phone number was originally registered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • country

        NumberValidateResponse.Builder country​(String country)

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

        Parameters:
        country - The name of the country or region where the phone number was originally registered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • countryCodeIso2

        NumberValidateResponse.Builder countryCodeIso2​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • countryCodeNumeric

        NumberValidateResponse.Builder countryCodeNumeric​(String countryCodeNumeric)

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

        Parameters:
        countryCodeNumeric - The numeric code for the country or region where the phone number was originally registered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • county

        NumberValidateResponse.Builder county​(String county)

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

        Parameters:
        county - The name of the county where the phone number was originally registered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • originalCountryCodeIso2

        NumberValidateResponse.Builder originalCountryCodeIso2​(String originalCountryCodeIso2)

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

        Parameters:
        originalCountryCodeIso2 - The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • originalPhoneNumber

        NumberValidateResponse.Builder originalPhoneNumber​(String originalPhoneNumber)

        The phone number that was sent in the request body.

        Parameters:
        originalPhoneNumber - The phone number that was sent in the request body.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phoneType

        NumberValidateResponse.Builder phoneType​(String phoneType)

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

        Parameters:
        phoneType - The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phoneTypeCode

        NumberValidateResponse.Builder phoneTypeCode​(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).

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • timezone

        NumberValidateResponse.Builder timezone​(String timezone)

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

        Parameters:
        timezone - The time zone for the location where the phone number was originally registered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • zipCode

        NumberValidateResponse.Builder zipCode​(String zipCode)

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

        Parameters:
        zipCode - The postal or ZIP code for the location where the phone number was originally registered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.