com.aliyun.oss.model

Class Bucket

java.lang.Object

com.aliyun.oss.model.GenericResult

com.aliyun.oss.model.Bucket

public class Bucket
extends GenericResult

Bucket is the namespace in OSS. You could think it's a folder or container under OSS.

Bucket name is globally unique in OSS and is immutable. Every object must belong to a bucket. An application such as picture sharing website could be mapped to one or multiple buckets. An OSS account could only create up to 10 bucket. And there's no limit on the files count or size under a bucket.

Bucket naming rules:

• Can only contain low case letter, number or dash(-).
• Can only start with low case letter or number.
• The length must be between 3 to 63 bytes.

Constructor Summary

Constructors

Constructor and Description
Bucket() Default constructor.
Bucket(String name) Constructor with the bucket name parameter.
Bucket(String name, String requestId)

Method Summary

Modifier and Type	Method and Description
String	getAccessMonitor()
Date	getCreationDate() Gets the bucket's creation time.
String	getExtranetEndpoint() Gets the external endpoint.
String	getHnsStatus()
String	getIntranetEndpoint() Gets the internal endpoint.
String	getLocation() Gets the bucket location.
String	getName() Gets the bucket name
Owner	getOwner() Gets the Owner.
String	getRegion() Gets the region.
String	getResourceGroupId() Gets the id of resource group.
StorageClass	getStorageClass() Gets the storage class
String	getXcType()
void	setAccessMonitor(String accessMonitor)
void	setCreationDate(Date creationDate) Sets teh bucket's creation time.(it's only used by SDK itself).
void	setExtranetEndpoint(String endpoint) Sets the external endpoint.
void	setHnsStatus(String hnsStatus) set hierarchical namespace status.
void	setIntranetEndpoint(String endpoint) Sets the internal endpoint.
void	setLocation(String location) Sets the bucket location.
void	setName(String name) Sets the bucket name (should only be used by the SDK itself).
void	setOwner(Owner owner) Sets the bucket owner (only used by SDK itself).
void	setRegion(String region) Sets the region.
void	setResourceGroupId(String resourceGroupId) set the id of resource group.
void	setStorageClass(StorageClass storageClass) Sets the bucket's storage class
void	setXcType(String xcType)
String	toString() The override of toString().

Methods inherited from class com.aliyun.oss.model.GenericResult

getClientCRC, getRequestId, getResponse, getServerCRC, setClientCRC, setRequestId, setResponse, setServerCRC

Methods inherited from class java.lang.Object

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

Constructor Detail

Bucket

public Bucket()

Default constructor.

Bucket

public Bucket(String name)

Constructor with the bucket name parameter.

Parameters:

name - Bucket name.

Bucket

public Bucket(String name,
              String requestId)

Method Detail

toString

public String toString()

The override of toString(). Returns the bucket name, creation date, owner and location, with optional storage class.

Overrides:

toString in class Object

getOwner

public Owner getOwner()

Gets the Owner.

Returns:

The bucket owner or null if the owner is not known.

setOwner

public void setOwner(Owner owner)

Sets the bucket owner (only used by SDK itself).

Parameters:

owner - Bucket owner.

getCreationDate

public Date getCreationDate()

Gets the bucket's creation time.

Returns:

Bucket's creation time or null if the creation time is unknown.

setCreationDate

public void setCreationDate(Date creationDate)

Sets teh bucket's creation time.(it's only used by SDK itself).

Parameters:

creationDate - Bucket's creation time.

getName

public String getName()

Gets the bucket name

Returns:

Bucket name.

setName

public void setName(String name)

Sets the bucket name (should only be used by the SDK itself).

Parameters:

name - Bucket name.

getLocation

public String getLocation()

Gets the bucket location.

Returns:

Bucket location.

setLocation

public void setLocation(String location)

Sets the bucket location.

Parameters:

location - the bucket location

getStorageClass

public StorageClass getStorageClass()

Gets the storage class

Returns:

storage class

setStorageClass

public void setStorageClass(StorageClass storageClass)

Sets the bucket's storage class

Parameters:

storageClass - the storage class

getExtranetEndpoint

public String getExtranetEndpoint()

Gets the external endpoint.

Returns:

external endpoint

setExtranetEndpoint

public void setExtranetEndpoint(String endpoint)

Sets the external endpoint.

Parameters:

endpoint - external endpoint

getIntranetEndpoint

public String getIntranetEndpoint()

Gets the internal endpoint.

Returns:

Internal endpoint

setIntranetEndpoint

public void setIntranetEndpoint(String endpoint)

Sets the internal endpoint.

Parameters:

endpoint - Internal endpoint

getRegion

public String getRegion()

Gets the region.

Returns:

Region

setRegion

public void setRegion(String region)

Sets the region.

Parameters:

region - Region

getHnsStatus

public String getHnsStatus()

Returns:

hierarchical namespace status, refer to HnsStatustoString()

setHnsStatus

public void setHnsStatus(String hnsStatus)

set hierarchical namespace status.

Parameters:

hnsStatus - the hierarchical namespace status.

getResourceGroupId

public String getResourceGroupId()

Gets the id of resource group.

Returns:

the id of resource group

setResourceGroupId

public void setResourceGroupId(String resourceGroupId)

set the id of resource group.

Parameters:

resourceGroupId - the resource group id.

getXcType

public String getXcType()

setXcType

public void setXcType(String xcType)

getAccessMonitor

public String getAccessMonitor()

setAccessMonitor

public void setAccessMonitor(String accessMonitor)