com.obs.services.model

Class DeleteObjectsRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.DeleteObjectsRequest

public class DeleteObjectsRequest
extends GenericRequest

Parameters in an object batch deletion request

Field Summary

Fields inherited from class com.obs.services.model.GenericRequest

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
DeleteObjectsRequest()
DeleteObjectsRequest(String bucketName) Constructor
DeleteObjectsRequest(String bucketName, boolean quiet, KeyAndVersion[] keyAndVersions) Constructor
DeleteObjectsRequest(String bucketName, boolean quiet, KeyAndVersion[] keyAndVersions, String encodingType) Constructor

Method Summary

Modifier and Type	Method and Description
KeyAndVersion	addKeyAndVersion(String objectKey) Add an object to be deleted.
KeyAndVersion	addKeyAndVersion(String objectKey, String versionId) Add an object to be deleted.
String	getEncodingType() Get the encoding type that used for encode objectkey
KeyAndVersion[]	getKeyAndVersions() Obtain the to-be-deleted object array.
List<KeyAndVersion>	getKeyAndVersionsList() Obtain the list of to-be-deleted objects.
boolean	isQuiet() Obtain the response mode of the batch deletion.
void	setEncodingType(String encodingType) Set the encoding type that used for encode objectkey
void	setKeyAndVersions(KeyAndVersion[] keyAndVersions) Specify the to-be-deleted object array.
void	setQuiet(boolean quiet) Set the response mode for the batch deletion.
String	toString()

Methods inherited from class com.obs.services.model.GenericRequest

addUserHeaders, getBucketName, getHttpMethod, getUserHeaders, isRequesterPays, setBucketName, setRequesterPays, setUserHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteObjectsRequest

public DeleteObjectsRequest()

DeleteObjectsRequest

public DeleteObjectsRequest(String bucketName)

Constructor

Parameters:

bucketName - Bucket name

DeleteObjectsRequest

public DeleteObjectsRequest(String bucketName,
                            boolean quiet,
                            KeyAndVersion[] keyAndVersions)

Constructor

Parameters:

bucketName - Bucket name

quiet - Deletion response mode. "false" indicates that the "verbose" mode is used and "true" indicates that the "quiet" mode is used.

keyAndVersions - To-be-deleted object array

DeleteObjectsRequest

public DeleteObjectsRequest(String bucketName,
                            boolean quiet,
                            KeyAndVersion[] keyAndVersions,
                            String encodingType)

Constructor

Parameters:

bucketName - Bucket name

quiet - Deletion response mode. "false" indicates that the "verbose" mode is used and "true" indicates that the "quiet" mode is used.

keyAndVersions - To-be-deleted object array

encodingType - The encoding type use for encode objectKey.

Method Detail

isQuiet

public boolean isQuiet()

Obtain the response mode of the batch deletion. "false" indicates that the "verbose" mode is used and "true" indicates that the "quiet" mode is used.

Returns:

Response mode of the object batch deletion request

setQuiet

public void setQuiet(boolean quiet)

Set the response mode for the batch deletion. "false" indicates that the "verbose" mode is used and "true" indicates that the "quiet" mode is used.

Parameters:

quiet - Response mode of the object batch deletion request

setEncodingType

public void setEncodingType(String encodingType)

Set the encoding type that used for encode objectkey

Parameters:

encodingType - could chose url.

getEncodingType

public String getEncodingType()

Get the encoding type that used for encode objectkey

Returns:

encodingType

getKeyAndVersionsList

public List<KeyAndVersion> getKeyAndVersionsList()

Obtain the list of to-be-deleted objects.

Returns:

List of to-be-deleted objects

addKeyAndVersion

public KeyAndVersion addKeyAndVersion(String objectKey,
                                      String versionId)

Add an object to be deleted.

Parameters:

objectKey - Object name

versionId - Version ID of the object

Returns:

Object newly added to the deletion list

addKeyAndVersion

public KeyAndVersion addKeyAndVersion(String objectKey)

Add an object to be deleted.

Parameters:

objectKey - Object name

Returns:

Object newly added to the deletion list

getKeyAndVersions

public KeyAndVersion[] getKeyAndVersions()

Obtain the to-be-deleted object array.

Returns:

To-be-deleted object array

setKeyAndVersions

public void setKeyAndVersions(KeyAndVersion[] keyAndVersions)

Specify the to-be-deleted object array.

Parameters:

keyAndVersions - To-be-deleted object array

toString

public String toString()

Overrides:

toString in class GenericRequest