com.ibm.cos.v2.services.s3.model

Class ObjectLockRetention

java.lang.Object

com.ibm.cos.v2.services.s3.model.ObjectLockRetention

All Implemented Interfaces:

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

@Generated(value="com.ibm.cos.v2: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 and Description
static interface	ObjectLockRetention.Builder

Method Summary

Modifier and Type	Method and Description
static ObjectLockRetention.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ObjectLockRetention.Builder>	serializableBuilderClass()
ObjectLockRetention.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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 com.ibm.cos.v2.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 return ObjectLockRetentionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

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 return ObjectLockRetentionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

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()

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 interface ToCopyableBuilder<ObjectLockRetention.Builder,ObjectLockRetention>

Returns:

a builder for type T

builder

public static ObjectLockRetention.Builder builder()

serializableBuilderClass

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

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.