Interface S3Retention.Builder

All Superinterfaces:

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

Enclosing class:

S3Retention

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

Method Summary

Modifier and Type	Method	Description
S3Retention.Builder	eventHold(String eventHold)	The event hold status to be applied to all objects in the Batch Operations job.
S3Retention.Builder	eventHold(S3ObjectLockRetentionEventHold eventHold)	The event hold status to be applied to all objects in the Batch Operations job.
default S3Retention.Builder	eventHoldDuration(Consumer<S3ObjectLockRetentionEventHoldDuration.Builder> eventHoldDuration)	The event hold duration to be applied to all objects in the Batch Operations job.
S3Retention.Builder	eventHoldDuration(S3ObjectLockRetentionEventHoldDuration eventHoldDuration)	The event hold duration to be applied to all objects in the Batch Operations job.
S3Retention.Builder	mode(String mode)	The Object Lock retention mode to be applied to all objects in the Batch Operations job.
S3Retention.Builder	mode(S3ObjectLockRetentionMode mode)	The Object Lock retention mode to be applied to all objects in the Batch Operations job.
S3Retention.Builder	retainUntilDate(Instant retainUntilDate)	The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

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 Details

retainUntilDate

S3Retention.Builder retainUntilDate(Instant retainUntilDate)

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Parameters:

retainUntilDate - The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Returns:

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

mode

S3Retention.Builder mode(String mode)

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Parameters:

mode - The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Returns:

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

See Also:

• S3ObjectLockRetentionMode
• S3ObjectLockRetentionMode

mode

S3Retention.Builder mode(S3ObjectLockRetentionMode mode)

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Parameters:

mode - The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Returns:

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

See Also:

• S3ObjectLockRetentionMode
• S3ObjectLockRetentionMode

eventHold

S3Retention.Builder eventHold(String eventHold)

The event hold status to be applied to all objects in the Batch Operations job. Set to ON to enable an event hold or OFF to disable it.

Parameters:

eventHold - The event hold status to be applied to all objects in the Batch Operations job. Set to ON to enable an event hold or OFF to disable it.

Returns:

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

See Also:

• S3ObjectLockRetentionEventHold
• S3ObjectLockRetentionEventHold

eventHold

S3Retention.Builder eventHold(S3ObjectLockRetentionEventHold eventHold)

The event hold status to be applied to all objects in the Batch Operations job. Set to ON to enable an event hold or OFF to disable it.

Parameters:

eventHold - The event hold status to be applied to all objects in the Batch Operations job. Set to ON to enable an event hold or OFF to disable it.

Returns:

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

See Also:

• S3ObjectLockRetentionEventHold
• S3ObjectLockRetentionEventHold

eventHoldDuration

S3Retention.Builder eventHoldDuration(S3ObjectLockRetentionEventHoldDuration eventHoldDuration)

The event hold duration to be applied to all objects in the Batch Operations job. The duration specifies how long the object remains protected after the event hold is released.

Parameters:

eventHoldDuration - The event hold duration to be applied to all objects in the Batch Operations job. The duration specifies how long the object remains protected after the event hold is released.

Returns:

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

eventHoldDuration

default S3Retention.Builder eventHoldDuration(Consumer<S3ObjectLockRetentionEventHoldDuration.Builder> eventHoldDuration)

The event hold duration to be applied to all objects in the Batch Operations job. The duration specifies how long the object remains protected after the event hold is released.

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

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

Parameters:

eventHoldDuration - a consumer that will call methods on S3ObjectLockRetentionEventHoldDuration.Builder

Returns:

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

See Also:

• eventHoldDuration(S3ObjectLockRetentionEventHoldDuration)