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

Interface TemplateResponse.Builder

    • Method Detail

      • arn

        TemplateResponse.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

        Parameters:
        arn - The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

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

        TemplateResponse.Builder defaultSubstitutions​(String defaultSubstitutions)

        The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

        Parameters:
        defaultSubstitutions - The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastModifiedDate

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

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

        A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

        Parameters:
        tags - A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateDescription

        TemplateResponse.Builder templateDescription​(String templateDescription)

        The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

        Parameters:
        templateDescription - The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateName

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

        TemplateResponse.Builder templateType​(String templateType)

        The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

        Parameters:
        templateType - The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TemplateType, TemplateType

      • templateType

        TemplateResponse.Builder templateType​(TemplateType templateType)

        The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

        Parameters:
        templateType - The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TemplateType, TemplateType

      • version

        TemplateResponse.Builder version​(String version)

        The unique identifier, as an integer, for the active version of the message template.

        Parameters:
        version - The unique identifier, as an integer, for the active version of the message template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.