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
ModeandRetainUntilDatedata 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 interfaceS3Retention.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static S3Retention.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()S3ObjectLockRetentionModemode()The Object Lock retention mode to be applied to all objects in the Batch Operations job.StringmodeAsString()The Object Lock retention mode to be applied to all objects in the Batch Operations job.InstantretainUntilDate()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.BuildertoBuilder()StringtoString()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,
modewill returnS3ObjectLockRetentionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommodeAsString().- 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,
modewill returnS3ObjectLockRetentionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommodeAsString().- 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:
toBuilderin interfaceToCopyableBuilder<S3Retention.Builder,S3Retention>
-
builder
public static S3Retention.Builder builder()
-
serializableBuilderClass
public static Class<? extends S3Retention.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-