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

Class SetObjectLegalHoldResult

java.lang.Object

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

All Implemented Interfaces:

S3RequesterChargedResult, Serializable

public class SetObjectLegalHoldResult
extends Object
implements Serializable, S3RequesterChargedResult

Result object to contain the response returned from AmazonS3.setObjectLegalHold(SetObjectLegalHoldRequest).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetObjectLegalHoldResult()

Method Summary

Modifier and Type	Method and Description
boolean	isRequesterCharged() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setRequesterCharged(boolean isRequesterCharged) Used for conducting this operation from a Requester Pays Bucket.
SetObjectLegalHoldResult	withRequesterCharged(Boolean requesterCharged)

Methods inherited from class java.lang.Object

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

Constructor Detail

SetObjectLegalHoldResult

public SetObjectLegalHoldResult()

Method Detail

isRequesterCharged

public boolean isRequesterCharged()

Description copied from interface: S3RequesterChargedResult

Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.

If a bucket is enabled for Requester Pays, then any attempt of operation 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

Specified by:

isRequesterCharged in interface S3RequesterChargedResult

Returns:

true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.

withRequesterCharged

public SetObjectLegalHoldResult withRequesterCharged(Boolean requesterCharged)

setRequesterCharged

public void setRequesterCharged(boolean isRequesterCharged)

Description copied from interface: S3RequesterChargedResult

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for conducting the operation from the bucket.

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

Specified by:

setRequesterCharged in interface S3RequesterChargedResult

Parameters:

isRequesterCharged - Indicates requester is charged for this operation.