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

Class ObjectLockRetention

java.lang.Object

software.amazon.awssdk.services.s3.model.ObjectLockRetention

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ObjectLockRetention.Builder,ObjectLockRetention>

@Generated("software.amazon.awssdk:codegen")
public final class ObjectLockRetention
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ObjectLockRetention.Builder,ObjectLockRetention>

A Retention configuration for an object.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ObjectLockRetention.Builder

Method Summary

Modifier and Type	Method	Description
static ObjectLockRetention.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final ObjectLockEventHold	eventHold()	The event hold status for the object.
final String	eventHoldAsString()	The event hold status for the object.
final EventHoldDuration	eventHoldDuration()	The event hold duration for the object.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final ObjectLockRetentionMode	mode()	Indicates the Retention mode for the specified object.
final String	modeAsString()	Indicates the Retention mode for the specified object.
final Instant	retainUntilDate()	The date on which this Object Lock Retention will expire.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ObjectLockRetention.Builder>	serializableBuilderClass()
ObjectLockRetention.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

mode

public final ObjectLockRetentionMode mode()

Indicates the Retention mode for the specified object.

If the service returns an enum value that is not available in the current SDK version, mode will return ObjectLockRetentionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

Indicates the Retention mode for the specified object.

See Also:

• ObjectLockRetentionMode

modeAsString

public final String modeAsString()

Indicates the Retention mode for the specified object.

If the service returns an enum value that is not available in the current SDK version, mode will return ObjectLockRetentionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

Indicates the Retention mode for the specified object.

See Also:

• ObjectLockRetentionMode

retainUntilDate

public final Instant retainUntilDate()

The date on which this Object Lock Retention will expire.

Returns:

The date on which this Object Lock Retention will expire.

eventHold

public final ObjectLockEventHold eventHold()

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

If the service returns an enum value that is not available in the current SDK version, eventHold will return ObjectLockEventHold.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventHoldAsString().

Returns:

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

See Also:

• ObjectLockEventHold

eventHoldAsString

public final String eventHoldAsString()

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

If the service returns an enum value that is not available in the current SDK version, eventHold will return ObjectLockEventHold.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventHoldAsString().

Returns:

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

See Also:

• ObjectLockEventHold

eventHoldDuration

public final EventHoldDuration eventHoldDuration()

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

Returns:

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

toBuilder

public ObjectLockRetention.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ObjectLockRetention.Builder,ObjectLockRetention>

builder

public static ObjectLockRetention.Builder builder()

serializableBuilderClass

public static Class<? extends ObjectLockRetention.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo