All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.s3.model.Bucket Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with Amazon Simple Storage Service

The newest version!
/*
 * Copyright 2010-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Portions copyright 2006-2009 James Murty. Please see LICENSE.txt
 * for applicable license terms and NOTICE.txt for applicable notices.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.s3.model;
import java.io.Serializable;

import java.util.Date;

/**
 * 

* 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. *

*/ public class Bucket implements Serializable { private static final long serialVersionUID = -8646831898339939580L; /** The name of this S3 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; /** The region where the bucket is located */ private String region = null; /** * Constructs a bucket without any name specified. * * @see Bucket#Bucket(String) */ public Bucket() {} /** * Creates a bucket with a name. * All buckets in Amazon S3 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 "S3Bucket [name=" + getName() + ", creationDate=" + getCreationDate() + ", owner=" + getOwner() + ", region=" + getRegion() + "]"; } /** * 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 Amazon S3. This should only be used internally by * the Amazon Web Services Java client methods that retrieve information directly from Amazon S3. * * @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 S3. This should only be used * internally by Amazon Web Services Java client methods that retrieve information directly * from Amazon S3. * * @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 Amazon S3 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; } /** * Gets the region where the bucket is located. * It will return null for bucket instances created by the * {@link com.amazonaws.services.s3.AmazonS3#createBucket(CreateBucketRequest)} or * {@link com.amazonaws.services.s3.AmazonS3#createBucket(String)} API. * * @return The region of this bucket. */ public String getRegion() { return region; } /** * Sets the region where the bucket is located. * * @param region The region for the bucket. */ public void setRegion(String region) { this.region = region; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy