com.netease.cloud.services.nos.model.SetBucketVersioningConfigurationRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nos-sdk-java-publiccloud Show documentation
nos java sdk to the Central Repository
The newest version!
package com.netease.cloud.services.nos.model;

import com.netease.cloud.WebServiceRequest;
import com.netease.cloud.services.nos.internal.Constants;

/**
 * 
 * Contains options for setting the versioning configuration for a bucket.
 * 
 * 
 * A bucket's versioning configuration can be in one of three possible states:
 * 

 * {@link BucketVersioningConfiguration#DISABLED}
 * 
{@link BucketVersioningConfiguration#ENABLED}
 * 
{@link BucketVersioningConfiguration#SUSPENDED}
 * 
 * 
 * 
 * By default, new buckets are created in the
 * {@link BucketVersioningConfiguration#DISABLED} state. Once versioning is
 * enabled for a bucket, its status can never be reverted to
 * {@link BucketVersioningConfiguration#DISABLED off}.
 * 
 * 
 * Objects created before versioning is enabled or while versioning is suspended
 * will be given the default null version ID (see
 * {@link Constants#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.
 * 
 * 
 * Nos is eventually consistent. It may take time for the versioning status of a
 * bucket to be propagated throughout the system.
 * 
 * 
 * @see SetBucketVersioningConfigurationRequest#SetBucketVersioningConfigurationRequest(String,
 *      BucketVersioningConfiguration)
 * @see SetBucketVersioningConfigurationRequest#SetBucketVersioningConfigurationRequest(String,
 *      BucketVersioningConfiguration, MultiFactorAuthentication)
 */
public class SetBucketVersioningConfigurationRequest extends WebServiceRequest {

	/**
	 * The bucket whose versioning configuration is being set.
	 */
	private String bucketName;

	/**
	 * The new versioning configuration for the specified bucket.
	 */
	private BucketVersioningConfiguration versioningConfiguration;

	/**
	 * Constructs a new {@link SetBucketVersioningConfigurationRequest} to set
	 * the bucket versioning configuration of the specified bucket.
	 * 
	 * @param bucketName
	 *            The name of the bucket whose versioning configuration is being
	 *            set.
	 * @param configuration
	 *            The new versioning configuration for the specified bucket.
	 * 
	 * @see SetBucketVersioningConfigurationRequest#SetBucketVersioningConfigurationRequest(String,
	 *      BucketVersioningConfiguration, MultiFactorAuthentication)
	 */
	public SetBucketVersioningConfigurationRequest(String bucketName, BucketVersioningConfiguration configuration) {
		this.bucketName = bucketName;
		this.versioningConfiguration = configuration;
	}

	/**
	 * 
	 * @param bucketName
	 * @param configuration
	 *            valid value include 'Enabled','Disabled' and 'Suspended', but at here
	 *            don't judge this value valid or invalid
	 */
	public SetBucketVersioningConfigurationRequest(String bucketName, String configuration) {
		this.bucketName = bucketName;
		this.versioningConfiguration = new BucketVersioningConfiguration(configuration);
	}

	/**
	 * Gets the name of the bucket whose versioning configuration is being set.
	 * 
	 * @return The name of the bucket whose versioning configuration is being
	 *         set.
	 * 
	 * @see SetBucketVersioningConfigurationRequest#setBucketName(String)
	 */
	public String getBucketName() {
		return bucketName;
	}

	/**
	 * Sets the name of the bucket whose versioning configuration is being set.
	 * 
	 * @param bucketName
	 *            The name of the bucket whose versioning configuration is being
	 *            set.
	 * 
	 * @see SetBucketVersioningConfigurationRequest#getBucketName()
	 */
	public void setBucketName(String bucketName) {
		this.bucketName = bucketName;
	}

	/**
	 * Sets the name of the bucket whose versioning configuration is being set,
	 * and returns this object so that additional method calls may be chained
	 * together.
	 * 
	 * @param bucketName
	 *            The name of the bucket whose versioning configuration is being
	 *            set.
	 * 
	 * @return This {@link SetBucketVersioningConfigurationRequest} object so
	 *         that additional method calls may be chained together.
	 * 
	 * @see SetBucketVersioningConfigurationRequest#setBucketName(String)
	 */
	public SetBucketVersioningConfigurationRequest withBucketName(String bucketName) {
		setBucketName(bucketName);
		return this;
	}

	/**
	 * Gets the new versioning configuration for the specified bucket.
	 * 
	 * @return The new versioning configuration for the specified bucket.
	 * 
	 * @see SetBucketVersioningConfigurationRequest#setVersioningConfiguration(BucketVersioningConfiguration)
	 * @see SetBucketVersioningConfigurationRequest#withVersioningConfiguration(BucketVersioningConfiguration)
	 */
	public BucketVersioningConfiguration getVersioningConfiguration() {
		return versioningConfiguration;
	}

	/**
	 * Sets the new versioning configuration for the specified bucket.
	 * 
	 * @param versioningConfiguration
	 *            The new versioning configuration for the specified bucket.
	 * 
	 * @see SetBucketVersioningConfigurationRequest#getVersioningConfiguration()
	 * @see SetBucketVersioningConfigurationRequest#withVersioningConfiguration(BucketVersioningConfiguration)
	 */
	public void setVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration) {
		this.versioningConfiguration = versioningConfiguration;
	}
	
	public void setVersioningConfiguration(String versioningConfiguration) {
		this.versioningConfiguration = new BucketVersioningConfiguration(versioningConfiguration);
	}

	/**
	 * Sets the new versioning configuration for the specified bucket and
	 * returns this object, enabling additional method calls to be chained
	 * together.
	 * 
	 * @param versioningConfiguration
	 *            The new versioning configuration for the specified bucket.
	 * 
	 * @return This {@link SetBucketVersioningConfigurationRequest} object,
	 *         enabling that additional method calls may be chained together.
	 * 
	 * @see SetBucketVersioningConfigurationRequest#getVersioningConfiguration()
	 * @see SetBucketVersioningConfigurationRequest#getVersioningConfiguration()
	 */
	public SetBucketVersioningConfigurationRequest withVersioningConfiguration(
			BucketVersioningConfiguration versioningConfiguration) {
		setVersioningConfiguration(versioningConfiguration);
		return this;
	}

}