com.amazonaws.services.s3.model

Class DeleteBucketRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.DeleteBucketRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, S3AccelerateUnsupported, Serializable, Cloneable

public class DeleteBucketRequest
extends AmazonWebServiceRequest
implements Serializable, S3AccelerateUnsupported, ExpectedBucketOwnerRequest

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.amazonaws.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.
String	getExpectedBucketOwner() Returns he account id of the expected bucket owner.
void	setBucketName(String bucketName) Sets the name of the Amazon S3 bucket to delete.
void	setExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
DeleteBucketRequest	withExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, clone, 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, 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

getExpectedBucketOwner

public String getExpectedBucketOwner()

Description copied from interface: ExpectedBucketOwnerRequest

Returns he account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

getExpectedBucketOwner in interface ExpectedBucketOwnerRequest

withExpectedBucketOwner

public DeleteBucketRequest withExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set the account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

withExpectedBucketOwner in interface ExpectedBucketOwnerRequest

setExpectedBucketOwner

public void setExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set the account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

setExpectedBucketOwner in interface ExpectedBucketOwnerRequest

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:

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:

setBucketName(String)