Package software.amazon.awssdk.services.s3control.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 Summary

Modifier and Type	Method	Description
default LifecycleRule.Builder	abortIncompleteMultipartUpload(Consumer<AbortIncompleteMultipartUpload.Builder> abortIncompleteMultipartUpload)	Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload.
LifecycleRule.Builder	abortIncompleteMultipartUpload(AbortIncompleteMultipartUpload abortIncompleteMultipartUpload)	Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload.
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.
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.
default LifecycleRule.Builder	filter(Consumer<LifecycleRuleFilter.Builder> filter)	The container for the filter of lifecycle rule.
LifecycleRule.Builder	filter(LifecycleRuleFilter filter)	The container for the filter of lifecycle rule.
LifecycleRule.Builder	id(String id)	Unique identifier for the rule.
default LifecycleRule.Builder	noncurrentVersionExpiration(Consumer<NoncurrentVersionExpiration.Builder> noncurrentVersionExpiration)	The noncurrent version expiration of the lifecycle rule.
LifecycleRule.Builder	noncurrentVersionExpiration(NoncurrentVersionExpiration noncurrentVersionExpiration)	The noncurrent version expiration of the lifecycle rule.
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.
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.
LifecycleRule.Builder	noncurrentVersionTransitions(NoncurrentVersionTransition... noncurrentVersionTransitions)	Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class.
LifecycleRule.Builder	status(String status)	If 'Enabled', the rule is currently being applied.
LifecycleRule.Builder	status(ExpirationStatus status)	If 'Enabled', the rule is currently being applied.
LifecycleRule.Builder	transitions(Collection<Transition> transitions)	Specifies when an Amazon S3 object transitions to a specified storage class.
LifecycleRule.Builder	transitions(Consumer<Transition.Builder>... transitions)	Specifies when an Amazon S3 object transitions to a specified storage class.
LifecycleRule.Builder	transitions(Transition... transitions)	Specifies when an Amazon S3 object transitions to a specified storage class.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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:

• expiration(LifecycleExpiration)

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.

filter

LifecycleRule.Builder filter(LifecycleRuleFilter filter)

The container for the filter of lifecycle rule.

Parameters:

filter - The container for the filter of lifecycle rule.

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 container for the filter of lifecycle rule.

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:

• filter(LifecycleRuleFilter)

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:

• ExpirationStatus
• ExpirationStatus

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:

• ExpirationStatus
• ExpirationStatus

transitions

LifecycleRule.Builder transitions(Collection<Transition> transitions)

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

This is not supported by Amazon S3 on Outposts buckets.

Parameters:

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

This is not supported by Amazon S3 on Outposts buckets.

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.

This is not supported by Amazon S3 on Outposts buckets.

Parameters:

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

This is not supported by Amazon S3 on Outposts buckets.

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 not supported by Amazon S3 on Outposts buckets.

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:

• transitions(java.util.Collection<Transition>)

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.

This is not supported by Amazon S3 on Outposts buckets.

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.

This is not supported by Amazon S3 on Outposts buckets.

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.

This is not supported by Amazon S3 on Outposts buckets.

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.

This is not supported by Amazon S3 on Outposts buckets.

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 not supported by Amazon S3 on Outposts buckets.

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:

• noncurrentVersionTransitions(java.util.Collection<NoncurrentVersionTransition>)

noncurrentVersionExpiration

LifecycleRule.Builder noncurrentVersionExpiration(NoncurrentVersionExpiration noncurrentVersionExpiration)

The noncurrent version expiration of the lifecycle rule.

Parameters:

noncurrentVersionExpiration - The noncurrent version expiration of the lifecycle rule.

Returns:

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

noncurrentVersionExpiration

default LifecycleRule.Builder noncurrentVersionExpiration(Consumer<NoncurrentVersionExpiration.Builder> noncurrentVersionExpiration)

The noncurrent version expiration of the lifecycle rule.

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:

• noncurrentVersionExpiration(NoncurrentVersionExpiration)

abortIncompleteMultipartUpload

LifecycleRule.Builder abortIncompleteMultipartUpload(AbortIncompleteMultipartUpload abortIncompleteMultipartUpload)

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

Parameters:

abortIncompleteMultipartUpload - Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

Returns:

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

abortIncompleteMultipartUpload

default LifecycleRule.Builder abortIncompleteMultipartUpload(Consumer<AbortIncompleteMultipartUpload.Builder> abortIncompleteMultipartUpload)

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

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:

• abortIncompleteMultipartUpload(AbortIncompleteMultipartUpload)