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

Class DeleteObjectsResult

java.lang.Object

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

All Implemented Interfaces:

S3RequesterChargedResult, Serializable

public class DeleteObjectsResult
extends Object
implements Serializable, S3RequesterChargedResult

Successful response to AmazonS3.deleteObjects(DeleteObjectsRequest). If one or more objects couldn't be deleted as instructed, a MultiObjectDeleteException is thrown instead.

See Also:

AmazonS3.deleteObjects(DeleteObjectsRequest), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeleteObjectsResult.DeletedObject A successfully deleted object.

Constructor Summary

Constructors

Constructor and Description
DeleteObjectsResult(List<DeleteObjectsResult.DeletedObject> deletedObjects)
DeleteObjectsResult(List<DeleteObjectsResult.DeletedObject> deletedObjects, boolean isRequesterCharged)

Method Summary

Modifier and Type	Method and Description
List<DeleteObjectsResult.DeletedObject>	getDeletedObjects() Returns the list of successfully deleted objects from this request.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteObjectsResult

public DeleteObjectsResult(List<DeleteObjectsResult.DeletedObject> deletedObjects)

DeleteObjectsResult

public DeleteObjectsResult(List<DeleteObjectsResult.DeletedObject> deletedObjects,
                           boolean isRequesterCharged)

Method Detail

getDeletedObjects

public List<DeleteObjectsResult.DeletedObject> getDeletedObjects()

Returns the list of successfully deleted objects from this request. If DeleteObjectsRequest.getQuiet() is true, only error responses will be returned from s3, so this list will be empty.

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.

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.