com.ibm.cloud.objectstorage.services.s3.internal

Class DeleteObjectsResponse

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.internal.DeleteObjectsResponse

All Implemented Interfaces:

S3RequesterChargedResult

public class DeleteObjectsResponse
extends Object
implements S3RequesterChargedResult

Service response for deleteObjects API call. Not exposed to clients directly, but broken up into two classes to differentiate normal and exceptional completion of the API.

See Also:

DeleteObjectsResult, MultiObjectDeleteException, AmazonS3Client.deleteObjects(com.ibm.cloud.objectstorage.services.s3.model.DeleteObjectsRequest)

Constructor Summary

Constructors

Constructor and Description
DeleteObjectsResponse()
DeleteObjectsResponse(List<DeleteObjectsResult.DeletedObject> deletedObjects, List<MultiObjectDeleteException.DeleteError> errors)

Method Summary

Modifier and Type	Method and Description
List<DeleteObjectsResult.DeletedObject>	getDeletedObjects()
List<MultiObjectDeleteException.DeleteError>	getErrors()
boolean	isRequesterCharged() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setDeletedObjects(List<DeleteObjectsResult.DeletedObject> deletedObjects)
void	setErrors(List<MultiObjectDeleteException.DeleteError> errors)
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

DeleteObjectsResponse

public DeleteObjectsResponse()

DeleteObjectsResponse

public DeleteObjectsResponse(List<DeleteObjectsResult.DeletedObject> deletedObjects,
                             List<MultiObjectDeleteException.DeleteError> errors)

Method Detail

getDeletedObjects

public List<DeleteObjectsResult.DeletedObject> getDeletedObjects()

setDeletedObjects

public void setDeletedObjects(List<DeleteObjectsResult.DeletedObject> deletedObjects)

getErrors

public List<MultiObjectDeleteException.DeleteError> getErrors()

setErrors

public void setErrors(List<MultiObjectDeleteException.DeleteError> errors)

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.