com.amazonaws.services.s3.model

Class HeadBucketRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.HeadBucketRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, Serializable, Cloneable

public class HeadBucketRequest
extends AmazonWebServiceRequest
implements Serializable, ExpectedBucketOwnerRequest

Request object for checking if the bucket exists and the user has access to the given bucket.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
HeadBucketRequest(String bucketName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBucketName() The bucket name.
String	getExpectedBucketOwner() Returns he account id of the expected bucket owner.
int	hashCode()
void	setBucketName(String bucketName) The bucket name.
void	setExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
HeadBucketRequest	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

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeadBucketRequest

public HeadBucketRequest(String bucketName)

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 HeadBucketRequest 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)

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

getBucketName

public String getBucketName()

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

Returns:

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object