/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.pinpoint.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DeleteInAppTemplateRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private String templateName; /** ** 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. *
** 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. *
* * @param 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. */ public void setTemplateName(String templateName) { this.templateName = 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. *
* * @return 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. */ public String getTemplateName() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DeleteInAppTemplateRequest withTemplateName(String templateName) { setTemplateName(templateName); return this; } /** ** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
*