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

Interface UpdatePushTemplateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdatePushTemplateRequest.Builder,UpdatePushTemplateRequest>, PinpointRequest.Builder, SdkBuilder<UpdatePushTemplateRequest.Builder,UpdatePushTemplateRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdatePushTemplateRequest
public static interface UpdatePushTemplateRequest.Builder extends PinpointRequest.Builder, SdkPojo, CopyableBuilder<UpdatePushTemplateRequest.Builder,UpdatePushTemplateRequest>

  • Method Details

    • createNewVersion

      UpdatePushTemplateRequest.Builder createNewVersion(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.

      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.

    • pushNotificationTemplateRequest

      UpdatePushTemplateRequest.Builder pushNotificationTemplateRequest(PushNotificationTemplateRequest pushNotificationTemplateRequest)
      Sets the value of the PushNotificationTemplateRequest property for this object.
      Parameters:
      pushNotificationTemplateRequest - The new value for the PushNotificationTemplateRequest property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pushNotificationTemplateRequest

      default UpdatePushTemplateRequest.Builder pushNotificationTemplateRequest(Consumer<PushNotificationTemplateRequest.Builder> pushNotificationTemplateRequest)
      Sets the value of the PushNotificationTemplateRequest property for this object. This is a convenience method that creates an instance of the PushNotificationTemplateRequest.Builder avoiding the need to create one manually via PushNotificationTemplateRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pushNotificationTemplateRequest(PushNotificationTemplateRequest).

      Parameters:
      pushNotificationTemplateRequest - a consumer that will call methods on PushNotificationTemplateRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • templateName

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

      UpdatePushTemplateRequest.Builder version(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.

      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

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

      UpdatePushTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.