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

Class S3SetObjectRetentionOperation

java.lang.Object

software.amazon.awssdk.services.s3control.model.S3SetObjectRetentionOperation

All Implemented Interfaces:

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

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

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API operation. 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	S3SetObjectRetentionOperation.Builder

Method Summary

Modifier and Type	Method	Description
static S3SetObjectRetentionOperation.Builder	builder()
Boolean	bypassGovernanceRetention()	Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
S3Retention	retention()	Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job.
List<SdkField<?>>	sdkFields()
static Class<? extends S3SetObjectRetentionOperation.Builder>	serializableBuilderClass()
S3SetObjectRetentionOperation.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

bypassGovernanceRetention

public final Boolean bypassGovernanceRetention()

Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

Returns:

Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

retention

public final S3Retention retention()

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

Returns:

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

toBuilder

public S3SetObjectRetentionOperation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3SetObjectRetentionOperation.Builder,S3SetObjectRetentionOperation>

builder

public static S3SetObjectRetentionOperation.Builder builder()

serializableBuilderClass

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