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

Class SetObjectLockConfigurationRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, Serializable, Cloneable

public class SetObjectLockConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable, ExpectedBucketOwnerRequest

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

See Also:

Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
SetObjectLockConfigurationRequest()

Method Summary

Modifier and Type	Method and Description
String	getBucketName() The S3 Bucket.
String	getExpectedBucketOwner() Returns he account id of the expected bucket owner.
ObjectLockConfiguration	getObjectLockConfiguration() The Object Lock configuration that you want to apply to the specified bucket.
String	getToken()
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	setExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
void	setObjectLockConfiguration(ObjectLockConfiguration objectLockConfiguration) The Object Lock configuration that you want to apply to the specified bucket.
void	setRequesterPays(boolean isRequesterPays) Used for downloading an Amazon S3 Object from a Requester Pays Bucket.
void	setToken(String token)
SetObjectLockConfigurationRequest	withBucketName(String bucket) The S3 Bucket.
SetObjectLockConfigurationRequest	withExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
SetObjectLockConfigurationRequest	withObjectLockConfiguration(ObjectLockConfiguration objectLockConfiguration) The Object Lock configuration that you want to apply to the specified bucket.
SetObjectLockConfigurationRequest	withRequesterPays(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.
SetObjectLockConfigurationRequest	withToken(String token)

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

SetObjectLockConfigurationRequest

public SetObjectLockConfigurationRequest()

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 SetObjectLockConfigurationRequest 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 SetObjectLockConfigurationRequest 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.

getObjectLockConfiguration

public ObjectLockConfiguration getObjectLockConfiguration()

The Object Lock configuration that you want to apply to the specified bucket.

withObjectLockConfiguration

public SetObjectLockConfigurationRequest withObjectLockConfiguration(ObjectLockConfiguration objectLockConfiguration)

The Object Lock configuration that you want to apply to the specified bucket.

setObjectLockConfiguration

public void setObjectLockConfiguration(ObjectLockConfiguration objectLockConfiguration)

The Object Lock configuration that you want to apply to the specified bucket.

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 SetObjectLockConfigurationRequest 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.

getToken

public String getToken()

withToken

public SetObjectLockConfigurationRequest withToken(String token)

setToken

public void setToken(String token)