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

Class GetBucketLocationRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class GetBucketLocationRequest
extends AmazonWebServiceRequest
implements Serializable

Provides options for requesting an Amazon S3 bucket's location. You can choose a bucket's location when creating it to ensure that the data stored in your bucket is geographically close to the applications or customers accessing your data.

See Also:

CreateBucketRequest, Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
GetBucketLocationRequest(String bucketName) Constructs a new request object to create a new bucket with the specified name.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the bucket whose location is being requested.
void	setBucketName(String bucketName) Sets the name of the bucket whose location is being requested.
GetBucketLocationRequest	withBucketName(String bucketName) Sets the name of the bucket whose location is being requested, and returns this updated object so that additional method calls can 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

GetBucketLocationRequest

public GetBucketLocationRequest(String bucketName)

Constructs a new request object to create a new bucket with the specified name.

When choosing a bucket name, keep in mind that Amazon S3 bucket names are globally unique.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Parameters:

bucketName - The name for the new bucket or access point ARN.

Method Detail

getBucketName

public String getBucketName()

Returns the name of the bucket whose location is being requested.

Returns:

The name of the bucket whose location is being requested.

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket whose location is being requested.

Parameters:

bucketName - The name of the bucket whose location is being requested.

withBucketName

public GetBucketLocationRequest withBucketName(String bucketName)

Sets the name of the bucket whose location is being requested, and returns this updated object so that additional method calls can be chained together.

Parameters:

bucketName - The name of the bucket whose location is being requested.

Returns:

This updated object, so that additional method calls can be chained together.