Package software.amazon.awssdk.services.s3.model

Interface LifecycleRule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LifecycleRule.Builder,LifecycleRule>, SdkBuilder<LifecycleRule.Builder,LifecycleRule>, SdkPojo
Enclosing class:
LifecycleRule
public static interface LifecycleRule.Builder extends SdkPojo, CopyableBuilder<LifecycleRule.Builder,LifecycleRule>

  • Method Details

    • expiration

      LifecycleRule.Builder expiration(LifecycleExpiration expiration)

      Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

      Parameters:
      expiration - Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expiration

      default LifecycleRule.Builder expiration(Consumer<LifecycleExpiration.Builder> expiration)

      Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

      This is a convenience method that creates an instance of the LifecycleExpiration.Builder avoiding the need to create one manually via LifecycleExpiration.builder().

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

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

    • id

      LifecycleRule.Builder id(String id)

      Unique identifier for the rule. The value cannot be longer than 255 characters.

      Parameters:
      id - Unique identifier for the rule. The value cannot be longer than 255 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • prefix

      @Deprecated LifecycleRule.Builder prefix(String prefix)
      Deprecated.

      Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.

      Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

      Parameters:
      prefix - Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.

      Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      LifecycleRule.Builder filter(LifecycleRuleFilter filter)

      The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.

      Parameters:
      filter - The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      default LifecycleRule.Builder filter(Consumer<LifecycleRuleFilter.Builder> filter)

      The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.

      This is a convenience method that creates an instance of the LifecycleRuleFilter.Builder avoiding the need to create one manually via LifecycleRuleFilter.builder().

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

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

    • status

      LifecycleRule.Builder status(String status)

      If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

      Parameters:
      status - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      LifecycleRule.Builder status(ExpirationStatus status)

      If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

      Parameters:
      status - If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • transitions

      LifecycleRule.Builder transitions(Collection<Transition> transitions)

      Specifies when an Amazon S3 object transitions to a specified storage class.

      Parameters:
      transitions - Specifies when an Amazon S3 object transitions to a specified storage class.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transitions

      LifecycleRule.Builder transitions(Transition... transitions)

      Specifies when an Amazon S3 object transitions to a specified storage class.

      Parameters:
      transitions - Specifies when an Amazon S3 object transitions to a specified storage class.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transitions

      LifecycleRule.Builder transitions(Consumer<Transition.Builder>... transitions)

      Specifies when an Amazon S3 object transitions to a specified storage class.

      This is a convenience method that creates an instance of the Transition.Builder avoiding the need to create one manually via Transition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transitions(List<Transition>).

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

    • noncurrentVersionTransitions

      LifecycleRule.Builder noncurrentVersionTransitions(Collection<NoncurrentVersionTransition> noncurrentVersionTransitions)

      Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

      Parameters:
      noncurrentVersionTransitions - Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • noncurrentVersionTransitions

      LifecycleRule.Builder noncurrentVersionTransitions(NoncurrentVersionTransition... noncurrentVersionTransitions)

      Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

      Parameters:
      noncurrentVersionTransitions - Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • noncurrentVersionTransitions

      LifecycleRule.Builder noncurrentVersionTransitions(Consumer<NoncurrentVersionTransition.Builder>... noncurrentVersionTransitions)

      Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

      This is a convenience method that creates an instance of the NoncurrentVersionTransition.Builder avoiding the need to create one manually via NoncurrentVersionTransition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to noncurrentVersionTransitions(List<NoncurrentVersionTransition>).

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

    • noncurrentVersionExpiration

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

    • noncurrentVersionExpiration

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

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

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

    • abortIncompleteMultipartUpload

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

    • abortIncompleteMultipartUpload

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

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

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