Interface ObjectLockRetention.Builder

All Superinterfaces:

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

Enclosing class:

ObjectLockRetention

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

Method Summary

Modifier and Type	Method	Description
ObjectLockRetention.Builder	eventHold(String eventHold)	The event hold status for the object.
ObjectLockRetention.Builder	eventHold(ObjectLockEventHold eventHold)	The event hold status for the object.
default ObjectLockRetention.Builder	eventHoldDuration(Consumer<EventHoldDuration.Builder> eventHoldDuration)	The event hold duration for the object.
ObjectLockRetention.Builder	eventHoldDuration(EventHoldDuration eventHoldDuration)	The event hold duration for the object.
ObjectLockRetention.Builder	mode(String mode)	Indicates the Retention mode for the specified object.
ObjectLockRetention.Builder	mode(ObjectLockRetentionMode mode)	Indicates the Retention mode for the specified object.
ObjectLockRetention.Builder	retainUntilDate(Instant retainUntilDate)	The date on which this Object Lock Retention will expire.

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

mode

ObjectLockRetention.Builder mode(String mode)

Indicates the Retention mode for the specified object.

Parameters:

mode - Indicates the Retention mode for the specified object.

Returns:

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

See Also:

• ObjectLockRetentionMode
• ObjectLockRetentionMode

mode

ObjectLockRetention.Builder mode(ObjectLockRetentionMode mode)

Indicates the Retention mode for the specified object.

Parameters:

mode - Indicates the Retention mode for the specified object.

Returns:

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

See Also:

• ObjectLockRetentionMode
• ObjectLockRetentionMode

retainUntilDate

ObjectLockRetention.Builder retainUntilDate(Instant retainUntilDate)

The date on which this Object Lock Retention will expire.

Parameters:

retainUntilDate - The date on which this Object Lock Retention will expire.

Returns:

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

eventHold

ObjectLockRetention.Builder eventHold(String eventHold)

The event hold status for the object. Set to ON to enable an event hold or OFF to disable it.

Parameters:

eventHold - The event hold status for the object. 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:

• ObjectLockEventHold
• ObjectLockEventHold

eventHold

ObjectLockRetention.Builder eventHold(ObjectLockEventHold eventHold)

The event hold status for the object. Set to ON to enable an event hold or OFF to disable it.

Parameters:

eventHold - The event hold status for the object. 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:

• ObjectLockEventHold
• ObjectLockEventHold

eventHoldDuration

ObjectLockRetention.Builder eventHoldDuration(EventHoldDuration eventHoldDuration)

The event hold duration for the object. Specifies how long the object remains protected after the event hold is released.

Parameters:

eventHoldDuration - The event hold duration for the object. 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 ObjectLockRetention.Builder eventHoldDuration(Consumer<EventHoldDuration.Builder> eventHoldDuration)

The event hold duration for the object. Specifies how long the object remains protected after the event hold is released.

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

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

Parameters:

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

Returns:

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

See Also:

• eventHoldDuration(EventHoldDuration)