buckets

Creates, updates, deletes, gets or lists a buckets resource.

Overview

Name	buckets
Type	Resource
Id	google.storage.buckets

Fields

Name	Datatype	Description
id	string	The ID of the bucket. For buckets, the id and name properties are the same.
name	string	The name of the bucket.
acl	array	Access controls on the bucket.
autoclass	object	The bucket's Autoclass configuration.
billing	object	The bucket's billing configuration.
cors	array	The bucket's Cross-Origin Resource Sharing (CORS) configuration.
customPlacementConfig	object	The bucket's custom placement configuration for Custom Dual Regions.
defaultEventBasedHold	boolean	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.
defaultObjectAcl	array	Default access controls to apply to new objects when no ACL is provided.
encryption	object	Encryption configuration for a bucket.
etag	string	HTTP 1.1 Entity tag for the bucket.
generation	string	The generation of this bucket.
hardDeleteTime	string	The hard delete time of the bucket in RFC 3339 format.
hierarchicalNamespace	object	The bucket's hierarchical namespace configuration.
iamConfiguration	object	The bucket's IAM configuration.
ipFilter	object	The bucket's IP filter configuration. Specifies the network sources that are allowed to access the operations on the bucket, as well as its underlying objects. Only enforced when the mode is set to 'Enabled'.
kind	string	The kind of item this is. For buckets, this is always storage#bucket.
labels	object	User-provided labels, in key/value pairs.
lifecycle	object	The bucket's lifecycle configuration. See Lifecycle Management for more information.
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.
locationType	string	The type of the bucket location.
logging	object	The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
metageneration	string	The metadata generation of this bucket.
objectRetention	object	The bucket's object retention config.
owner	object	The owner of the bucket. This is always the project team's owner group.
projectNumber	string	The project number of the project the bucket belongs to.
retentionPolicy	object	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.
rpo	string	The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
satisfiesPZI	boolean	Reserved for future use.
satisfiesPZS	boolean	Reserved for future use.
selfLink	string	The URI of this bucket.
softDeletePolicy	object	The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.
softDeleteTime	string	The soft delete time of the bucket in RFC 3339 format.
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, 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.
timeCreated	string	The creation time of the bucket in RFC 3339 format.
updated	string	The modification time of the bucket in RFC 3339 format.
versioning	object	The bucket's versioning configuration.
website	object	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.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	bucket	Returns metadata for the specified bucket.
list	SELECT	project	Retrieves a list of buckets for a given project.
insert	INSERT	project	Creates a new bucket.
delete	DELETE	bucket	Deletes an empty bucket. Deletions are permanent unless soft delete is enabled on the bucket.
patch	UPDATE	bucket	Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
update	REPLACE	bucket	Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
lock_retention_policy	EXEC	bucket, ifMetagenerationMatch	Locks retention policy on a bucket.
restore	EXEC	bucket, generation	Restores a soft-deleted bucket.

SELECT examples

Returns metadata for the specified bucket.

SELECT
id,
name,
acl,
autoclass,
billing,
cors,
customPlacementConfig,
defaultEventBasedHold,
defaultObjectAcl,
encryption,
etag,
generation,
hardDeleteTime,
hierarchicalNamespace,
iamConfiguration,
ipFilter,
kind,
labels,
lifecycle,
location,
locationType,
logging,
metageneration,
objectRetention,
owner,
projectNumber,
retentionPolicy,
rpo,
satisfiesPZI,
satisfiesPZS,
selfLink,
softDeletePolicy,
softDeleteTime,
storageClass,
timeCreated,
updated,
versioning,
website
FROM google.storage.buckets
WHERE bucket = '{{ bucket }}';

INSERT example

Use the following StackQL query and manifest file to create a new buckets resource.

All Properties

/*+ create */
INSERT INTO google.storage.buckets (
project,
acl,
billing,
cors,
customPlacementConfig,
defaultEventBasedHold,
defaultObjectAcl,
encryption,
etag,
hierarchicalNamespace,
iamConfiguration,
ipFilter,
labels,
lifecycle,
autoclass,
location,
locationType,
logging,
generation,
metageneration,
name,
owner,
projectNumber,
retentionPolicy,
objectRetention,
rpo,
softDeletePolicy,
storageClass,
timeCreated,
updated,
softDeleteTime,
hardDeleteTime,
versioning,
website,
satisfiesPZS,
satisfiesPZI
)
SELECT 
'{{ project }}',
'{{ acl }}',
'{{ billing }}',
'{{ cors }}',
'{{ customPlacementConfig }}',
{{ defaultEventBasedHold }},
'{{ defaultObjectAcl }}',
'{{ encryption }}',
'{{ etag }}',
'{{ hierarchicalNamespace }}',
'{{ iamConfiguration }}',
'{{ ipFilter }}',
'{{ labels }}',
'{{ lifecycle }}',
'{{ autoclass }}',
'{{ location }}',
'{{ locationType }}',
'{{ logging }}',
'{{ generation }}',
'{{ metageneration }}',
'{{ name }}',
'{{ owner }}',
'{{ projectNumber }}',
'{{ retentionPolicy }}',
'{{ objectRetention }}',
'{{ rpo }}',
'{{ softDeletePolicy }}',
'{{ storageClass }}',
'{{ timeCreated }}',
'{{ updated }}',
'{{ softDeleteTime }}',
'{{ hardDeleteTime }}',
'{{ versioning }}',
'{{ website }}',
{{ satisfiesPZS }},
{{ satisfiesPZI }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: acl
      value:
        - - name: bucket
            value: string
          - name: domain
            value: string
          - name: email
            value: string
          - name: entity
            value: string
          - name: entityId
            value: string
          - name: etag
            value: string
          - name: id
            value: string
          - name: kind
            value: string
          - name: projectTeam
            value:
              - name: projectNumber
                value: string
              - name: team
                value: string
          - name: role
            value: string
          - name: selfLink
            value: string
    - name: billing
      value:
        - name: requesterPays
          value: boolean
    - name: cors
      value:
        - - name: maxAgeSeconds
            value: integer
          - name: method
            value:
              - string
          - name: origin
            value:
              - string
          - name: responseHeader
            value:
              - string
    - name: customPlacementConfig
      value:
        - name: dataLocations
          value:
            - string
    - name: defaultEventBasedHold
      value: boolean
    - name: defaultObjectAcl
      value:
        - - name: bucket
            value: string
          - name: domain
            value: string
          - name: email
            value: string
          - name: entity
            value: string
          - name: entityId
            value: string
          - name: etag
            value: string
          - name: generation
            value: string
          - name: id
            value: string
          - name: kind
            value: string
          - name: object
            value: string
          - name: projectTeam
            value:
              - name: projectNumber
                value: string
              - name: team
                value: string
          - name: role
            value: string
          - name: selfLink
            value: string
    - name: encryption
      value:
        - name: defaultKmsKeyName
          value: string
    - name: etag
      value: string
    - name: hierarchicalNamespace
      value:
        - name: enabled
          value: boolean
    - name: iamConfiguration
      value:
        - name: bucketPolicyOnly
          value:
            - name: enabled
              value: boolean
            - name: lockedTime
              value: string
        - name: uniformBucketLevelAccess
          value:
            - name: enabled
              value: boolean
            - name: lockedTime
              value: string
        - name: publicAccessPrevention
          value: string
    - name: id
      value: string
    - name: ipFilter
      value:
        - name: mode
          value: string
        - name: publicNetworkSource
          value:
            - name: allowedIpCidrRanges
              value:
                - string
        - name: vpcNetworkSources
          value:
            - - name: network
                value: string
              - name: allowedIpCidrRanges
                value:
                  - string
    - name: kind
      value: string
    - name: labels
      value: object
    - name: lifecycle
      value:
        - name: rule
          value:
            - - name: action
                value:
                  - name: storageClass
                    value: string
                  - name: type
                    value: string
              - name: condition
                value:
                  - name: age
                    value: integer
                  - name: createdBefore
                    value: string
                  - name: customTimeBefore
                    value: string
                  - name: daysSinceCustomTime
                    value: integer
                  - name: daysSinceNoncurrentTime
                    value: integer
                  - name: isLive
                    value: boolean
                  - name: matchesPattern
                    value: string
                  - name: matchesPrefix
                    value:
                      - string
                  - name: matchesSuffix
                    value:
                      - string
                  - name: matchesStorageClass
                    value:
                      - string
                  - name: noncurrentTimeBefore
                    value: string
                  - name: numNewerVersions
                    value: integer
    - name: autoclass
      value:
        - name: enabled
          value: boolean
        - name: toggleTime
          value: string
        - name: terminalStorageClass
          value: string
        - name: terminalStorageClassUpdateTime
          value: string
    - name: location
      value: string
    - name: locationType
      value: string
    - name: logging
      value:
        - name: logBucket
          value: string
        - name: logObjectPrefix
          value: string
    - name: generation
      value: string
    - name: metageneration
      value: string
    - name: name
      value: string
    - name: owner
      value:
        - name: entity
          value: string
        - name: entityId
          value: string
    - name: projectNumber
      value: string
    - name: retentionPolicy
      value:
        - name: effectiveTime
          value: string
        - name: isLocked
          value: boolean
        - name: retentionPeriod
          value: string
    - name: objectRetention
      value:
        - name: mode
          value: string
    - name: rpo
      value: string
    - name: selfLink
      value: string
    - name: softDeletePolicy
      value:
        - name: retentionDurationSeconds
          value: string
        - name: effectiveTime
          value: string
    - name: storageClass
      value: string
    - name: timeCreated
      value: string
    - name: updated
      value: string
    - name: softDeleteTime
      value: string
    - name: hardDeleteTime
      value: string
    - name: versioning
      value:
        - name: enabled
          value: boolean
    - name: website
      value:
        - name: mainPageSuffix
          value: string
        - name: notFoundPage
          value: string
    - name: satisfiesPZS
      value: boolean
    - name: satisfiesPZI
      value: boolean

UPDATE example

Updates a buckets resource.

/*+ update */
UPDATE google.storage.buckets
SET 
acl = '{{ acl }}',
billing = '{{ billing }}',
cors = '{{ cors }}',
customPlacementConfig = '{{ customPlacementConfig }}',
defaultEventBasedHold = true|false,
defaultObjectAcl = '{{ defaultObjectAcl }}',
encryption = '{{ encryption }}',
etag = '{{ etag }}',
hierarchicalNamespace = '{{ hierarchicalNamespace }}',
iamConfiguration = '{{ iamConfiguration }}',
ipFilter = '{{ ipFilter }}',
labels = '{{ labels }}',
lifecycle = '{{ lifecycle }}',
autoclass = '{{ autoclass }}',
location = '{{ location }}',
locationType = '{{ locationType }}',
logging = '{{ logging }}',
generation = '{{ generation }}',
metageneration = '{{ metageneration }}',
name = '{{ name }}',
owner = '{{ owner }}',
projectNumber = '{{ projectNumber }}',
retentionPolicy = '{{ retentionPolicy }}',
objectRetention = '{{ objectRetention }}',
rpo = '{{ rpo }}',
softDeletePolicy = '{{ softDeletePolicy }}',
storageClass = '{{ storageClass }}',
timeCreated = '{{ timeCreated }}',
updated = '{{ updated }}',
softDeleteTime = '{{ softDeleteTime }}',
hardDeleteTime = '{{ hardDeleteTime }}',
versioning = '{{ versioning }}',
website = '{{ website }}',
satisfiesPZS = true|false,
satisfiesPZI = true|false
WHERE 
bucket = '{{ bucket }}';

REPLACE example

Replaces all fields in the specified buckets resource.

/*+ update */
REPLACE google.storage.buckets
SET 
acl = '{{ acl }}',
billing = '{{ billing }}',
cors = '{{ cors }}',
customPlacementConfig = '{{ customPlacementConfig }}',
defaultEventBasedHold = true|false,
defaultObjectAcl = '{{ defaultObjectAcl }}',
encryption = '{{ encryption }}',
etag = '{{ etag }}',
hierarchicalNamespace = '{{ hierarchicalNamespace }}',
iamConfiguration = '{{ iamConfiguration }}',
ipFilter = '{{ ipFilter }}',
labels = '{{ labels }}',
lifecycle = '{{ lifecycle }}',
autoclass = '{{ autoclass }}',
location = '{{ location }}',
locationType = '{{ locationType }}',
logging = '{{ logging }}',
generation = '{{ generation }}',
metageneration = '{{ metageneration }}',
name = '{{ name }}',
owner = '{{ owner }}',
projectNumber = '{{ projectNumber }}',
retentionPolicy = '{{ retentionPolicy }}',
objectRetention = '{{ objectRetention }}',
rpo = '{{ rpo }}',
softDeletePolicy = '{{ softDeletePolicy }}',
storageClass = '{{ storageClass }}',
timeCreated = '{{ timeCreated }}',
updated = '{{ updated }}',
softDeleteTime = '{{ softDeleteTime }}',
hardDeleteTime = '{{ hardDeleteTime }}',
versioning = '{{ versioning }}',
website = '{{ website }}',
satisfiesPZS = true|false,
satisfiesPZI = true|false
WHERE 
bucket = '{{ bucket }}';

DELETE example

Deletes the specified buckets resource.

/*+ delete */
DELETE FROM google.storage.buckets
WHERE bucket = '{{ bucket }}';