com.ibm.cloud.objectstorage.services.s3.model

Class SetBucketVersioningConfigurationRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.SetBucketVersioningConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class SetBucketVersioningConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable

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 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.

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

See Also:

SetBucketVersioningConfigurationRequest(String, BucketVersioningConfiguration), SetBucketVersioningConfigurationRequest(String, BucketVersioningConfiguration, MultiFactorAuthentication), Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetBucketVersioningConfigurationRequest(String bucketName, BucketVersioningConfiguration configuration) Constructs a new SetBucketVersioningConfigurationRequest to set the bucket versioning configuration of the specified bucket.
SetBucketVersioningConfigurationRequest(String bucketName, BucketVersioningConfiguration configuration, MultiFactorAuthentication mfa) Constructs a new SetBucketVersioningConfigurationRequest to set the bucket versioning configuration of the specified bucket, including the specified Multi-Factor Authentication (MFA) information, which is required when changing the state of the MFA Delete option.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Gets the name of the bucket whose versioning configuration is being set.
MultiFactorAuthentication	getMfa() Gets the optional Multi-Factor Authentication information included with this request.
BucketVersioningConfiguration	getVersioningConfiguration() Gets the new versioning configuration for the specified bucket.
void	setBucketName(String bucketName) Sets the name of the bucket whose versioning configuration is being set.
void	setMfa(MultiFactorAuthentication mfa) Sets the optional Multi-Factor Authentication information to include with this request.
void	setVersioningConfiguration(BucketVersioningConfiguration versioningConfiguration) Sets the new versioning configuration for the specified bucket.
SetBucketVersioningConfigurationRequest	withBucketName(String 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.
SetBucketVersioningConfigurationRequest	withMfa(MultiFactorAuthentication mfa) Sets the optional Multi-Factor Authentication information to include with this request, and returns this object so that additional method calls may be chained together.
SetBucketVersioningConfigurationRequest	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.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

SetBucketVersioningConfigurationRequest

public SetBucketVersioningConfigurationRequest(String bucketName,
                                               BucketVersioningConfiguration configuration)

Constructs a new SetBucketVersioningConfigurationRequest 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:

SetBucketVersioningConfigurationRequest(String, BucketVersioningConfiguration, MultiFactorAuthentication)

SetBucketVersioningConfigurationRequest

public SetBucketVersioningConfigurationRequest(String bucketName,
                                               BucketVersioningConfiguration configuration,
                                               MultiFactorAuthentication mfa)

Constructs a new SetBucketVersioningConfigurationRequest to set the bucket versioning configuration of the specified bucket, including the specified Multi-Factor Authentication (MFA) information, which is required when changing the state of the MFA Delete option.

Parameters:

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

configuration - The new versioning configuration for the specified bucket.

mfa - The Multi-Factor Authentication information to include in this request.

See Also:

SetBucketVersioningConfigurationRequest(String, BucketVersioningConfiguration)

Method Detail

getBucketName

public String getBucketName()

Gets the name of the bucket whose versioning configuration is being set.

Returns:

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

See Also:

SetBucketVersioningConfigurationRequest.setBucketName(String)

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket whose versioning configuration is being set.

Parameters:

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

See Also:

SetBucketVersioningConfigurationRequest.getBucketName()

withBucketName

public SetBucketVersioningConfigurationRequest withBucketName(String 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.

Parameters:

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

Returns:

This SetBucketVersioningConfigurationRequest object so that additional method calls may be chained together.

See Also:

SetBucketVersioningConfigurationRequest.setBucketName(String)

getVersioningConfiguration

public BucketVersioningConfiguration getVersioningConfiguration()

Gets the new versioning configuration for the specified bucket.

Returns:

The new versioning configuration for the specified bucket.

See Also:

SetBucketVersioningConfigurationRequest.setVersioningConfiguration(BucketVersioningConfiguration), SetBucketVersioningConfigurationRequest.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:

SetBucketVersioningConfigurationRequest.getVersioningConfiguration(), SetBucketVersioningConfigurationRequest.withVersioningConfiguration(BucketVersioningConfiguration)

withVersioningConfiguration

public SetBucketVersioningConfigurationRequest 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 SetBucketVersioningConfigurationRequest object, enabling that additional method calls may be chained together.

See Also:

SetBucketVersioningConfigurationRequest.getVersioningConfiguration(), SetBucketVersioningConfigurationRequest.getVersioningConfiguration()

getMfa

public MultiFactorAuthentication getMfa()

Gets the optional Multi-Factor Authentication information included with this request.

Multi-Factor Authentication is required when enabling or disabling MFA Delete functionality for a bucket.

See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean) for more information on MFADelete.

Returns:

The optional Multi-Factor Authentication information included with this request.

See Also:

SetBucketVersioningConfigurationRequest.setMfa(MultiFactorAuthentication), SetBucketVersioningConfigurationRequest.withMfa(MultiFactorAuthentication)

setMfa

public void setMfa(MultiFactorAuthentication mfa)

Sets the optional Multi-Factor Authentication information to include with this request.

Multi-Factor Authentication is required when enabling or disabling MFA delete functionality for a bucket.

See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean) for more information on MFADelete.

Parameters:

mfa - The optional Multi-Factor Authentication information to include with this request.

See Also:

SetBucketVersioningConfigurationRequest.getMfa(), SetBucketVersioningConfigurationRequest.withMfa(MultiFactorAuthentication)

withMfa

public SetBucketVersioningConfigurationRequest withMfa(MultiFactorAuthentication mfa)

Sets the optional Multi-Factor Authentication information to include with this request, and returns this object so that additional method calls may be chained together.

Multi-Factor Authentication is required when enabling or disabling MFA delete functionality for a bucket.

See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean) for more information on MFADelete.

Parameters:

mfa - The optional Multi-Factor Authentication information to include with this request.

Returns:

The updated SetBucketVersioningConfigurationRequest object so that additional method calls may be chained together.

See Also:

SetBucketVersioningConfigurationRequest.getMfa(), SetBucketVersioningConfigurationRequest.setMfa(MultiFactorAuthentication)