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

Class GetSmsTemplateRequest

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.GetSmsTemplateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSmsTemplateRequest.Builder,GetSmsTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetSmsTemplateRequest extends PinpointRequest implements ToCopyableBuilder<GetSmsTemplateRequest.Builder,GetSmsTemplateRequest>

  • Method Details

    • templateName

      public final 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 final 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.

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

    • toBuilder

      public GetSmsTemplateRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetSmsTemplateRequest.Builder,GetSmsTemplateRequest>
      Specified by:
      toBuilder in class PinpointRequest

    • builder

      public static GetSmsTemplateRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetSmsTemplateRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo