Bucket (Cloud Storage JSON API v1-rev20200727-1.30.10)

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: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Bucket.Billing` The bucket's billing configuration.
`static class`	`Bucket.Cors` Model definition for BucketCors.
`static class`	`Bucket.Encryption` Encryption configuration for a bucket.
`static class`	`Bucket.IamConfiguration` The bucket's IAM configuration.
`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.RetentionPolicy` The bucket's retention policy.
`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()

Constructors
Constructor and Description
`Bucket()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bucket`	`clone()`
`List<BucketAccessControl>`	`getAcl()` Access controls on the bucket.
`Bucket.Billing`	`getBilling()` The bucket's billing configuration.
`List<Bucket.Cors>`	`getCors()` The bucket's Cross-Origin Resource Sharing (CORS) configuration.
`Boolean`	`getDefaultEventBasedHold()` The default value for event-based hold on newly created objects in this bucket.
`List<ObjectAccessControl>`	`getDefaultObjectAcl()` Default access controls to apply to new objects when no ACL is provided.
`Bucket.Encryption`	`getEncryption()` Encryption configuration for a bucket.
`String`	`getEtag()` HTTP 1.1 Entity tag for the bucket.
`Bucket.IamConfiguration`	`getIamConfiguration()` The bucket's IAM configuration.
`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.
`String`	`getLocationType()` The type of the bucket location.
`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.
`Bucket.RetentionPolicy`	`getRetentionPolicy()` The bucket's retention policy.
`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.
`List<String>`	`getZoneAffinity()` The zone or zones from which the bucket is intended to use zonal quota.
`Boolean`	`getZoneSeparation()` If set, objects placed in this bucket are required to be separated by disaster domain.
`Bucket`	`set(String fieldName, Object value)`
`Bucket`	`setAcl(List<BucketAccessControl> acl)` Access controls on the bucket.
`Bucket`	`setBilling(Bucket.Billing billing)` The bucket's billing configuration.
`Bucket`	`setCors(List<Bucket.Cors> cors)` The bucket's Cross-Origin Resource Sharing (CORS) configuration.
`Bucket`	`setDefaultEventBasedHold(Boolean defaultEventBasedHold)` The default value for event-based hold on newly created objects in this bucket.
`Bucket`	`setDefaultObjectAcl(List<ObjectAccessControl> defaultObjectAcl)` Default access controls to apply to new objects when no ACL is provided.
`Bucket`	`setEncryption(Bucket.Encryption encryption)` Encryption configuration for a bucket.
`Bucket`	`setEtag(String etag)` HTTP 1.1 Entity tag for the bucket.
`Bucket`	`setIamConfiguration(Bucket.IamConfiguration iamConfiguration)` The bucket's IAM configuration.
`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`	`setLocationType(String locationType)` The type of the bucket location.
`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`	`setRetentionPolicy(Bucket.RetentionPolicy retentionPolicy)` The bucket's retention policy.
`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.
`Bucket`	`setZoneAffinity(List<String> zoneAffinity)` The zone or zones from which the bucket is intended to use zonal quota.
`Bucket`	`setZoneSeparation(Boolean zoneSeparation)` If set, objects placed in this bucket are required to be separated by disaster domain.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- 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
  - getBilling
```
public Bucket.Billing getBilling()
```
    The bucket's billing configuration.
    
    Returns:
    
    value or null for none
  - setBilling
```
public Bucket setBilling(Bucket.Billing billing)
```
    The bucket's billing configuration.
    
    Parameters:
    
    billing - billing 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
  - getDefaultEventBasedHold
```
public Boolean getDefaultEventBasedHold()
```
    The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
    
    Returns:
    
    value or null for none
  - setDefaultEventBasedHold
```
public Bucket setDefaultEventBasedHold(Boolean defaultEventBasedHold)
```
    The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
    
    Parameters:
    
    defaultEventBasedHold - defaultEventBasedHold 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
  - getEncryption
```
public Bucket.Encryption getEncryption()
```
    Encryption configuration for a bucket.
    
    Returns:
    
    value or null for none
  - setEncryption
```
public Bucket setEncryption(Bucket.Encryption encryption)
```
    Encryption configuration for a bucket.
    
    Parameters:
    
    encryption - encryption 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
  - getIamConfiguration
```
public Bucket.IamConfiguration getIamConfiguration()
```
    The bucket's IAM configuration.
    
    Returns:
    
    value or null for none
  - setIamConfiguration
```
public Bucket setIamConfiguration(Bucket.IamConfiguration iamConfiguration)
```
    The bucket's IAM configuration.
    
    Parameters:
    
    iamConfiguration - iamConfiguration or null for none
  - getId
```
public String getId()
```
    The ID of the bucket. For buckets, the id and name properties 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 properties 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
  - getLocationType
```
public String getLocationType()
```
    The type of the bucket location.
    
    Returns:
    
    value or null for none
  - setLocationType
```
public Bucket setLocationType(String locationType)
```
    The type of the bucket location.
    
    Parameters:
    
    locationType - locationType 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
  - getRetentionPolicy
```
public Bucket.RetentionPolicy getRetentionPolicy()
```
    The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
    
    Returns:
    
    value or null for none
  - setRetentionPolicy
```
public Bucket setRetentionPolicy(Bucket.RetentionPolicy retentionPolicy)
```
    The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
    
    Parameters:
    
    retentionPolicy - retentionPolicy 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, ARCHIVE, 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, ARCHIVE, 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
  - getZoneAffinity
```
public List<String> getZoneAffinity()
```
    The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won't be able to use zonal quota. The zone or zones need to be within the bucket location otherwise the requests will fail with a 400 Bad Request response.
    
    Returns:
    
    value or null for none
  - setZoneAffinity
```
public Bucket setZoneAffinity(List<String> zoneAffinity)
```
    The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won't be able to use zonal quota. The zone or zones need to be within the bucket location otherwise the requests will fail with a 400 Bad Request response.
    
    Parameters:
    
    zoneAffinity - zoneAffinity or null for none
  - getZoneSeparation
```
public Boolean getZoneSeparation()
```
    If set, objects placed in this bucket are required to be separated by disaster domain.
    
    Returns:
    
    value or null for none
  - setZoneSeparation
```
public Bucket setZoneSeparation(Boolean zoneSeparation)
```
    If set, objects placed in this bucket are required to be separated by disaster domain.
    
    Parameters:
    
    zoneSeparation - zoneSeparation 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

Class Bucket

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Bucket

Method Detail

getAcl

setAcl

getBilling

setBilling

getCors

setCors

getDefaultEventBasedHold

setDefaultEventBasedHold

getDefaultObjectAcl

setDefaultObjectAcl

getEncryption

setEncryption

getEtag

setEtag

getIamConfiguration

setIamConfiguration

getId

setId

getKind

setKind

getLabels

setLabels

getLifecycle

setLifecycle

getLocation

setLocation

getLocationType

setLocationType

getLogging

setLogging

getMetageneration

setMetageneration

getName

setName

getOwner

setOwner

getProjectNumber

setProjectNumber

getRetentionPolicy

setRetentionPolicy

getSelfLink

setSelfLink

getStorageClass

setStorageClass

getTimeCreated

setTimeCreated

getUpdated

setUpdated

getVersioning

setVersioning

getWebsite

setWebsite

getZoneAffinity

setZoneAffinity

getZoneSeparation

setZoneSeparation

set

clone