com.aliyun.oss.model

Class SetBucketVersioningRequest

java.lang.Object

com.aliyun.oss.model.WebServiceRequest

com.aliyun.oss.model.GenericRequest

com.aliyun.oss.model.SetBucketVersioningRequest

public class SetBucketVersioningRequest
extends GenericRequest

Contains options for setting the versioning configuration for a bucket.

A bucket's versioning configuration can be in one of three possible states:

• BucketVersioningConfiguration.OFF
• BucketVersioningConfiguration.ENABLED
• BucketVersioningConfiguration.SUSPENDED

By default, new buckets are created in the BucketVersioningConfiguration.OFF state. Once versioning is enabled for a bucket, its status can never be reverted to off.

Objects created before versioning is enabled or while versioning is suspended will be given the default null version ID (see OSSConstants.NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as having no version ID.

The versioning configuration of a bucket has different implications for each operation performed on that bucket or for objects within that bucket. When versioning is enabled, a PutObject operation creates a unique object version ID for the object being uploaded. The PutObject operation guarantees that if versioning is enabled for a bucket at the time of the request, the new object can only be permanently deleted by calling the DeleteVersion operation and can never be overwritten.

Additionally, the PutObject operation guarantees that if versioning is enabled for a bucket at the time of the request, no other object will be overwritten by that request. Refer to the documentation sections for individual APIs for information on how versioning status affects the semantics of that particular API.

OSS is eventually consistent. It may take time for the versioning status of a bucket to be propagated throughout the system.

See Also:

SetBucketVersioningRequest(String, BucketVersioningConfiguration)

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
SetBucketVersioningRequest(String bucketName, BucketVersioningConfiguration configuration) Constructs a new SetBucketVersioningRequest to set the bucket versioning configuration of the specified bucket.

Method Summary

Methods

Modifier and Type	Method and Description
BucketVersioningConfiguration	getVersioningConfiguration() Gets the new versioning configuration for the specified bucket.
void	setVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration) Sets the new versioning configuration for the specified bucket.
SetBucketVersioningRequest	withVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration) Sets the new versioning configuration for the specified bucket and returns this object, enabling additional method calls to be chained together.

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

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

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

SetBucketVersioningRequest

public SetBucketVersioningRequest(String bucketName,
                          BucketVersioningConfiguration configuration)

Constructs a new SetBucketVersioningRequest to set the bucket versioning configuration of the specified bucket.

Parameters:

bucketName - The name of the bucket whose versioning configuration is being set.

configuration - The new versioning configuration for the specified bucket.

See Also:

SetBucketVersioningRequest(String, BucketVersioningConfiguration)

Method Detail

getVersioningConfiguration

public BucketVersioningConfiguration getVersioningConfiguration()

Gets the new versioning configuration for the specified bucket.

Returns:

The new versioning configuration for the specified bucket.

See Also:

setVersioningConfiguration(BucketVersioningConfiguration), withVersioningConfiguration(BucketVersioningConfiguration)

setVersioningConfiguration

public void setVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration)

Sets the new versioning configuration for the specified bucket.

Parameters:

versioningConfiguration - The new versioning configuration for the specified bucket.

See Also:

getVersioningConfiguration(), withVersioningConfiguration(BucketVersioningConfiguration)

withVersioningConfiguration

public SetBucketVersioningRequest withVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration)

Sets the new versioning configuration for the specified bucket and returns this object, enabling additional method calls to be chained together.

Parameters:

versioningConfiguration - The new versioning configuration for the specified bucket.

Returns:

This SetBucketVersioningRequest object, enabling that additional method calls may be chained together.

See Also:

getVersioningConfiguration(), getVersioningConfiguration()