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

Interface GetPushTemplateRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetPushTemplateRequest

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

Method Summary

Modifier and Type	Method	Description
GetPushTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetPushTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetPushTemplateRequest.Builder	templateName(String templateName)	The name of the message template.
GetPushTemplateRequest.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.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

templateName

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

GetPushTemplateRequest.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 for an existing template version. If specified for an update operation, this value must match the identifier for 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 (overwrites) 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 for an existing template version. If specified for an update operation, this value must match the identifier for 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 (overwrites) 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

GetPushTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder