@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateInAppTemplateRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateInAppTemplateRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateInAppTemplateRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getCreateNewVersion()
Specifies whether to save the updates as a new version of the message template.
|
InAppTemplateRequest |
getInAppTemplateRequest() |
String |
getTemplateName()
The name of the message template.
|
String |
getVersion()
The unique identifier for the version of the message template to update, retrieve information about, or delete.
|
int |
hashCode() |
Boolean |
isCreateNewVersion()
Specifies whether to save the updates as a new version of the message template.
|
void |
setCreateNewVersion(Boolean createNewVersion)
Specifies whether to save the updates as a new version of the message template.
|
void |
setInAppTemplateRequest(InAppTemplateRequest inAppTemplateRequest) |
void |
setTemplateName(String templateName)
The name of the message template.
|
void |
setVersion(String version)
The unique identifier for the version of the message template to update, retrieve information about, or delete.
|
String |
toString()
Returns a string representation of this object.
|
UpdateInAppTemplateRequest |
withCreateNewVersion(Boolean createNewVersion)
Specifies whether to save the updates as a new version of the message template.
|
UpdateInAppTemplateRequest |
withInAppTemplateRequest(InAppTemplateRequest inAppTemplateRequest) |
UpdateInAppTemplateRequest |
withTemplateName(String templateName)
The name of the message template.
|
UpdateInAppTemplateRequest |
withVersion(String version)
The unique identifier for the version of the message template to update, retrieve information about, or delete.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setCreateNewVersion(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 (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) 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.
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 (overwrite) the latest existing version
of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) 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.
public Boolean getCreateNewVersion()
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 (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) 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.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) 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.
public UpdateInAppTemplateRequest withCreateNewVersion(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 (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) 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.
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 (overwrite) the latest existing version
of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) 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.
public Boolean isCreateNewVersion()
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 (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) 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.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) 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.
public void setInAppTemplateRequest(InAppTemplateRequest inAppTemplateRequest)
inAppTemplateRequest
- public InAppTemplateRequest getInAppTemplateRequest()
public UpdateInAppTemplateRequest withInAppTemplateRequest(InAppTemplateRequest inAppTemplateRequest)
inAppTemplateRequest
- public void setTemplateName(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.
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 String getTemplateName()
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 UpdateInAppTemplateRequest withTemplateName(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.
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 setVersion(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.
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.
public String getVersion()
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.
public UpdateInAppTemplateRequest withVersion(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.
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.
public String toString()
toString
in class Object
Object.toString()
public UpdateInAppTemplateRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()