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

Class DeleteBucketRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, S3AccelerateUnsupported, Serializable, Cloneable

public class DeleteBucketRequest
extends AmazonWebServiceRequest
implements Serializable, S3AccelerateUnsupported

Provides options for deleting a specified bucket. Amazon S3 buckets can only be deleted when empty.

Note: When attempting to delete a bucket 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
DeleteBucketRequest(String bucketName) Constructs a new DeleteBucketRequest, ready to be executed to delete the specified bucket.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Gets the name of the Amazon S3 bucket to delete.
void	setBucketName(String bucketName) Sets the name of the Amazon S3 bucket to delete.

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

DeleteBucketRequest

public DeleteBucketRequest(String bucketName)

Constructs a new DeleteBucketRequest, ready to be executed to delete the specified bucket.

Parameters:

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

Method Detail

setBucketName

public void setBucketName(String bucketName)

Sets the name of the Amazon S3 bucket to delete.

Parameters:

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

See Also:

DeleteBucketRequest.getBucketName()

getBucketName

public String getBucketName()

Gets the name of the Amazon S3 bucket to delete.

Returns:

The name of the Amazon S3 bucket to delete.

See Also:

DeleteBucketRequest.setBucketName(String)