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

Interface ReleasePhoneNumberResponse.Builder

    • Method Detail

      • phoneNumberArn

        ReleasePhoneNumberResponse.Builder phoneNumberArn​(String phoneNumberArn)

        The PhoneNumberArn of the phone number that was released.

        Parameters:
        phoneNumberArn - The PhoneNumberArn of the phone number that was released.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phoneNumberId

        ReleasePhoneNumberResponse.Builder phoneNumberId​(String phoneNumberId)

        The PhoneNumberId of the phone number that was released.

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

      • phoneNumber

        ReleasePhoneNumberResponse.Builder phoneNumber​(String phoneNumber)

        The phone number that was released.

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

      • isoCountryCode

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

        ReleasePhoneNumberResponse.Builder messageType​(String messageType)

        The message type that was associated with the phone number.

        Parameters:
        messageType - The message type that was associated with the phone number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageType, MessageType

      • messageType

        ReleasePhoneNumberResponse.Builder messageType​(MessageType messageType)

        The message type that was associated with the phone number.

        Parameters:
        messageType - The message type that was associated with the phone number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageType, MessageType

      • numberCapabilitiesWithStrings

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

        Specifies if the number could be used for text messages, voice, or both.

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

      • numberCapabilitiesWithStrings

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

        Specifies if the number could be used for text messages, voice, or both.

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

      • numberCapabilities

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

        Specifies if the number could be used for text messages, voice, or both.

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

      • numberCapabilities

        ReleasePhoneNumberResponse.Builder numberCapabilities​(NumberCapability... numberCapabilities)

        Specifies if the number could be used for text messages, voice, or both.

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

      • numberType

        ReleasePhoneNumberResponse.Builder numberType​(String numberType)

        The type of number that was released.

        Parameters:
        numberType - The type of number that was released.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NumberType, NumberType

      • monthlyLeasingPrice

        ReleasePhoneNumberResponse.Builder monthlyLeasingPrice​(String monthlyLeasingPrice)

        The monthly price of the phone number, in US dollars.

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

      • twoWayEnabled

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

        ReleasePhoneNumberResponse.Builder twoWayChannelArn​(String twoWayChannelArn)

        The Amazon Resource Name (ARN) of the TwoWayChannel.

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

      • twoWayChannelRole

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

        ReleasePhoneNumberResponse.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, AWS End User Messaging SMS and Voice 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, AWS End User Messaging SMS and Voice 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

        ReleasePhoneNumberResponse.Builder optOutListName​(String optOutListName)

        The name of the OptOutList that was associated with the phone number.

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

      • registrationId

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

      • createdTimestamp

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