Interface UpdateSmsTemplateRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateSmsTemplateRequest.Builder,
,UpdateSmsTemplateRequest> PinpointRequest.Builder
,SdkBuilder<UpdateSmsTemplateRequest.Builder,
,UpdateSmsTemplateRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateSmsTemplateRequest
-
Method Summary
Modifier and TypeMethodDescriptioncreateNewVersion
(Boolean createNewVersion) Specifies whether to save the updates as a new version of the message template.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default UpdateSmsTemplateRequest.Builder
smsTemplateRequest
(Consumer<SMSTemplateRequest.Builder> smsTemplateRequest) Sets the value of the SMSTemplateRequest property for this object.smsTemplateRequest
(SMSTemplateRequest smsTemplateRequest) Sets the value of the SMSTemplateRequest property for this object.templateName
(String templateName) The name of the message template.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 Details
-
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.
- 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 (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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
smsTemplateRequest
Sets the value of the SMSTemplateRequest property for this object.- Parameters:
smsTemplateRequest
- The new value for the SMSTemplateRequest property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
smsTemplateRequest
default UpdateSmsTemplateRequest.Builder smsTemplateRequest(Consumer<SMSTemplateRequest.Builder> smsTemplateRequest) Sets the value of the SMSTemplateRequest property for this object. This is a convenience method that creates an instance of theSMSTemplateRequest.Builder
avoiding the need to create one manually viaSMSTemplateRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosmsTemplateRequest(SMSTemplateRequest)
.- Parameters:
smsTemplateRequest
- a consumer that will call methods onSMSTemplateRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
UpdateSmsTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateSmsTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-