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(value="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 and Description
static interface	ObjectLockRetention.Builder

Method Summary

Modifier and Type	Method and Description
static ObjectLockRetention.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ObjectLockRetentionMode	mode() Indicates the Retention mode for the specified object.
String	modeAsString() Indicates the Retention mode for the specified object.
Instant	retainUntilDate() The date on which this Object Lock Retention will expire.
List<SdkField<?>>	sdkFields()
static Class<? extends ObjectLockRetention.Builder>	serializableBuilderClass()
ObjectLockRetention.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

mode

public 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 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 Instant retainUntilDate()

The date on which this Object Lock Retention will expire.

Returns:

The date on which this Object Lock Retention will expire.

toBuilder

public ObjectLockRetention.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ObjectLockRetention.Builder,ObjectLockRetention>

Returns:

a builder for type T

builder

public static ObjectLockRetention.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.