Package software.amazon.awssdk.services.s3control.model

Class S3Retention

java.lang.Object

software.amazon.awssdk.services.s3control.model.S3Retention

All Implemented Interfaces:

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

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

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3Retention.Builder

Method Summary

Modifier and Type	Method	Description
static S3Retention.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
S3ObjectLockRetentionMode	mode()	The Object Lock retention mode to be applied to all objects in the Batch Operations job.
String	modeAsString()	The Object Lock retention mode to be applied to all objects in the Batch Operations job.
Instant	retainUntilDate()	The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.
List<SdkField<?>>	sdkFields()
static Class<? extends S3Retention.Builder>	serializableBuilderClass()
S3Retention.Builder	toBuilder()
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 Detail

retainUntilDate

public final Instant retainUntilDate()

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

Returns:

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

mode

public final S3ObjectLockRetentionMode mode()

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

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

Returns:

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

See Also:

S3ObjectLockRetentionMode

modeAsString

public final String modeAsString()

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

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

Returns:

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

See Also:

S3ObjectLockRetentionMode

toBuilder

public S3Retention.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3Retention.Builder,S3Retention>

builder

public static S3Retention.Builder builder()

serializableBuilderClass

public static Class<? extends S3Retention.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