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

Class DeleteVersionRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class DeleteVersionRequest
extends AmazonWebServiceRequest
implements Serializable

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 AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

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

See Also:

Serialized Form

Field Summary

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

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.
DeleteVersionRequest(String bucketName, String key, String versionId, MultiFactorAuthentication mfa) 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, with the specified Multi-Factor Authentication (MFA) information.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Gets the name of the Amazon S3 bucket containing the version to delete.
String	getKey() Gets the key of the version to delete.
MultiFactorAuthentication	getMfa() Gets the optional Multi-Factor Authentication information included with this request.
String	getVersionId() Gets the version ID uniquely identifying which version of the object to delete.
void	setBucketName(String bucketName) Sets the name of the Amazon S3 bucket containing the version to delete.
void	setKey(String key) Sets the key of the version to delete.
void	setMfa(MultiFactorAuthentication mfa) Sets the optional Multi-Factor Authentication information to include with this request.
void	setVersionId(String versionId) Sets the version ID uniquely identifying which version of the object to delete.
DeleteVersionRequest	withBucketName(String bucketName) Sets the name of the Amazon S3 bucket containing the version to delete.
DeleteVersionRequest	withKey(String key) Sets the key of the version to delete Returns this DeleteVersionRequest, enabling additional method calls to be chained together.
DeleteVersionRequest	withMfa(MultiFactorAuthentication mfa) Sets the optional Multi-Factor Authentication information to include with this request Returns this DeleteVersionRequest, enabling additional method calls to be chained together.
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.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

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.

See Also:

DeleteVersionRequest(String, String, String, MultiFactorAuthentication)

DeleteVersionRequest

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

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, with the specified Multi-Factor Authentication (MFA) information. Multi-Factor Authentication is required when the MFA Delete option has been enabled for a bucket's versioning configuration. See BucketVersioningConfiguration for more details on MFA Delete.

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 uniquely identifying the version to delete.

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

See Also:

DeleteVersionRequest(String, String, String)

Method Detail

getBucketName

public String getBucketName()

Gets the name of the Amazon S3 bucket containing the version to delete.

Returns:

The name of the Amazon S3 bucket containing the version to delete.

See Also:

DeleteVersionRequest.setBucketName(String), DeleteVersionRequest.withBucketName(String)

setBucketName

public void setBucketName(String bucketName)

Sets the name of the Amazon S3 bucket containing the version to delete.

Parameters:

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

See Also:

DeleteVersionRequest.getBucketName(), DeleteVersionRequest.withBucketName(String)

withBucketName

public DeleteVersionRequest withBucketName(String bucketName)

Sets the name of the Amazon S3 bucket containing the version to delete. Returns this DeleteVersionRequest, enabling additional method calls to be chained together.

Parameters:

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

Returns:

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

See Also:

DeleteVersionRequest.getBucketName(), DeleteVersionRequest.setBucketName(String)

getKey

public String getKey()

Gets the key of the version to delete.

Returns:

The key of the version to delete.

See Also:

DeleteVersionRequest.setKey(String), DeleteVersionRequest.withKey(String)

setKey

public void setKey(String key)

Sets the key of the version to delete.

Parameters:

key - The key of the version to delete.

See Also:

DeleteVersionRequest.getKey(), DeleteVersionRequest.withKey(String)

withKey

public DeleteVersionRequest withKey(String key)

Sets the key of the version to delete Returns this DeleteVersionRequest, enabling additional method calls to be chained together.

Parameters:

key - The key of the version to delete.

Returns:

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

See Also:

DeleteVersionRequest.getKey(), DeleteVersionRequest.setKey(String)

getVersionId

public String getVersionId()

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

Returns:

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

See Also:

DeleteVersionRequest.setVersionId(String), DeleteVersionRequest.withVersionId(String)

setVersionId

public void setVersionId(String versionId)

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

Parameters:

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

See Also:

DeleteVersionRequest.getVersionId(), DeleteVersionRequest.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.

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:

DeleteVersionRequest.getVersionId(), DeleteVersionRequest.setVersionId(String)

getMfa

public MultiFactorAuthentication getMfa()

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

Multi-Factor Authentication is required when deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration.

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

Returns:

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

See Also:

DeleteVersionRequest.setMfa(MultiFactorAuthentication), DeleteVersionRequest.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 deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration.

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

Parameters:

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

See Also:

DeleteVersionRequest.getMfa(), DeleteVersionRequest.withMfa(MultiFactorAuthentication)

withMfa

public DeleteVersionRequest withMfa(MultiFactorAuthentication mfa)

Sets the optional Multi-Factor Authentication information to include with this request Returns this DeleteVersionRequest, enabling additional method calls to be chained together.

Multi-Factor Authentication is required when deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration

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

Parameters:

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

Returns:

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

See Also:

DeleteVersionRequest.getMfa(), DeleteVersionRequest.withMfa(MultiFactorAuthentication)