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

Class Bucket

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class Bucket
extends Object
implements Serializable

Represents an Amazon S3 bucket.

Every object stored in Amazon S3 is contained within a bucket. Buckets partition the namespace of objects stored in Amazon S3 at the top level. Within a bucket, any name can be used for objects. However, bucket names must be unique across all of Amazon S3.

Bucket ownership is similar to the ownership of Internet domain names. Within Amazon S3, only a single user owns each bucket. Once a uniquely named bucket is created in Amazon S3, organize and name the objects within the bucket in any way. Ownership of the bucket is retained as long as the owner has an Amazon S3 account.

To conform with DNS requirements, the following constraints apply:

• Bucket names should not contain underscores
• Bucket names should be between 3 and 63 characters long
• Bucket names should not end with a dash
• Bucket names cannot contain adjacent periods
• Bucket names cannot contain dashes next to periods (e.g., "my-.bucket.com" and "my.-bucket" are invalid)
• Bucket names cannot contain uppercase characters

There are no limits to the number of objects that can be stored in a bucket. Performance does not vary based on the number of buckets used. Store all objects within a single bucket or organize them across several buckets.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Bucket() Constructs a bucket without any name specified.
Bucket(String name) Creates a bucket with a name.

Method Summary

Modifier and Type	Method and Description
Date	getCreationDate() Gets the bucket's creation date.
String	getCreationTemplateId() IBM Returns the creationTemplateId associated with the bucket.
String	getLocationConstraint() IBM Returns the locationConstraint associated with the bucket This will only have populated information when used in conjunction with the Extended Listing support to the COS S3 GET Service API
String	getName() Gets the name of the bucket.
Owner	getOwner() Gets the bucket's owner.
void	setCreationDate(Date creationDate) For internal use only.
void	setCreationTemplateId(String creationTemplateId) For internal use only: IBM set the bucket creationTemplateId from the api response
void	setLocationConstraint(String locationConstraint) For internal use only: IBM set the bucket locationConstraint from the api response
void	setName(String name) Sets the name of the bucket.
void	setOwner(Owner owner) For internal use only.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Bucket

public Bucket()

Constructs a bucket without any name specified.

See Also:

Bucket(String)

Bucket

public Bucket(String name)

Creates a bucket with a name. All buckets in Amazon S3 share a single namespace; ensure the bucket is given a unique name.

Parameters:

name - The name for the bucket.

See Also:

Bucket()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getOwner

public Owner getOwner()

Gets the bucket's owner. Returns null if the bucket's owner is unknown.

Returns:

The bucket's owner, or null if it is unknown.

See Also:

Bucket.setOwner(Owner)

setOwner

public void setOwner(Owner owner)

For internal use only. Sets the bucket's owner in Amazon S3. This should only be used internally by the Amazon Web Services Java client methods that retrieve information directly from Amazon S3.

Parameters:

owner - The bucket's owner.

See Also:

Bucket.getOwner()

getCreationDate

public Date getCreationDate()

Gets the bucket's creation date. Returns null if the creation date is not known.

Returns:

The bucket's creation date, or null if not known.

setCreationDate

public void setCreationDate(Date creationDate)

For internal use only. Sets the bucket's creation date in S3. This should only be used internally by Amazon Web Services Java client methods that retrieve information directly from Amazon S3.

Parameters:

creationDate - The bucket's creation date.

getName

public String getName()

Gets the name of the bucket.

Returns:

The name of this bucket.

See Also:

Bucket.setName(String)

setName

public void setName(String name)

Sets the name of the bucket. All buckets in Amazon S3 share a single namespace; ensure the bucket is given a unique name.

Parameters:

name - The name for the bucket.

getLocationConstraint

public String getLocationConstraint()

IBM Returns the locationConstraint associated with the bucket This will only have populated information when used in conjunction with the Extended Listing support to the COS S3 GET Service API

Returns:

The locationConstraint on the bucket

setLocationConstraint

public void setLocationConstraint(String locationConstraint)

For internal use only: IBM set the bucket locationConstraint from the api response

Parameters:

locationConstraint - The location constraint for the bucket.

getCreationTemplateId

public String getCreationTemplateId()

IBM Returns the creationTemplateId associated with the bucket. IBM COS returns this field only if a template was used. This will only have populated information when used in conjunction with the Extended Listing support to the COS S3 GET Service API

Returns:

The templateId used on bucket creation

setCreationTemplateId

public void setCreationTemplateId(String creationTemplateId)

For internal use only: IBM set the bucket creationTemplateId from the api response

Parameters:

creationTemplateId - The templateId used on bucket creation