Class ObjectLockRetention
- java.lang.Object
-
- software.amazon.awssdk.services.s3.model.ObjectLockRetention
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ObjectLockRetention.Builder,ObjectLockRetention>
@Generated("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 Description static interface
ObjectLockRetention.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ObjectLockRetention.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(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()
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
-
mode
public final 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 returnObjectLockRetentionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- Indicates the Retention mode for the specified object.
- See Also:
ObjectLockRetentionMode
-
modeAsString
public final 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 returnObjectLockRetentionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- Indicates the Retention mode for the specified object.
- See Also:
ObjectLockRetentionMode
-
retainUntilDate
public final 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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ObjectLockRetention.Builder,ObjectLockRetention>
-
builder
public static ObjectLockRetention.Builder builder()
-
serializableBuilderClass
public static Class<? extends ObjectLockRetention.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
-