com.google.api.services.storage.model

Class Bucket

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storage.model.Bucket

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Bucket
extends GenericJson

A bucket.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Storage JSON API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bucket.Cors Model definition for BucketCors.
static class	Bucket.Lifecycle The bucket's lifecycle configuration.
static class	Bucket.Logging The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
static class	Bucket.Owner The owner of the bucket.
static class	Bucket.Versioning The bucket's versioning configuration.
static class	Bucket.Website The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Bucket()

Method Summary

Methods

Modifier and Type	Method and Description
Bucket	clone()
List<BucketAccessControl>	getAcl() Access controls on the bucket.
List<Bucket.Cors>	getCors() The bucket's Cross-Origin Resource Sharing (CORS) configuration.
List<ObjectAccessControl>	getDefaultObjectAcl() Default access controls to apply to new objects when no ACL is provided.
String	getEtag() HTTP 1.1 Entity tag for the bucket.
String	getId() The ID of the bucket.
String	getKind() The kind of item this is.
Map<String,String>	getLabels() User-provided labels, in key/value pairs.
Bucket.Lifecycle	getLifecycle() The bucket's lifecycle configuration.
String	getLocation() The location of the bucket.
Bucket.Logging	getLogging() The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
Long	getMetageneration() The metadata generation of this bucket.
String	getName() The name of the bucket.
Bucket.Owner	getOwner() The owner of the bucket.
BigInteger	getProjectNumber() The project number of the project the bucket belongs to.
String	getSelfLink() The URI of this bucket.
String	getStorageClass() The bucket's default storage class, used whenever no storageClass is specified for a newly- created object.
DateTime	getTimeCreated() The creation time of the bucket in RFC 3339 format.
DateTime	getUpdated() The modification time of the bucket in RFC 3339 format.
Bucket.Versioning	getVersioning() The bucket's versioning configuration.
Bucket.Website	getWebsite() The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site.
Bucket	set(String fieldName, Object value)
Bucket	setAcl(List<BucketAccessControl> acl) Access controls on the bucket.
Bucket	setCors(List<Bucket.Cors> cors) The bucket's Cross-Origin Resource Sharing (CORS) configuration.
Bucket	setDefaultObjectAcl(List<ObjectAccessControl> defaultObjectAcl) Default access controls to apply to new objects when no ACL is provided.
Bucket	setEtag(String etag) HTTP 1.1 Entity tag for the bucket.
Bucket	setId(String id) The ID of the bucket.
Bucket	setKind(String kind) The kind of item this is.
Bucket	setLabels(Map<String,String> labels) User-provided labels, in key/value pairs.
Bucket	setLifecycle(Bucket.Lifecycle lifecycle) The bucket's lifecycle configuration.
Bucket	setLocation(String location) The location of the bucket.
Bucket	setLogging(Bucket.Logging logging) The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
Bucket	setMetageneration(Long metageneration) The metadata generation of this bucket.
Bucket	setName(String name) The name of the bucket.
Bucket	setOwner(Bucket.Owner owner) The owner of the bucket.
Bucket	setProjectNumber(BigInteger projectNumber) The project number of the project the bucket belongs to.
Bucket	setSelfLink(String selfLink) The URI of this bucket.
Bucket	setStorageClass(String storageClass) The bucket's default storage class, used whenever no storageClass is specified for a newly- created object.
Bucket	setTimeCreated(DateTime timeCreated) The creation time of the bucket in RFC 3339 format.
Bucket	setUpdated(DateTime updated) The modification time of the bucket in RFC 3339 format.
Bucket	setVersioning(Bucket.Versioning versioning) The bucket's versioning configuration.
Bucket	setWebsite(Bucket.Website website) The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Bucket

public Bucket()

Method Detail

getAcl

public List<BucketAccessControl> getAcl()

Access controls on the bucket.

Returns:

value or null for none

setAcl

public Bucket setAcl(List<BucketAccessControl> acl)

Access controls on the bucket.

Parameters:

acl - acl or null for none

getCors

public List<Bucket.Cors> getCors()

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

Returns:

value or null for none

setCors

public Bucket setCors(List<Bucket.Cors> cors)

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

Parameters:

cors - cors or null for none

getDefaultObjectAcl

public List<ObjectAccessControl> getDefaultObjectAcl()

Default access controls to apply to new objects when no ACL is provided.

Returns:

value or null for none

setDefaultObjectAcl

public Bucket setDefaultObjectAcl(List<ObjectAccessControl> defaultObjectAcl)

Default access controls to apply to new objects when no ACL is provided.

Parameters:

defaultObjectAcl - defaultObjectAcl or null for none

getEtag

public String getEtag()

HTTP 1.1 Entity tag for the bucket.

Returns:

value or null for none

setEtag

public Bucket setEtag(String etag)

HTTP 1.1 Entity tag for the bucket.

Parameters:

etag - etag or null for none

getId

public String getId()

The ID of the bucket. For buckets, the id and name properities are the same.

Returns:

value or null for none

setId

public Bucket setId(String id)

The ID of the bucket. For buckets, the id and name properities are the same.

Parameters:

id - id or null for none

getKind

public String getKind()

The kind of item this is. For buckets, this is always storage#bucket.

Returns:

value or null for none

setKind

public Bucket setKind(String kind)

The kind of item this is. For buckets, this is always storage#bucket.

Parameters:

kind - kind or null for none

getLabels

public Map<String,String> getLabels()

User-provided labels, in key/value pairs.

Returns:

value or null for none

setLabels

public Bucket setLabels(Map<String,String> labels)

User-provided labels, in key/value pairs.

Parameters:

labels - labels or null for none

getLifecycle

public Bucket.Lifecycle getLifecycle()

The bucket's lifecycle configuration. See lifecycle management for more information.

Returns:

value or null for none

setLifecycle

public Bucket setLifecycle(Bucket.Lifecycle lifecycle)

The bucket's lifecycle configuration. See lifecycle management for more information.

Parameters:

lifecycle - lifecycle or null for none

getLocation

public String getLocation()

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

Returns:

value or null for none

setLocation

public Bucket setLocation(String location)

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

Parameters:

location - location or null for none

getLogging

public Bucket.Logging getLogging()

The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.

Returns:

value or null for none

setLogging

public Bucket setLogging(Bucket.Logging logging)

The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.

Parameters:

logging - logging or null for none

getMetageneration

public Long getMetageneration()

The metadata generation of this bucket.

Returns:

value or null for none

setMetageneration

public Bucket setMetageneration(Long metageneration)

The metadata generation of this bucket.

Parameters:

metageneration - metageneration or null for none

getName

public String getName()

The name of the bucket.

Returns:

value or null for none

setName

public Bucket setName(String name)

The name of the bucket.

Parameters:

name - name or null for none

getOwner

public Bucket.Owner getOwner()

The owner of the bucket. This is always the project team's owner group.

Returns:

value or null for none

setOwner

public Bucket setOwner(Bucket.Owner owner)

The owner of the bucket. This is always the project team's owner group.

Parameters:

owner - owner or null for none

getProjectNumber

public BigInteger getProjectNumber()

The project number of the project the bucket belongs to.

Returns:

value or null for none

setProjectNumber

public Bucket setProjectNumber(BigInteger projectNumber)

The project number of the project the bucket belongs to.

Parameters:

projectNumber - projectNumber or null for none

getSelfLink

public String getSelfLink()

The URI of this bucket.

Returns:

value or null for none

setSelfLink

public Bucket setSelfLink(String selfLink)

The URI of this bucket.

Parameters:

selfLink - selfLink or null for none

getStorageClass

public String getStorageClass()

The bucket's default storage class, used whenever no storageClass is specified for a newly- created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.

Returns:

value or null for none

setStorageClass

public Bucket setStorageClass(String storageClass)

The bucket's default storage class, used whenever no storageClass is specified for a newly- created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.

Parameters:

storageClass - storageClass or null for none

getTimeCreated

public DateTime getTimeCreated()

The creation time of the bucket in RFC 3339 format.

Returns:

value or null for none

setTimeCreated

public Bucket setTimeCreated(DateTime timeCreated)

The creation time of the bucket in RFC 3339 format.

Parameters:

timeCreated - timeCreated or null for none

getUpdated

public DateTime getUpdated()

The modification time of the bucket in RFC 3339 format.

Returns:

value or null for none

setUpdated

public Bucket setUpdated(DateTime updated)

The modification time of the bucket in RFC 3339 format.

Parameters:

updated - updated or null for none

getVersioning

public Bucket.Versioning getVersioning()

The bucket's versioning configuration.

Returns:

value or null for none

setVersioning

public Bucket setVersioning(Bucket.Versioning versioning)

The bucket's versioning configuration.

Parameters:

versioning - versioning or null for none

getWebsite

public Bucket.Website getWebsite()

The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

Returns:

value or null for none

setWebsite

public Bucket setWebsite(Bucket.Website website)

The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

Parameters:

website - website or null for none

set

public Bucket set(String fieldName,
         Object value)

Overrides:

set in class GenericJson

clone

public Bucket clone()

Overrides:

clone in class GenericJson