UpdateSmsTemplateRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.pinpoint.model.PinpointRequest
    - - software.amazon.awssdk.services.pinpoint.model.UpdateSmsTemplateRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateSmsTemplateRequest.Builder,UpdateSmsTemplateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateSmsTemplateRequest
extends PinpointRequest
implements ToCopyableBuilder<UpdateSmsTemplateRequest.Builder,UpdateSmsTemplateRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateSmsTemplateRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateSmsTemplateRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateSmsTemplateRequest.Builder`	`builder()`
`Boolean`	`createNewVersion()` Specifies whether to save the updates as a new version of the message template.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateSmsTemplateRequest.Builder>`	`serializableBuilderClass()`
`SMSTemplateRequest`	`smsTemplateRequest()` Returns the value of the SMSTemplateRequest property for this object.
`String`	`templateName()` The name of the message template.
`UpdateSmsTemplateRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` The unique identifier for the version of the message template to update, retrieve information about, or delete.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - createNewVersion
```
public 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.
    
    Returns:
    
    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.
  - smsTemplateRequest
```
public SMSTemplateRequest smsTemplateRequest()
```
    Returns the value of the SMSTemplateRequest property for this object.
    
    Returns:
    
    The value of the SMSTemplateRequest property for this object.
  - templateName
```
public 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.
    
    Returns:
    
    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.
  - version
```
public 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.
    Returns:
    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.
  - toBuilder
```
public UpdateSmsTemplateRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateSmsTemplateRequest.Builder,UpdateSmsTemplateRequest>
    
    Specified by:
    
    toBuilder in class PinpointRequest
  - builder
```
public static UpdateSmsTemplateRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateSmsTemplateRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateSmsTemplateRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

createNewVersion

smsTemplateRequest

templateName

version

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields