Interface GetInAppTemplateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetInAppTemplateRequest.Builder,GetInAppTemplateRequest>, PinpointRequest.Builder, SdkBuilder<GetInAppTemplateRequest.Builder,GetInAppTemplateRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetInAppTemplateRequest

public static interface GetInAppTemplateRequest.Builder extends PinpointRequest.Builder, SdkPojo, CopyableBuilder<GetInAppTemplateRequest.Builder,GetInAppTemplateRequest>
  • Method Details

    • templateName

      GetInAppTemplateRequest.Builder templateName(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.

      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

      GetInAppTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.