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

Interface SendTextMessageRequest.Builder

    • Method Detail

      • destinationPhoneNumber

        SendTextMessageRequest.Builder destinationPhoneNumber​(String destinationPhoneNumber)

        The destination phone number in E.164 format.

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

      • originationIdentity

        SendTextMessageRequest.Builder originationIdentity​(String originationIdentity)

        The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

        Parameters:
        originationIdentity - The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageBody

        SendTextMessageRequest.Builder messageBody​(String messageBody)

        The body of the text message.

        Parameters:
        messageBody - The body of the text message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageType

        SendTextMessageRequest.Builder messageType​(String messageType)

        The type of message. Valid values are 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 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

        SendTextMessageRequest.Builder messageType​(MessageType messageType)

        The type of message. Valid values are 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 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

      • keyword

        SendTextMessageRequest.Builder keyword​(String keyword)

        When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

        Parameters:
        keyword - When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • configurationSetName

        SendTextMessageRequest.Builder configurationSetName​(String configurationSetName)

        The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

        Parameters:
        configurationSetName - The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxPrice

        SendTextMessageRequest.Builder maxPrice​(String maxPrice)

        The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

        Parameters:
        maxPrice - The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeToLive

        SendTextMessageRequest.Builder timeToLive​(Integer timeToLive)

        How long the text message is valid for. By default this is 72 hours.

        Parameters:
        timeToLive - How long the text message is valid for. By default this is 72 hours.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • context

        SendTextMessageRequest.Builder context​(Map<String,​String> context)

        You can specify custom data in this field. If you do, that data is logged to the event destination.

        Parameters:
        context - You can specify custom data in this field. If you do, that data is logged to the event destination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dryRun

        SendTextMessageRequest.Builder dryRun​(Boolean dryRun)

        When set to true, the message is checked and validated, but isn't sent to the end recipient.

        Parameters:
        dryRun - When set to true, the message is checked and validated, but isn't sent to the end recipient.
        Returns:
        Returns a reference to this object so that method calls can be chained together.