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

Interface ObjectLockConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ObjectLockConfiguration.Builder,ObjectLockConfiguration>, SdkBuilder<ObjectLockConfiguration.Builder,ObjectLockConfiguration>, SdkPojo

Enclosing class:

ObjectLockConfiguration

@Mutable
@NotThreadSafe
public static interface ObjectLockConfiguration.Builder
extends SdkPojo, CopyableBuilder<ObjectLockConfiguration.Builder,ObjectLockConfiguration>

Method Summary

Modifier and Type	Method	Description
ObjectLockConfiguration.Builder	objectLockEnabled(String objectLockEnabled)	Indicates whether this bucket has an Object Lock configuration enabled.
ObjectLockConfiguration.Builder	objectLockEnabled(ObjectLockEnabled objectLockEnabled)	Indicates whether this bucket has an Object Lock configuration enabled.
default ObjectLockConfiguration.Builder	rule(Consumer<ObjectLockRule.Builder> rule)	Specifies the Object Lock rule for the specified object.
ObjectLockConfiguration.Builder	rule(ObjectLockRule rule)	Specifies the Object Lock rule for the specified object.

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, sdkFieldNameToField, sdkFields

Method Detail

objectLockEnabled

ObjectLockConfiguration.Builder objectLockEnabled(String objectLockEnabled)

Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Parameters:

objectLockEnabled - Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Returns:

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

See Also:

ObjectLockEnabled, ObjectLockEnabled

objectLockEnabled

ObjectLockConfiguration.Builder objectLockEnabled(ObjectLockEnabled objectLockEnabled)

Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Parameters:

objectLockEnabled - Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Returns:

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

See Also:

ObjectLockEnabled, ObjectLockEnabled

rule

ObjectLockConfiguration.Builder rule(ObjectLockRule rule)

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

Parameters:

rule - Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

Returns:

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

rule

default ObjectLockConfiguration.Builder rule(Consumer<ObjectLockRule.Builder> rule)

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

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

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

Parameters:

rule - a consumer that will call methods on ObjectLockRule.Builder

Returns:

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

See Also:

rule(ObjectLockRule)