Package software.amazon.awssdk.services.pinpoint.model

Interface VoiceTemplateResponse.Builder

    • Method Detail

      • arn

        VoiceTemplateResponse.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the message template.

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

      • body

        VoiceTemplateResponse.Builder body​(String body)

        The text of the script that's used in messages that are based on the message template, in plain text format.

        Parameters:
        body - The text of the script that's used 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.

      • creationDate

        VoiceTemplateResponse.Builder creationDate​(String creationDate)

        The date, in ISO 8601 format, when the message template was created.

        Parameters:
        creationDate - The date, in ISO 8601 format, when the message template was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultSubstitutions

        VoiceTemplateResponse.Builder defaultSubstitutions​(String defaultSubstitutions)

        The JSON object that specifies the default values that are used 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.

        Parameters:
        defaultSubstitutions - The JSON object that specifies the default values that are used 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageCode

        VoiceTemplateResponse.Builder languageCode​(String languageCode)

        The code for the language that's used 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 that's used 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.

      • lastModifiedDate

        VoiceTemplateResponse.Builder lastModifiedDate​(String lastModifiedDate)

        The date, in ISO 8601 format, when the message template was last modified.

        Parameters:
        lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        VoiceTemplateResponse.Builder tags​(Map<String,​String> tags)

        A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

        Parameters:
        tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateDescription

        VoiceTemplateResponse.Builder templateDescription​(String templateDescription)

        The custom description of the message template.

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

      • templateName

        VoiceTemplateResponse.Builder templateName​(String templateName)

        The name of the message template.

        Parameters:
        templateName - The name of the message template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateType

        VoiceTemplateResponse.Builder templateType​(String templateType)

        The type of channel that the message template is designed for. For a voice template, this value is VOICE.

        Parameters:
        templateType - The type of channel that the message template is designed for. For a voice template, this value is VOICE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TemplateType, TemplateType

      • templateType

        VoiceTemplateResponse.Builder templateType​(TemplateType templateType)

        The type of channel that the message template is designed for. For a voice template, this value is VOICE.

        Parameters:
        templateType - The type of channel that the message template is designed for. For a voice template, this value is VOICE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TemplateType, TemplateType

      • version

        VoiceTemplateResponse.Builder version​(String version)

        The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

        Parameters:
        version - The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • voiceId

        VoiceTemplateResponse.Builder voiceId​(String voiceId)

        The name of the voice that's used 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 that's used 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.