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

Class SetObjectRetentionRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, Serializable, Cloneable

public class SetObjectRetentionRequest
extends AmazonWebServiceRequest
implements Serializable, ExpectedBucketOwnerRequest

Places an Object Retention configuration on an object.

See Also:

Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
SetObjectRetentionRequest()

Method Summary

Modifier and Type	Method and Description
String	getBucketName() The S3 Bucket.
boolean	getBypassGovernanceRetention()
String	getExpectedBucketOwner() Returns he account id of the expected bucket owner.
String	getKey() The Object Key.
ObjectLockRetention	getRetention() The container element for the Object Retention configuration.
String	getVersionId() The Object Version ID.
boolean	isRequesterPays() Returns true if the user has enabled Requester Pays option when downloading an object from Requester Pays Bucket; else false.
void	setBucketName(String bucket) The S3 Bucket.
void	setBypassGovernanceRetention(boolean bypassGovernanceRetention)
void	setExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
void	setKey(String key) The Object Key.
void	setRequesterPays(boolean isRequesterPays) Used for downloading an Amazon S3 Object from a Requester Pays Bucket.
void	setRetention(ObjectLockRetention retention) The container element for the Object Retention configuration.
void	setVersionId(String versionId) The Object Version ID.
SetObjectRetentionRequest	withBucketName(String bucket) The S3 Bucket.
SetObjectRetentionRequest	withBypassGovernanceRetention(boolean bypassGovernanceRetention)
SetObjectRetentionRequest	withExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
SetObjectRetentionRequest	withKey(String key) The Object Key.
SetObjectRetentionRequest	withRequesterPays(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.
SetObjectRetentionRequest	withRetention(ObjectLockRetention retention) The container element for the Object Retention configuration.
SetObjectRetentionRequest	withVersionId(String versionId) The Object Version ID.

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

SetObjectRetentionRequest

public SetObjectRetentionRequest()

Method Detail

getExpectedBucketOwner

public String getExpectedBucketOwner()

Description copied from interface: ExpectedBucketOwnerRequest

Returns he account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

getExpectedBucketOwner in interface ExpectedBucketOwnerRequest

withExpectedBucketOwner

public SetObjectRetentionRequest withExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set the account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

withExpectedBucketOwner in interface ExpectedBucketOwnerRequest

setExpectedBucketOwner

public void setExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set the account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

setExpectedBucketOwner in interface ExpectedBucketOwnerRequest

getBucketName

public String getBucketName()

The S3 Bucket.

withBucketName

public SetObjectRetentionRequest withBucketName(String bucket)

The S3 Bucket.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon Simple Storage Service Developer Guide.

setBucketName

public void setBucketName(String bucket)

The S3 Bucket.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon Simple Storage Service Developer Guide.

getKey

public String getKey()

The Object Key.

withKey

public SetObjectRetentionRequest withKey(String key)

The Object Key.

setKey

public void setKey(String key)

The Object Key.

getRetention

public ObjectLockRetention getRetention()

The container element for the Object Retention configuration.

withRetention

public SetObjectRetentionRequest withRetention(ObjectLockRetention retention)

The container element for the Object Retention configuration.

setRetention

public void setRetention(ObjectLockRetention retention)

The container element for the Object Retention configuration.

isRequesterPays

public boolean isRequesterPays()

Returns true if the user has enabled Requester Pays option when downloading an object from Requester Pays Bucket; else false.

If a bucket is enabled for Requester Pays, then any attempt to read an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Enabling Requester Pays disables the ability to have anonymous access to this bucket

Returns:

true if the user has enabled Requester Pays option for downloading an object from Requester Pays Bucket.

withRequesterPays

public SetObjectRetentionRequest withRequesterPays(boolean isRequesterPays)

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket. It returns this updated GetObjectRequest object so that additional method calls can be chained together.

If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Enabling Requester Pays disables the ability to have anonymous access to this bucket.

Parameters:

isRequesterPays - Enable Requester Pays option for the operation.

Returns:

The updated GetObjectRequest object.

setRequesterPays

public void setRequesterPays(boolean isRequesterPays)

Used for downloading an Amazon S3 Object from a Requester Pays Bucket. If set the requester is charged for downloading the data from the bucket.

If a bucket is enabled for Requester Pays, then any attempt to read an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Enabling Requester Pays disables the ability to have anonymous access to this bucket

Parameters:

isRequesterPays - Enable Requester Pays option for the operation.

getVersionId

public String getVersionId()

The Object Version ID.

withVersionId

public SetObjectRetentionRequest withVersionId(String versionId)

The Object Version ID.

setVersionId

public void setVersionId(String versionId)

The Object Version ID.

getBypassGovernanceRetention

public boolean getBypassGovernanceRetention()

withBypassGovernanceRetention

public SetObjectRetentionRequest withBypassGovernanceRetention(boolean bypassGovernanceRetention)

setBypassGovernanceRetention

public void setBypassGovernanceRetention(boolean bypassGovernanceRetention)