Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Interface RequestPhoneNumberResponse.Builder

    • Method Detail

      • phoneNumberArn

        RequestPhoneNumberResponse.Builder phoneNumberArn​(String phoneNumberArn)

        The Amazon Resource Name (ARN) of the requested phone number.

        Parameters:
        phoneNumberArn - The Amazon Resource Name (ARN) of the requested phone number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phoneNumberId

        RequestPhoneNumberResponse.Builder phoneNumberId​(String phoneNumberId)

        The unique identifier of the new phone number.

        Parameters:
        phoneNumberId - The unique identifier of the new phone number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phoneNumber

        RequestPhoneNumberResponse.Builder phoneNumber​(String phoneNumber)

        The new phone number that was requested.

        Parameters:
        phoneNumber - The new phone number that was requested.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isoCountryCode

        RequestPhoneNumberResponse.Builder isoCountryCode​(String isoCountryCode)

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

        Parameters:
        isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageType

        RequestPhoneNumberResponse.Builder messageType​(String messageType)

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

        Parameters:
        messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageType, MessageType

      • messageType

        RequestPhoneNumberResponse.Builder messageType​(MessageType messageType)

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

        Parameters:
        messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageType, MessageType

      • numberCapabilitiesWithStrings

        RequestPhoneNumberResponse.Builder numberCapabilitiesWithStrings​(Collection<String> numberCapabilities)

        Indicates if the phone number will be used for text messages, voice messages or both.

        Parameters:
        numberCapabilities - Indicates if the phone number will be used for text messages, voice messages or both.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • numberCapabilitiesWithStrings

        RequestPhoneNumberResponse.Builder numberCapabilitiesWithStrings​(String... numberCapabilities)

        Indicates if the phone number will be used for text messages, voice messages or both.

        Parameters:
        numberCapabilities - Indicates if the phone number will be used for text messages, voice messages or both.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • numberCapabilities

        RequestPhoneNumberResponse.Builder numberCapabilities​(Collection<NumberCapability> numberCapabilities)

        Indicates if the phone number will be used for text messages, voice messages or both.

        Parameters:
        numberCapabilities - Indicates if the phone number will be used for text messages, voice messages or both.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • numberCapabilities

        RequestPhoneNumberResponse.Builder numberCapabilities​(NumberCapability... numberCapabilities)

        Indicates if the phone number will be used for text messages, voice messages or both.

        Parameters:
        numberCapabilities - Indicates if the phone number will be used for text messages, voice messages or both.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • monthlyLeasingPrice

        RequestPhoneNumberResponse.Builder monthlyLeasingPrice​(String monthlyLeasingPrice)

        The monthly price, in US dollars, to lease the phone number.

        Parameters:
        monthlyLeasingPrice - The monthly price, in US dollars, to lease the phone number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • twoWayEnabled

        RequestPhoneNumberResponse.Builder twoWayEnabled​(Boolean twoWayEnabled)

        By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

        Parameters:
        twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • twoWayChannelArn

        RequestPhoneNumberResponse.Builder twoWayChannelArn​(String twoWayChannelArn)

        The ARN used to identify the two way channel.

        Parameters:
        twoWayChannelArn - The ARN used to identify the two way channel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • twoWayChannelRole

        RequestPhoneNumberResponse.Builder twoWayChannelRole​(String twoWayChannelRole)

        An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

        Parameters:
        twoWayChannelRole - An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selfManagedOptOutsEnabled

        RequestPhoneNumberResponse.Builder selfManagedOptOutsEnabled​(Boolean selfManagedOptOutsEnabled)

        By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

        Parameters:
        selfManagedOptOutsEnabled - By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optOutListName

        RequestPhoneNumberResponse.Builder optOutListName​(String optOutListName)

        The name of the OptOutList that is associated with the requested phone number.

        Parameters:
        optOutListName - The name of the OptOutList that is associated with the requested phone number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtectionEnabled

        RequestPhoneNumberResponse.Builder deletionProtectionEnabled​(Boolean deletionProtectionEnabled)

        By default this is set to false. When set to true the phone number can't be deleted.

        Parameters:
        deletionProtectionEnabled - By default this is set to false. When set to true the phone number can't be deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • poolId

        RequestPhoneNumberResponse.Builder poolId​(String poolId)

        The unique identifier of the pool associated with the phone number

        Parameters:
        poolId - The unique identifier of the pool associated with the phone number
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • registrationId

        RequestPhoneNumberResponse.Builder registrationId​(String registrationId)

        The unique identifier for the registration.

        Parameters:
        registrationId - The unique identifier for the registration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        RequestPhoneNumberResponse.Builder tags​(Collection<Tag> tags)

        An array of key and value pair tags that are associated with the phone number.

        Parameters:
        tags - An array of key and value pair tags that are associated with the phone number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        RequestPhoneNumberResponse.Builder tags​(Tag... tags)

        An array of key and value pair tags that are associated with the phone number.

        Parameters:
        tags - An array of key and value pair tags that are associated with the phone number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        RequestPhoneNumberResponse.Builder tags​(Consumer<Tag.Builder>... tags)

        An array of key and value pair tags that are associated with the phone number.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • createdTimestamp

        RequestPhoneNumberResponse.Builder createdTimestamp​(Instant createdTimestamp)

        The time when the phone number was created, in UNIX epoch time format.

        Parameters:
        createdTimestamp - The time when the phone number was created, in UNIX epoch time format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.