com.netease.cloud.services.nos.model.Bucket Maven / Gradle / Ivy
Show all versions of nos-sdk-java-publiccloud Show documentation
package com.netease.cloud.services.nos.model;
import java.util.Date;
/**
*
* Represents an Nos bucket.
*
*
* Every object stored in Nos is contained within a bucket. Buckets partition
* the namespace of objects stored in Nos at the top level. Within a bucket, any
* name can be used for objects. However, bucket names must be unique across all
* of Nos.
*
*
* Bucket ownership is similar to the ownership of Internet domain names. Within
* Nos, only a single user owns each bucket. Once a uniquely named bucket is
* created in Nos, organize and name the objects within the bucket in any way.
* Ownership of the bucket is retained as long as the owner has an Nos 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.
*
*/
public class Bucket {
/** The name of this Nos bucket */
private String name = null;
/** The details on the owner of this bucket */
private Owner owner = null;
/** The date this bucket was created */
private Date creationDate = null;
/**
* Constructs a bucket without any name specified.
*
* @see Bucket#Bucket(String)
*/
public Bucket() {
}
/**
* Creates a bucket with a name. All buckets in Nos share a single
* namespace; ensure the bucket is given a unique name.
*
* @param name
* The name for the bucket.
*
* @see Bucket#Bucket()
*/
public Bucket(String name) {
this.name = name;
}
/**
* @see java.lang.Object#toString()
*/
public String toString() {
return "NosBucket [name=" + getName() + ", creationDate=" + getCreationDate() + ", owner=" + getOwner() + "]";
}
/**
* Gets the bucket's owner. Returns null if the bucket's owner
* is unknown.
*
* @return The bucket's owner, or null if it is unknown.
*
* @see Bucket#setOwner(Owner)
*/
public Owner getOwner() {
return owner;
}
/**
* For internal use only. Sets the bucket's owner in Nos. This should only
* be used internally by the AWS Java client methods that retrieve
* information directly from Nos.
*
* @param owner
* The bucket's owner.
*
* @see Bucket#getOwner()
*/
public void setOwner(Owner owner) {
this.owner = owner;
}
/**
* Gets the bucket's creation date. Returns null if the
* creation date is not known.
*
* @return The bucket's creation date, or null if not known.
*/
public Date getCreationDate() {
return creationDate;
}
/**
* For internal use only. Sets the bucket's creation date in Nos. This
* should only be used internally by AWS Java client methods that retrieve
* information directly from Nos.
*
* @param creationDate
* The bucket's creation date.
*/
public void setCreationDate(Date creationDate) {
this.creationDate = creationDate;
}
/**
* Gets the name of the bucket.
*
* @return The name of this bucket.
*
* @see Bucket#setName(String)
*/
public String getName() {
return name;
}
/**
* Sets the name of the bucket. All buckets in Nos share a single namespace;
* ensure the bucket is given a unique name.
*
* @param name
* The name for the bucket.
*/
public void setName(String name) {
this.name = name;
}
}