Bucket class

A bucket.

Constructors

Bucket()
Bucket.fromJson(Map _json)

Properties

acl ↔ List<BucketAccessControl>
Access controls on the bucket.
read / write
billing BucketBilling
The bucket's billing configuration.
read / write
cors ↔ List<BucketCors>
The bucket's Cross-Origin Resource Sharing (CORS) configuration.
read / write
defaultEventBasedHold ↔ bool
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.
read / write
defaultObjectAcl ↔ List<ObjectAccessControl>
Default access controls to apply to new objects when no ACL is provided.
read / write
encryption BucketEncryption
Encryption configuration for a bucket.
read / write
etag ↔ String
HTTP 1.1 Entity tag for the bucket.
read / write
iamConfiguration BucketIamConfiguration
The bucket's IAM configuration.
read / write
id ↔ String
The ID of the bucket. For buckets, the id and name properties are the same.
read / write
kind ↔ String
The kind of item this is. For buckets, this is always storage#bucket.
read / write
labels ↔ Map<String, String>
User-provided labels, in key/value pairs.
read / write
lifecycle BucketLifecycle
The bucket's lifecycle configuration. See lifecycle management for more information.
read / write
location ↔ String
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.
read / write
locationType ↔ String
The type of the bucket location.
read / write
logging BucketLogging
The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
read / write
metageneration ↔ String
The metadata generation of this bucket.
read / write
name ↔ String
The name of the bucket.
read / write
owner BucketOwner
The owner of the bucket. This is always the project team's owner group.
read / write
projectNumber ↔ String
The project number of the project the bucket belongs to.
read / write
retentionPolicy BucketRetentionPolicy
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.
read / write
The URI of this bucket.
read / write
storageClass ↔ String
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.
read / write
timeCreated ↔ DateTime
The creation time of the bucket in RFC 3339 format.
read / write
updated ↔ DateTime
The modification time of the bucket in RFC 3339 format.
read / write
versioning BucketVersioning
The bucket's versioning configuration.
read / write
website BucketWebsite
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.
read / write
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

toJson() → Map<String, Object>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited