Google Cloud Storage · Schema
Google Cloud Storage Bucket
Schema for a Google Cloud Storage bucket resource as returned by the Cloud Storage JSON API v1. A bucket is a container for objects stored in Cloud Storage. Buckets are associated with a project, have globally unique names, and provide configuration for storage class, location, access control, lifecycle management, versioning, and encryption.
ArchivalBackupBlob StorageCloud StorageDataFile StorageGoogle CloudObject StorageStorage
Properties
| Name | Type | Description |
|---|---|---|
| kind | string | The kind of item this is. For buckets, this is always storage#bucket. |
| id | string | The ID of the bucket. For buckets, this is the same value as the name property. Read-only. |
| selfLink | string | The URI of this bucket. Read-only. |
| projectNumber | string | The project number of the project the bucket belongs to. Read-only. |
| name | string | The name of the bucket. Bucket names must be globally unique across all of Cloud Storage, contain only lowercase letters, numbers, hyphens, underscores, and dots, and must be between 3 and 63 characte |
| timeCreated | string | The creation time of the bucket in RFC 3339 format. Read-only. |
| updated | string | The modification time of the bucket metadata in RFC 3339 format. Read-only. |
| metageneration | string | The metadata generation of this bucket. Used for preconditions and for detecting changes in metadata. Every update to the bucket's metadata increments this value. Read-only. |
| location | string | The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Can be a multi-region (e.g., US, EU, ASIA), dual-region (e.g., US-EAST1+US-WEST1), or |
| locationType | string | The type of location that the bucket resides in. Read-only. |
| storageClass | string | The default storage class of the bucket, used for newly created objects when no storage class is specified. Objects can be stored in Standard, Nearline, Coldline, or Archive storage. |
| etag | string | HTTP 1.1 Entity tag for the bucket. Read-only. |
| defaultEventBasedHold | boolean | Whether or not to automatically apply an event-based hold to new objects added to the bucket. Event-based holds remain on an object until explicitly removed. |
| rpo | string | The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to enable Turbo Replication on dual-region buckets, providing a lower RPO of 15 minutes instead of the default. |
| acl | arraynull | Access controls on the bucket, containing one or more bucketAccessControls resources. Not returned in list responses unless projection=full is specified. |
| defaultObjectAcl | arraynull | Default access controls to apply to new objects when no ACL is provided. |
| iamConfiguration | object | |
| encryption | objectnull | Encryption configuration for the bucket. Specifies a default Cloud KMS key for encrypting objects inserted into this bucket. |
| lifecycle | objectnull | The bucket's lifecycle configuration. Lifecycle management lets you set a Time to Live (TTL) for objects, or automatically transition objects to different storage classes based on conditions. |
| logging | objectnull | The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's access logs. |
| versioning | objectnull | The bucket's versioning configuration. When enabled, Cloud Storage retains a noncurrent object version each time a live object version is replaced or deleted. |
| website | objectnull | The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. |
| cors | arraynull | The bucket's Cross-Origin Resource Sharing (CORS) configuration to support requests from web applications running in browsers. |
| retentionPolicy | objectnull | The bucket's retention policy, which defines the minimum age an object in the bucket must reach before it can be deleted or replaced. |
| softDeletePolicy | objectnull | The bucket's soft delete policy. When enabled, deleted objects are retained for a specified period and can be recovered. |
| autoclass | objectnull | The bucket's Autoclass configuration. When enabled, Autoclass automatically transitions objects in the bucket to appropriate storage classes based on each object's access pattern. |
| hierarchicalNamespace | objectnull | The bucket's hierarchical namespace configuration. When enabled, the bucket supports folders and managed folders as organizational structures. |
| labels | objectnull | User-provided labels, in key/value pairs. Labels are used to organize and filter buckets. Keys and values must be 63 characters or less and conform to RFC 1035. |
| customPlacementConfig | objectnull | The bucket's custom placement configuration for Custom Dual Regions. |
| satisfiesPZS | boolean | Whether the bucket satisfies zone separation requirements. Read-only. |