Interface SendNotifyTextMessageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SendNotifyTextMessageRequest.Builder,SendNotifyTextMessageRequest>, PinpointSmsVoiceV2Request.Builder, SdkBuilder<SendNotifyTextMessageRequest.Builder,SendNotifyTextMessageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SendNotifyTextMessageRequest
@Mutable @NotThreadSafe public static interface SendNotifyTextMessageRequest.Builder extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<SendNotifyTextMessageRequest.Builder,SendNotifyTextMessageRequest>

  • Method Details

    • notifyConfigurationId

      SendNotifyTextMessageRequest.Builder notifyConfigurationId(String notifyConfigurationId)

      The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.

      Parameters:
      notifyConfigurationId - The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationPhoneNumber

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

    • templateId

      SendNotifyTextMessageRequest.Builder templateId(String templateId)

      The unique identifier of the template to use for the message.

      Parameters:
      templateId - The unique identifier of the template to use for the message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateVariables

      SendNotifyTextMessageRequest.Builder templateVariables(Map<String,String> templateVariables)

      A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".

      Parameters:
      templateVariables - A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeToLive

      SendNotifyTextMessageRequest.Builder timeToLive(Integer timeToLive)

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

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

    • context

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

    • configurationSetName

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

    • dryRun

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

    • messageFeedbackEnabled

      SendNotifyTextMessageRequest.Builder messageFeedbackEnabled(Boolean messageFeedbackEnabled)

      Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.

      Parameters:
      messageFeedbackEnabled - Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SendNotifyTextMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SendNotifyTextMessageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.