List

Retrieves a list of buckets for a given project

7 variables
88 variables

Retrieves a list of buckets for a given project

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View your data across Google Cloud Platform services
  • Manage your data and permissions in Google Cloud Storage
  • View your data in Google Cloud Storage
  • Manage your data in Google Cloud Storage

Input

This building block consumes 7 input parameters

  = Parameter name
  = Format

project STRING Required

A valid API project identifier

maxResults INTEGER

Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller

pageToken STRING

A previously-returned page token representing part of the larger set of results to view

prefix STRING

Filter results to buckets whose names begin with this prefix

projection ENUMERATION

Set of properties to return. Defaults to noAcl

provisionalUserProject STRING

The project to be billed for this request if the target bucket is requester-pays bucket

userProject STRING

The project to be billed for this request

Output

This building block provides 88 output parameters

  = Parameter name
  = Format

items[] OBJECT

A bucket

items[].acl[] OBJECT

An access-control entry

items[].acl[].bucket STRING

The name of the bucket

items[].acl[].domain STRING

The domain associated with the entity, if any

items[].acl[].email STRING

The email address associated with the entity, if any

items[].acl[].entity STRING

The entity holding the permission, in one of the following forms:

items[].acl[].entityId STRING

The ID for the entity, if any

items[].acl[].etag STRING

HTTP 1.1 Entity tag for the access-control entry

items[].acl[].id STRING

The ID of the access-control entry

items[].acl[].kind STRING

The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl

items[].acl[].projectTeam OBJECT

The project team associated with the entity, if any

items[].acl[].projectTeam.projectNumber STRING

The project number

items[].acl[].projectTeam.team STRING

The team

items[].acl[].role STRING

The access permission for the entity

items[].acl[].selfLink STRING

The link to this access-control entry

items[].billing OBJECT

The bucket's billing configuration

items[].billing.requesterPays BOOLEAN

When set to true, Requester Pays is enabled for this bucket

items[].cors[] OBJECT

items[].cors[].maxAgeSeconds INTEGER

The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses

items[].cors[].method[] STRING

items[].cors[].origin[] STRING

items[].cors[].responseHeader[] STRING

items[].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

items[].defaultObjectAcl[] OBJECT

An access-control entry

items[].defaultObjectAcl[].bucket STRING

The name of the bucket

items[].defaultObjectAcl[].domain STRING

The domain associated with the entity, if any

items[].defaultObjectAcl[].email STRING

The email address associated with the entity, if any

items[].defaultObjectAcl[].entity STRING

The entity holding the permission, in one of the following forms:

items[].defaultObjectAcl[].entityId STRING

The ID for the entity, if any

items[].defaultObjectAcl[].etag STRING

HTTP 1.1 Entity tag for the access-control entry

items[].defaultObjectAcl[].generation INTEGER

The content generation of the object, if applied to an object

items[].defaultObjectAcl[].id STRING

The ID of the access-control entry

items[].defaultObjectAcl[].kind STRING

The kind of item this is. For object access control entries, this is always storage#objectAccessControl

items[].defaultObjectAcl[].object STRING

The name of the object, if applied to an object

items[].defaultObjectAcl[].projectTeam OBJECT

The project team associated with the entity, if any

items[].defaultObjectAcl[].projectTeam.projectNumber STRING

The project number

items[].defaultObjectAcl[].projectTeam.team STRING

The team

items[].defaultObjectAcl[].role STRING

The access permission for the entity

items[].defaultObjectAcl[].selfLink STRING

The link to this access-control entry

items[].encryption OBJECT

Encryption configuration for a bucket

items[].encryption.defaultKmsKeyName STRING

A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified

items[].etag STRING

HTTP 1.1 Entity tag for the bucket

items[].iamConfiguration OBJECT

The bucket's IAM configuration

items[].iamConfiguration.bucketPolicyOnly OBJECT

The bucket's Bucket Policy Only configuration

items[].iamConfiguration.bucketPolicyOnly.enabled BOOLEAN

If set, access checks only use bucket-level IAM policies or above

items[].iamConfiguration.bucketPolicyOnly.lockedTime DATE_TIME

The deadline time for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable

items[].id STRING

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

items[].kind STRING

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

items[].labels OBJECT

User-provided labels, in key/value pairs

items[].labels.customKey.value STRING

User-provided labels, in key/value pairs

items[].lifecycle OBJECT

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

items[].lifecycle.rule[] OBJECT

items[].lifecycle.rule[].action OBJECT

The action to take

items[].lifecycle.rule[].action.storageClass STRING

Target storage class. Required iff the type of the action is SetStorageClass

items[].lifecycle.rule[].action.type STRING

Type of the action. Currently, only Delete and SetStorageClass are supported

items[].lifecycle.rule[].condition OBJECT

The condition(s) under which the action will be taken

items[].lifecycle.rule[].condition.age INTEGER

Age of an object (in days). This condition is satisfied when an object reaches the specified age

items[].lifecycle.rule[].condition.createdBefore DATE

A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC

items[].lifecycle.rule[].condition.isLive BOOLEAN

Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects

items[].lifecycle.rule[].condition.matchesPattern STRING

A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released

items[].lifecycle.rule[].condition.matchesStorageClass[] STRING

items[].lifecycle.rule[].condition.numNewerVersions INTEGER

Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object

items[].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

items[].locationType STRING

The type of the bucket location

items[].logging OBJECT

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

items[].logging.logBucket STRING

The destination bucket where the current bucket's logs should be placed

items[].logging.logObjectPrefix STRING

A prefix for log object names

items[].metageneration INTEGER

The metadata generation of this bucket

items[].name STRING

The name of the bucket

items[].owner OBJECT

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

items[].owner.entity STRING

The entity, in the form project-owner-projectId

items[].owner.entityId STRING

The ID for the entity

items[].projectNumber INTEGER

The project number of the project the bucket belongs to

items[].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

items[].retentionPolicy.effectiveTime DATE_TIME

Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format

items[].retentionPolicy.isLocked BOOLEAN

Once locked, an object retention policy cannot be modified

items[].retentionPolicy.retentionPeriod INTEGER

The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes

items[].selfLink STRING

The URI of this bucket

items[].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

items[].timeCreated DATE_TIME

The creation time of the bucket in RFC 3339 format

items[].updated DATE_TIME

The modification time of the bucket in RFC 3339 format

items[].versioning OBJECT

The bucket's versioning configuration

items[].versioning.enabled BOOLEAN

While set to true, versioning is fully enabled for this bucket

items[].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

items[].website.mainPageSuffix STRING

If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages

items[].website.notFoundPage STRING

If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result

kind STRING

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

nextPageToken STRING

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results