com.aliyun.oss.model

Class DeleteVersionsRequest

java.lang.Object

com.aliyun.oss.model.WebServiceRequest

com.aliyun.oss.model.GenericRequest

com.aliyun.oss.model.DeleteVersionsRequest

public class DeleteVersionsRequest
extends GenericRequest

Provides options for deleting multiple objects in a specified bucket. Once deleted, the object(s) can only be restored if versioning was enabled when the object(s) was deleted.

See Also:

OSS.deleteVersions(DeleteVersionsRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeleteVersionsRequest.KeyVersion A key to delete, with an optional version attribute.

Field Summary

Fields inherited from class com.aliyun.oss.model.WebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteVersionsRequest(String bucketName) Constructs a new DeleteVersionsRequest, specifying the objects' bucket name.

Method Summary

Modifier and Type	Method and Description
List<DeleteVersionsRequest.KeyVersion>	getKeys() Gets the list of keys to delete from this bucket.
boolean	getQuiet() Gets the quiet element for this request.
void	setKeys(List<DeleteVersionsRequest.KeyVersion> keys) Sets the list of keys to delete from this bucket, clearing any existing list of keys.
void	setQuiet(boolean quiet) Sets the quiet element for this request.
DeleteVersionsRequest	withBucketName(String bucketName) Sets the name of the OSS bucket containing the object(s) to delete and returns this object, enabling additional method calls to be chained together.
DeleteVersionsRequest	withKeys(List<DeleteVersionsRequest.KeyVersion> keys) Sets the list of keys to delete from this bucket, clearing any existing list of keys.
DeleteVersionsRequest	withQuiet(boolean quiet) Sets the quiet element for this request.

Methods inherited from class com.aliyun.oss.model.GenericRequest

getBucketName, getKey, getRequestPayer, getVersionId, setBucketName, setKey, setRequestPayer, setVersionId, withKey, withRequestPayer, withVersionId

Methods inherited from class com.aliyun.oss.model.WebServiceRequest

addAdditionalHeaderName, addHeader, addParameter, getAdditionalHeaderNames, getEndpoint, getHeaders, getParameters, getProgressListener, isLogEnabled, setAdditionalHeaderNames, setEndpoint, setHeaders, setLogEnabled, setParameters, setProgressListener, withProgressListener

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteVersionsRequest

public DeleteVersionsRequest(String bucketName)

Constructs a new DeleteVersionsRequest, specifying the objects' bucket name.

Parameters:

bucketName - The name of the OSS bucket containing the object(s) to delete.

Method Detail

withBucketName

public DeleteVersionsRequest withBucketName(String bucketName)

Sets the name of the OSS bucket containing the object(s) to delete and returns this object, enabling additional method calls to be chained together.

Overrides:

withBucketName in class GenericRequest

Parameters:

bucketName - The name of the OSS bucket containing the object(s) to delete.

Returns:

The updated DeleteVersionsRequest object, enabling additional method calls to be chained together.

setQuiet

public void setQuiet(boolean quiet)

Sets the quiet element for this request. When true, only errors will be returned in the service response.

Parameters:

quiet - Sets the quiet element for this request.

getQuiet

public boolean getQuiet()

Gets the quiet element for this request. When true, only errors will be returned in the service response.

Returns:

the flag for this request.

withQuiet

public DeleteVersionsRequest withQuiet(boolean quiet)

Sets the quiet element for this request. When true, only errors will be returned in the service response.

Parameters:

quiet - the flag for this request.

Returns:

this, to chain multiple calls together.

setKeys

public void setKeys(List<DeleteVersionsRequest.KeyVersion> keys)

Sets the list of keys to delete from this bucket, clearing any existing list of keys.

Parameters:

keys - The list of keys to delete from this bucket

withKeys

public DeleteVersionsRequest withKeys(List<DeleteVersionsRequest.KeyVersion> keys)

Sets the list of keys to delete from this bucket, clearing any existing list of keys.

Parameters:

keys - The list of keys to delete from this bucket

Returns:

this, to chain multiple calls togethers.

getKeys

public List<DeleteVersionsRequest.KeyVersion> getKeys()

Gets the list of keys to delete from this bucket.

Returns:

the list of keys.