com.aliyun.oss.model

Class DeleteVersionRequest

java.lang.Object

com.aliyun.oss.model.WebServiceRequest

com.aliyun.oss.model.GenericRequest

com.aliyun.oss.model.DeleteVersionRequest

public class DeleteVersionRequest
extends GenericRequest

Provides options for deleting a specific version of an object in the specified bucket. Once deleted, there is no method to restore or undelete an object version. This is the only way to permanently delete object versions that are protected by versioning.

Because deleting an object version is permanent and irreversible, it is a privileged operation that only the owner of the bucket containing the version may perform.

An owner can only delete a version of an object if the owner has enabled versioning for their bucket. For more information about enabling versioning for a bucket, see OSS.setBucketVersioning(SetBucketVersioningRequest).

Note: When attempting to delete an object that does not exist, OSS returns a success message, not an error message.

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteVersionRequest(String bucketName, String key, String versionId) Constructs a new DeleteVersionRequest object, ready to be executed to delete the version identified by the specified version ID, in the specified bucket and key.

Method Summary

Methods

Modifier and Type	Method and Description
String	getVersionId() Gets the version ID uniquely identifying which version of the object to delete.
void	setVersionId(String versionId) Sets the version ID uniquely identifying which version of the object to delete.
DeleteVersionRequest	withVersionId(String versionId) Sets the version ID uniquely identifying which version of the object to delete Returns this DeleteVersionRequest, enabling additional method calls to be chained together.

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

getBucketName, getKey, getRequestPayer, setBucketName, setKey, setRequestPayer, withBucketName, withKey, withRequestPayer

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

addAdditionalHeaderName, addHeader, addParameter, getAdditionalHeaderNames, getHeaders, getParameters, getProgressListener, isLogEnabled, setAdditionalHeaderNames, 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

DeleteVersionRequest

public DeleteVersionRequest(String bucketName,
                    String key,
                    String versionId)

Constructs a new DeleteVersionRequest object, ready to be executed to delete the version identified by the specified version ID, in the specified bucket and key.

Parameters:

bucketName - The name of the bucket containing the version to delete.

key - The key of the object version to delete.

versionId - The version ID identifying the version to delete.

Method Detail

getVersionId

public String getVersionId()

Gets the version ID uniquely identifying which version of the object to delete.

Overrides:

getVersionId in class GenericRequest

Returns:

The version ID uniquely identifying which version of the object to delete.

See Also:

setVersionId(String), withVersionId(String)

setVersionId

public void setVersionId(String versionId)

Sets the version ID uniquely identifying which version of the object to delete.

Overrides:

setVersionId in class GenericRequest

Parameters:

versionId - The version ID uniquely identifying which version of the object to delete.

See Also:

getVersionId(), withVersionId(String)

withVersionId

public DeleteVersionRequest withVersionId(String versionId)

Sets the version ID uniquely identifying which version of the object to delete Returns this DeleteVersionRequest, enabling additional method calls to be chained together.

Overrides:

withVersionId in class GenericRequest

Parameters:

versionId - The version ID uniquely identifying which version of the object to delete.

Returns:

This DeleteVersionRequest, enabling additional method calls to be chained together.

See Also:

getVersionId(), setVersionId(String)