software.amazon.awssdk.services.pinpoint.model

Interface UpdateEmailTemplateRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateEmailTemplateRequest.Builder,UpdateEmailTemplateRequest>, PinpointRequest.Builder, SdkBuilder<UpdateEmailTemplateRequest.Builder,UpdateEmailTemplateRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateEmailTemplateRequest

public static interface UpdateEmailTemplateRequest.Builder
extends PinpointRequest.Builder, SdkPojo, CopyableBuilder<UpdateEmailTemplateRequest.Builder,UpdateEmailTemplateRequest>

Method Summary

Modifier and Type	Method and Description
UpdateEmailTemplateRequest.Builder	createNewVersion(Boolean createNewVersion) Specifies whether to save the updates as a new version of the message template.
default UpdateEmailTemplateRequest.Builder	emailTemplateRequest(Consumer<EmailTemplateRequest.Builder> emailTemplateRequest) Sets the value of the EmailTemplateRequest property for this object.
UpdateEmailTemplateRequest.Builder	emailTemplateRequest(EmailTemplateRequest emailTemplateRequest) Sets the value of the EmailTemplateRequest property for this object.
UpdateEmailTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateEmailTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateEmailTemplateRequest.Builder	templateName(String templateName) The name of the message template.
UpdateEmailTemplateRequest.Builder	version(String version) The unique identifier for the version of the message template to update, retrieve information about, or delete.

Methods inherited from interface software.amazon.awssdk.services.pinpoint.model.PinpointRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

createNewVersion

UpdateEmailTemplateRequest.Builder createNewVersion(Boolean createNewVersion)

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

Parameters:

createNewVersion - Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

Returns:

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

emailTemplateRequest

UpdateEmailTemplateRequest.Builder emailTemplateRequest(EmailTemplateRequest emailTemplateRequest)

Sets the value of the EmailTemplateRequest property for this object.

Parameters:

emailTemplateRequest - The new value for the EmailTemplateRequest property for this object.

Returns:

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

emailTemplateRequest

default UpdateEmailTemplateRequest.Builder emailTemplateRequest(Consumer<EmailTemplateRequest.Builder> emailTemplateRequest)

Sets the value of the EmailTemplateRequest property for this object. This is a convenience that creates an instance of the EmailTemplateRequest.Builder avoiding the need to create one manually via EmailTemplateRequest.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailTemplateRequest(EmailTemplateRequest).

Parameters:

emailTemplateRequest - a consumer that will call methods on EmailTemplateRequest.Builder

Returns:

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

See Also:

emailTemplateRequest(EmailTemplateRequest)

templateName

UpdateEmailTemplateRequest.Builder templateName(String templateName)

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Parameters:

templateName - The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Returns:

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

version

UpdateEmailTemplateRequest.Builder version(String version)

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

• For a get operation, retrieves information about the active version of the template.

• For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

• For a delete operation, deletes the template, including all versions of the template.

Parameters:

version - The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

• For a get operation, retrieves information about the active version of the template.

• For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

• For a delete operation, deletes the template, including all versions of the template.

Returns:

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

overrideConfiguration

UpdateEmailTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateEmailTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder