com.ibm.cloud.objectstorage.services.s3.model

Class ExtendObjectRetentionRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.ExtendObjectRetentionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class ExtendObjectRetentionRequest
extends AmazonWebServiceRequest
implements Serializable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ExtendObjectRetentionRequest() Constructs a new ExtendObjectRetentionRequest.
ExtendObjectRetentionRequest(String bucketName, String key) Constructs a new ExtendObjectRetentionRequest.
ExtendObjectRetentionRequest(String bucketName, String key, Long additionalRetentionPeriod, Long extendRetentionFromCurrentTime, Date newRetentionExpirationDate, Long newRetentionPeriod) Constructs a new ExtendObjectRetentionRequest.

Method Summary

Modifier and Type	Method and Description
Long	getAdditionalRetentionPeriod()
String	getBucketName() Returns the name of the bucket containing the reference to the object to add a legal hold to.
Long	getExtendRetentionFromCurrentTime()
String	getKey() Gets the key, the name of the reference to the object to add a legal hold to.
Date	getNewRetentionExpirationDate()
Long	getNewRetentionPeriod()
void	setAdditionalRetentionPeriod(Long additionalRetentionPeriod)
void	setBucketName(String bucketName) Sets the name of the bucket containing the reference to the object to add a legal hold to.
void	setExtendRetentionFromCurrentTime(Long extendRetentionFromCurrentTime)
void	setKey(String key) Sets the key, the name of the reference to the object to add a legal hold to.
void	setNewRetentionExpirationDate(Date newRetentionExpirationDate)
void	setNewRetentionPeriod(Long newRetentionPeriod)
ExtendObjectRetentionRequest	withAdditionalRetentionPeriod(Long additionalRetentionPeriod)
ExtendObjectRetentionRequest	withBucketName(String bucketName) Sets the name of the bucket containing the reference to the object to add a legal hold to, and returns a reference to this object(AddLegalHoldRequest) for method chaining.
ExtendObjectRetentionRequest	withExtendRetentionFromCurrentTime(Long extendRetentionFromCurrentTime)
ExtendObjectRetentionRequest	withKey(String key) Sets the key, the name of the reference to the object to add a legal hold to.
ExtendObjectRetentionRequest	withNewRetentionExpirationDate(Date newRetentionExpirationDate)
ExtendObjectRetentionRequest	withNewRetentionPeriod(Long newRetentionPeriod)

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtendObjectRetentionRequest

public ExtendObjectRetentionRequest()

Constructs a new ExtendObjectRetentionRequest.

ExtendObjectRetentionRequest

public ExtendObjectRetentionRequest(String bucketName,
                                    String key)

Constructs a new ExtendObjectRetentionRequest.

*

Parameters:

bucketName - The name of the bucket containing the reference to the object to add a legal hold to.

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

ExtendObjectRetentionRequest

public ExtendObjectRetentionRequest(String bucketName,
                                    String key,
                                    Long additionalRetentionPeriod,
                                    Long extendRetentionFromCurrentTime,
                                    Date newRetentionExpirationDate,
                                    Long newRetentionPeriod)

Constructs a new ExtendObjectRetentionRequest.

Parameters:

bucketName - The name of the bucket containing the reference to the object to add a legal hold to.

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

additionalRetentionPeriod - The additional retention period in seconds.

extendRetentionFromCurrentTime - The extended retention period in seconds.

newRetentionExpirationDate - The new retention period.

newRetentionPeriod - The new retention period in seconds.

Method Detail

getBucketName

public String getBucketName()

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

See Also:

ExtendObjectRetentionRequest.setBucketName(String), ExtendObjectRetentionRequest.withBucketName(String)

withBucketName

public ExtendObjectRetentionRequest withBucketName(String bucketName)

Sets the name of the bucket containing the reference to the object to add a legal hold to, and returns a reference to this object(AddLegalHoldRequest) for method chaining.

See Also:

ExtendObjectRetentionRequest.setBucketName(String), ExtendObjectRetentionRequest.getBucketName()

setBucketName

public void setBucketName(String bucketName)

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

See Also:

ExtendObjectRetentionRequest.getBucketName(), ExtendObjectRetentionRequest.withBucketName(String)

getKey

public String getKey()

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

See Also:

ExtendObjectRetentionRequest.setKey(String), ExtendObjectRetentionRequest.withKey(String)

setKey

public void setKey(String key)

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

See Also:

ExtendObjectRetentionRequest.getKey(), ExtendObjectRetentionRequest.withKey(String)

withKey

public ExtendObjectRetentionRequest withKey(String key)

Sets the key, the name of the reference to the object to add a legal hold to. Returns a reference to this object(AddLegalHoldRequest) for method chaining.

See Also:

ExtendObjectRetentionRequest.getKey(), ExtendObjectRetentionRequest.setKey(String)

getAdditionalRetentionPeriod

public Long getAdditionalRetentionPeriod()

setAdditionalRetentionPeriod

public void setAdditionalRetentionPeriod(Long additionalRetentionPeriod)

withAdditionalRetentionPeriod

public ExtendObjectRetentionRequest withAdditionalRetentionPeriod(Long additionalRetentionPeriod)

getExtendRetentionFromCurrentTime

public Long getExtendRetentionFromCurrentTime()

setExtendRetentionFromCurrentTime

public void setExtendRetentionFromCurrentTime(Long extendRetentionFromCurrentTime)

withExtendRetentionFromCurrentTime

public ExtendObjectRetentionRequest withExtendRetentionFromCurrentTime(Long extendRetentionFromCurrentTime)

getNewRetentionExpirationDate

public Date getNewRetentionExpirationDate()

setNewRetentionExpirationDate

public void setNewRetentionExpirationDate(Date newRetentionExpirationDate)

withNewRetentionExpirationDate

public ExtendObjectRetentionRequest withNewRetentionExpirationDate(Date newRetentionExpirationDate)

getNewRetentionPeriod

public Long getNewRetentionPeriod()

setNewRetentionPeriod

public void setNewRetentionPeriod(Long newRetentionPeriod)

withNewRetentionPeriod

public ExtendObjectRetentionRequest withNewRetentionPeriod(Long newRetentionPeriod)