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

Class CreateBucketRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, S3AccelerateUnsupported, Serializable, Cloneable

public class CreateBucketRequest
extends AmazonWebServiceRequest
implements Serializable, S3AccelerateUnsupported

Provides options for creating an Amazon S3 bucket.

See Also:

DeleteBucketRequest, CopyObjectRequest, Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateBucketRequest(String bucketName) Constructs a new CreateBucketRequest, ready to be executed to create the specified bucket in the US_Standard region.
CreateBucketRequest(String bucketName, Region region) Constructs a new CreateBucketRequest, ready to be executed to create the specified bucket in the specified region.
CreateBucketRequest(String bucketName, String region) Constructs a new CreateBucketRequest, ready to be executed and create the specified bucket in the specified region.

Method Summary

Modifier and Type	Method and Description
AccessControlList	getAccessControlList() Returns the optional access control list for the new bucket.
String	getBucketName() Gets the name of the Amazon S3 bucket to create.
CannedAccessControlList	getCannedAcl() Returns the optional Canned ACL to set for the new bucket.
com.ibm.cloud.objectstorage.services.s3.model.EncryptionType	getEncryptionType() Gets the encryptionType of the S3 bucket to create.
boolean	getObjectLockEnabledForBucket() Specifies whether you want S3 Object Lock to be enabled for the new bucket.
String	getRegion() Deprecated.
String	getServiceInstanceId() Gets the IBM service instance Id
void	setAccessControlList(AccessControlList accessControlList) Sets the optional access control list for the new bucket.
void	setBucketName(String bucketName) Sets the name of the Amazon S3 bucket to create.
void	setCannedAcl(CannedAccessControlList cannedAcl) Sets the optional Canned ACL to set for the new bucket.
void	setEncryptionType(com.ibm.cloud.objectstorage.services.s3.model.EncryptionType encryptionType) Sets the encryptionType bucket to create.
void	setObjectLockEnabledForBucket(boolean objectLockEnabled) Specifies whether you want S3 Object Lock to be enabled for the new bucket.
void	setRegion(String region) Deprecated. Use regional client instead to create bucket in that region.
void	setServiceInstanceId(String serviceInstanceId) Set the IBM service instance Id used on the header for the CreateBucketRequest
CreateBucketRequest	withAccessControlList(AccessControlList accessControlList) Sets the optional access control list for the new bucket.
CreateBucketRequest	withCannedAcl(CannedAccessControlList cannedAcl) Sets the optional Canned ACL to set for the new bucket, and returns this updated object so that additional method calls can be chained together.
CreateBucketRequest	withEncryptionType(com.ibm.cloud.objectstorage.services.s3.model.EncryptionType encryptionType)
CreateBucketRequest	withObjectLockEnabledForBucket(boolean objectLockEnabled) Specifies whether you want S3 Object Lock to be enabled for the new bucket.
CreateBucketRequest	withServiceInstanceId(String serviceInstanceId) Sets the serviceInstanceId on the Request Object.

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

CreateBucketRequest

public CreateBucketRequest(String bucketName)

Constructs a new CreateBucketRequest, ready to be executed to create the specified bucket in the US_Standard region.

Parameters:

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

See Also:

CreateBucketRequest(String, Region), CreateBucketRequest(String, String)

CreateBucketRequest

public CreateBucketRequest(String bucketName,
                           Region region)

Constructs a new CreateBucketRequest, ready to be executed to create the specified bucket in the specified region.

Parameters:

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

region - The region in which to create this bucket. This must match the region of the endpoint the client is configured against unless the client is configured against the US Standard endpoint (s3.amazonaws.com).

See Also:

CreateBucketRequest(String), CreateBucketRequest(String, String)

CreateBucketRequest

public CreateBucketRequest(String bucketName,
                           String region)

Constructs a new CreateBucketRequest, ready to be executed and create the specified bucket in the specified region.

Parameters:

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

region - The region in which to create this bucket. This must match the region of the endpoint the client is configured against unless the client is configured against the US Standard endpoint (s3.amazonaws.com).

See Also:

CreateBucketRequest(String), CreateBucketRequest(String, Region)

Method Detail

setBucketName

public void setBucketName(String bucketName)

Sets the name of the Amazon S3 bucket to create.

Parameters:

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

See Also:

CreateBucketRequest.getBucketName()

getBucketName

public String getBucketName()

Gets the name of the Amazon S3 bucket to create.

Returns:

The name of the Amazon S3 bucket to create.

See Also:

CreateBucketRequest.setBucketName(String)

getEncryptionType

public com.ibm.cloud.objectstorage.services.s3.model.EncryptionType getEncryptionType()

Gets the encryptionType of the S3 bucket to create.

Returns:

The encryptionType of the S3 bucket to create.

See Also:

CreateBucketRequest.setEncryptionType(EncryptionType)

setEncryptionType

public void setEncryptionType(com.ibm.cloud.objectstorage.services.s3.model.EncryptionType encryptionType)

Sets the encryptionType bucket to create.

Parameters:

encryptionType - The encryptionType of the S3 bucket to create.

See Also:

CreateBucketRequest.getEncryptionType()

withEncryptionType

public CreateBucketRequest withEncryptionType(com.ibm.cloud.objectstorage.services.s3.model.EncryptionType encryptionType)

setRegion

@Deprecated
public void setRegion(String region)

Deprecated. Use regional client instead to create bucket in that region.

Sets the name of the Amazon S3 region in which this bucket will be created.

Parameters:

region - The region in which to create this bucket. This must match the region of the endpoint the client is configured against unless the client is configured against the US Standard endpoint (s3.amazonaws.com).

See Also:

CreateBucketRequest.getRegion()

getRegion

@Deprecated
public String getRegion()

Deprecated.

Gets the name of the Amazon S3 region in which this bucket will be created.

Returns:

The name of the Amazon S3 region in which this bucket will be created.

See Also:

CreateBucketRequest.setRegion(String)

getServiceInstanceId

public String getServiceInstanceId()

Gets the IBM service instance Id

Returns:

The IBM Service Instance Id

setServiceInstanceId

public void setServiceInstanceId(String serviceInstanceId)

Set the IBM service instance Id used on the header for the CreateBucketRequest

Parameters:

serviceInstanceId - IBM service instance Id

getCannedAcl

public CannedAccessControlList getCannedAcl()

Returns the optional Canned ACL to set for the new bucket.

Returns:

The optional Canned ACL to set for the new bucket.

setCannedAcl

public void setCannedAcl(CannedAccessControlList cannedAcl)

Sets the optional Canned ACL to set for the new bucket.

Parameters:

cannedAcl - The optional Canned ACL to set for the new bucket.

withCannedAcl

public CreateBucketRequest withCannedAcl(CannedAccessControlList cannedAcl)

Sets the optional Canned ACL to set for the new bucket, and returns this updated object so that additional method calls can be chained together.

Parameters:

cannedAcl - The optional Canned ACL to set for the new bucket.

Returns:

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

getAccessControlList

public AccessControlList getAccessControlList()

Returns the optional access control list for the new bucket. If specified, cannedAcl will be ignored.

setAccessControlList

public void setAccessControlList(AccessControlList accessControlList)

Sets the optional access control list for the new bucket. If specified, cannedAcl will be ignored.

Parameters:

accessControlList - The access control list for the new bucket.

withAccessControlList

public CreateBucketRequest withAccessControlList(AccessControlList accessControlList)

Sets the optional access control list for the new bucket. If specified, cannedAcl will be ignored. Returns this CreateBucketRequest, enabling additional method calls to be chained together.

Parameters:

accessControlList - The access control list for the new bucket.

getObjectLockEnabledForBucket

public boolean getObjectLockEnabledForBucket()

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

withObjectLockEnabledForBucket

public CreateBucketRequest withObjectLockEnabledForBucket(boolean objectLockEnabled)

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

setObjectLockEnabledForBucket

public void setObjectLockEnabledForBucket(boolean objectLockEnabled)

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

withServiceInstanceId

public CreateBucketRequest withServiceInstanceId(String serviceInstanceId)

Sets the serviceInstanceId on the Request Object. This value will supersede any already set on by CredentialProvider

Parameters:

serviceInstanceId - The IBM Service Instance Id

Returns:

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