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

Interface PhoneNumberInformation.Builder

    • Method Detail

      • phoneNumberArn

        PhoneNumberInformation.Builder phoneNumberArn​(String phoneNumberArn)

        The Amazon Resource Name (ARN) associated with the phone number.

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

      • phoneNumberId

        PhoneNumberInformation.Builder phoneNumberId​(String phoneNumberId)

        The unique identifier for the phone number.

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

      • phoneNumber

        PhoneNumberInformation.Builder phoneNumber​(String phoneNumber)

        The phone number in E.164 format.

        Parameters:
        phoneNumber - The phone number in E.164 format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isoCountryCode

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

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

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

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

        Describes if the origination identity can be used for text messages, voice calls or both.

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

      • numberCapabilitiesWithStrings

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

        Describes if the origination identity can be used for text messages, voice calls or both.

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

      • numberCapabilities

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

        Describes if the origination identity can be used for text messages, voice calls or both.

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

      • numberCapabilities

        PhoneNumberInformation.Builder numberCapabilities​(NumberCapability... numberCapabilities)

        Describes if the origination identity can be used for text messages, voice calls or both.

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

      • monthlyLeasingPrice

        PhoneNumberInformation.Builder monthlyLeasingPrice​(String monthlyLeasingPrice)

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

        Parameters:
        monthlyLeasingPrice - The 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

        PhoneNumberInformation.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 using the TwoWayChannelArn.

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

      • twoWayChannelArn

        PhoneNumberInformation.Builder twoWayChannelArn​(String twoWayChannelArn)

        The Amazon Resource Name (ARN) of the two way channel.

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

      • twoWayChannelRole

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

        PhoneNumberInformation.Builder selfManagedOptOutsEnabled​(Boolean selfManagedOptOutsEnabled)

        When set to false 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 request. For more information see Self-managed opt-outs

        Parameters:
        selfManagedOptOutsEnabled - When set to false 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 request. For more information see Self-managed opt-outs
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optOutListName

        PhoneNumberInformation.Builder optOutListName​(String optOutListName)

        The name of the OptOutList associated with the phone number.

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

      • deletionProtectionEnabled

        PhoneNumberInformation.Builder deletionProtectionEnabled​(Boolean deletionProtectionEnabled)

        When set to true the phone number can't be deleted.

        Parameters:
        deletionProtectionEnabled - 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

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

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

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