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

Class ExtendObjectRetentionRequest

java.lang.Object

com.ibm.cos.v2.core.SdkRequest

com.ibm.cos.v2.awscore.AwsRequest

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

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExtendObjectRetentionRequest.Builder,ExtendObjectRetentionRequest>

public class ExtendObjectRetentionRequest
extends S3Request
implements SdkPojo, ToCopyableBuilder<ExtendObjectRetentionRequest.Builder,ExtendObjectRetentionRequest>

IBM specific: Request object containing all the options for extending the retention period of a protected object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExtendObjectRetentionRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static List<SdkField<?>>	SDK_FIELDS

Constructor Summary

Constructors

Constructor and Description
ExtendObjectRetentionRequest(com.ibm.cos.v2.services.s3.model.ExtendObjectRetentionRequest.BuilderImpl builder) Constructs a new ExtendObjectRetentionRequest object and initializes all required and optional object fields.

Method Summary

Modifier and Type	Method and Description
Long	additionalRetentionPeriod()
String	bucket() Returns the name of the bucket containing the reference to the object to add a legal hold to.
static ExtendObjectRetentionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	extendRetentionFromCurrentTime()
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() Gets the key, the name of the reference to the object to add a legal hold to.
Instant	newRetentionExpirationDate()
Long	newRetentionPeriod()
List<SdkField<?>>	sdkFields()
ExtendObjectRetentionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

sdkFieldNameToField

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Field Detail

SDK_FIELDS

public static final List<SdkField<?>> SDK_FIELDS

Constructor Detail

ExtendObjectRetentionRequest

public ExtendObjectRetentionRequest(com.ibm.cos.v2.services.s3.model.ExtendObjectRetentionRequest.BuilderImpl builder)

Constructs a new ExtendObjectRetentionRequest object and initializes all required and optional object fields.

Method Detail

bucket

public String bucket()

Returns the name of the bucket containing the reference to the object to add a legal hold to.

key

public String key()

Gets the key, the name of the reference to the object to add a legal hold to.

additionalRetentionPeriod

public Long additionalRetentionPeriod()

extendRetentionFromCurrentTime

public Long extendRetentionFromCurrentTime()

newRetentionExpirationDate

public Instant newRetentionExpirationDate()

newRetentionPeriod

public Long newRetentionPeriod()

toBuilder

public ExtendObjectRetentionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExtendObjectRetentionRequest.Builder,ExtendObjectRetentionRequest>

Specified by:

toBuilder in class S3Request

builder

public static ExtendObjectRetentionRequest.Builder builder()

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest