Interface VoiceTemplateRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<VoiceTemplateRequest.Builder,VoiceTemplateRequest>, SdkBuilder<VoiceTemplateRequest.Builder,VoiceTemplateRequest>, SdkPojo
Enclosing class:
VoiceTemplateRequest
public static interface VoiceTemplateRequest.Builder extends SdkPojo, CopyableBuilder<VoiceTemplateRequest.Builder,VoiceTemplateRequest>

  • Method Details

    • body

      VoiceTemplateRequest.Builder body(String body)

      The text of the script to use in messages that are based on the message template, in plain text format.

      Parameters:
      body - The text of the script to use in messages that are based on the message template, in plain text format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultSubstitutions

      VoiceTemplateRequest.Builder defaultSubstitutions(String defaultSubstitutions)

      A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

      Parameters:
      defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageCode

      VoiceTemplateRequest.Builder languageCode(String languageCode)

      The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

      Parameters:
      languageCode - The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      VoiceTemplateRequest.Builder tags(Map<String,String> tags)

      As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

      (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

      Parameters:
      tags - As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateDescription

      VoiceTemplateRequest.Builder templateDescription(String templateDescription)

      A custom description of the message template.

      Parameters:
      templateDescription - A custom description of the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • voiceId

      VoiceTemplateRequest.Builder voiceId(String voiceId)

      The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

      Parameters:
      voiceId - The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.