Class S3Retention
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic S3Retention.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
mode()
The Object Lock retention mode to be applied to all objects in the Batch Operations job.final String
The Object Lock retention mode to be applied to all objects in the Batch Operations job.final Instant
The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.static Class
<? extends S3Retention.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 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:
-
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 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:
-
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 interfaceToCopyableBuilder<S3Retention.Builder,
S3Retention> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-