Update
|
|||||
|
|
||||
Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate
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
- Manage your data and permissions in Google Cloud Storage
Input
This building block consumes 93 input parameters
| Name | Format | Description |
|---|---|---|
bucket Required |
STRING |
Name of a bucket |
ifMetagenerationMatch |
INTEGER |
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value |
ifMetagenerationNotMatch |
INTEGER |
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value |
predefinedAcl |
ENUMERATION |
Apply a predefined set of access controls to this bucket |
predefinedDefaultObjectAcl |
ENUMERATION |
Apply a predefined set of default object access controls to this bucket |
projection |
ENUMERATION |
Set of properties to return. Defaults to full |
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. Required for Requester Pays buckets |
acl[] |
OBJECT |
An access-control entry |
acl[].bucket |
STRING |
The name of the bucket |
acl[].domain |
STRING |
The domain associated with the entity, if any |
acl[].email |
STRING |
The email address associated with the entity, if any |
acl[].entity |
STRING |
The entity holding the permission, in one of the following forms:
|
acl[].entityId |
STRING |
The ID for the entity, if any |
acl[].etag |
STRING |
HTTP 1.1 Entity tag for the access-control entry |
acl[].id |
STRING |
The ID of the access-control entry |
acl[].kind |
STRING |
The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl |
acl[].projectTeam |
OBJECT |
The project team associated with the entity, if any |
acl[].projectTeam.projectNumber |
STRING |
The project number |
acl[].projectTeam.team |
STRING |
The team |
acl[].role |
STRING |
The access permission for the entity |
acl[].selfLink |
STRING |
The link to this access-control entry |
billing |
OBJECT |
The bucket's billing configuration |
billing.requesterPays |
BOOLEAN |
When set to true, Requester Pays is enabled for this bucket |
cors[] |
OBJECT |
|
cors[].maxAgeSeconds |
INTEGER |
The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses |
cors[].method[] |
STRING |
|
cors[].origin[] |
STRING |
|
cors[].responseHeader[] |
STRING |
|
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[] |
OBJECT |
An access-control entry |
defaultObjectAcl[].bucket |
STRING |
The name of the bucket |
defaultObjectAcl[].domain |
STRING |
The domain associated with the entity, if any |
defaultObjectAcl[].email |
STRING |
The email address associated with the entity, if any |
defaultObjectAcl[].entity |
STRING |
The entity holding the permission, in one of the following forms:
|
defaultObjectAcl[].entityId |
STRING |
The ID for the entity, if any |
defaultObjectAcl[].etag |
STRING |
HTTP 1.1 Entity tag for the access-control entry |
defaultObjectAcl[].generation |
INTEGER |
The content generation of the object, if applied to an object |
defaultObjectAcl[].id |
STRING |
The ID of the access-control entry |
defaultObjectAcl[].kind |
STRING |
The kind of item this is. For object access control entries, this is always storage#objectAccessControl |
defaultObjectAcl[].object |
STRING |
The name of the object, if applied to an object |
defaultObjectAcl[].projectTeam |
OBJECT |
The project team associated with the entity, if any |
defaultObjectAcl[].projectTeam.projectNumber |
STRING |
The project number |
defaultObjectAcl[].projectTeam.team |
STRING |
The team |
defaultObjectAcl[].role |
STRING |
The access permission for the entity |
defaultObjectAcl[].selfLink |
STRING |
The link to this access-control entry |
encryption |
OBJECT |
Encryption configuration for a bucket |
encryption.defaultKmsKeyName |
STRING |
A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified |
etag |
STRING |
HTTP 1.1 Entity tag for the bucket |
iamConfiguration |
OBJECT |
The bucket's IAM configuration |
iamConfiguration.bucketPolicyOnly |
OBJECT |
The bucket's Bucket Policy Only configuration |
iamConfiguration.bucketPolicyOnly.enabled |
BOOLEAN |
If set, access checks only use bucket-level IAM policies or above |
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 |
id |
STRING |
The ID of the bucket. For buckets, the id and name properties are the same |
kind |
STRING |
The kind of item this is. For buckets, this is always storage#bucket |
labels |
OBJECT |
User-provided labels, in key/value pairs |
labels.customKey.value Required |
STRING |
User-provided labels, in key/value pairs |
lifecycle |
OBJECT |
The bucket's lifecycle configuration. See lifecycle management for more information |
lifecycle.rule[] |
OBJECT |
|
lifecycle.rule[].action |
OBJECT |
The action to take |
lifecycle.rule[].action.storageClass |
STRING |
Target storage class. Required iff the type of the action is SetStorageClass |
lifecycle.rule[].action.type |
STRING |
Type of the action. Currently, only Delete and SetStorageClass are supported |
lifecycle.rule[].condition |
OBJECT |
The condition(s) under which the action will be taken |
lifecycle.rule[].condition.age |
INTEGER |
Age of an object (in days). This condition is satisfied when an object reaches the specified age |
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 |
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 |
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 |
lifecycle.rule[].condition.matchesStorageClass[] |
STRING |
|
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 |
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 |
logging.logBucket |
STRING |
The destination bucket where the current bucket's logs should be placed |
logging.logObjectPrefix |
STRING |
A prefix for log object names |
metageneration |
INTEGER |
The metadata generation of this bucket |
name |
STRING |
The name of the bucket |
owner |
OBJECT |
The owner of the bucket. This is always the project team's owner group |
owner.entity |
STRING |
The entity, in the form project-owner-projectId |
owner.entityId |
STRING |
The ID for the entity |
projectNumber |
INTEGER |
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 |
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 |
retentionPolicy.isLocked |
BOOLEAN |
Once locked, an object retention policy cannot be modified |
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 |
selfLink |
STRING |
The URI of this bucket |
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 |
timeCreated |
DATE_TIME |
The creation time of the bucket in RFC 3339 format |
updated |
DATE_TIME |
The modification time of the bucket in RFC 3339 format |
versioning |
OBJECT |
The bucket's versioning configuration |
versioning.enabled |
BOOLEAN |
While set to true, versioning is fully enabled for this bucket |
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 |
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 |
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 |
= Parameter name
= Format
|
bucket STRING Required Name of a bucket |
|
ifMetagenerationMatch INTEGER Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value |
|
ifMetagenerationNotMatch INTEGER Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value |
|
predefinedAcl ENUMERATION Apply a predefined set of access controls to this bucket |
|
predefinedDefaultObjectAcl ENUMERATION Apply a predefined set of default object access controls to this bucket |
|
projection ENUMERATION Set of properties to return. Defaults to full |
|
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. Required for Requester Pays buckets |
|
acl[] OBJECT An access-control entry |
|
acl[].bucket STRING The name of the bucket |
|
acl[].domain STRING The domain associated with the entity, if any |
|
acl[].email STRING The email address associated with the entity, if any |
|
acl[].entity STRING The entity holding the permission, in one of the following forms:
|
|
acl[].entityId STRING The ID for the entity, if any |
|
acl[].etag STRING HTTP 1.1 Entity tag for the access-control entry |
|
acl[].id STRING The ID of the access-control entry |
|
acl[].kind STRING The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl |
|
acl[].projectTeam OBJECT The project team associated with the entity, if any |
|
acl[].projectTeam.projectNumber STRING The project number |
|
acl[].projectTeam.team STRING The team |
|
acl[].role STRING The access permission for the entity |
|
acl[].selfLink STRING The link to this access-control entry |
|
billing OBJECT The bucket's billing configuration |
|
billing.requesterPays BOOLEAN When set to true, Requester Pays is enabled for this bucket |
|
cors[] OBJECT |
|
cors[].maxAgeSeconds INTEGER The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses |
|
cors[].method[] STRING |
|
cors[].origin[] STRING |
|
cors[].responseHeader[] STRING |
|
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[] OBJECT An access-control entry |
|
defaultObjectAcl[].bucket STRING The name of the bucket |
|
defaultObjectAcl[].domain STRING The domain associated with the entity, if any |
|
defaultObjectAcl[].email STRING The email address associated with the entity, if any |
|
defaultObjectAcl[].entity STRING The entity holding the permission, in one of the following forms:
|
|
defaultObjectAcl[].entityId STRING The ID for the entity, if any |
|
defaultObjectAcl[].etag STRING HTTP 1.1 Entity tag for the access-control entry |
|
defaultObjectAcl[].generation INTEGER The content generation of the object, if applied to an object |
|
defaultObjectAcl[].id STRING The ID of the access-control entry |
|
defaultObjectAcl[].kind STRING The kind of item this is. For object access control entries, this is always storage#objectAccessControl |
|
defaultObjectAcl[].object STRING The name of the object, if applied to an object |
|
defaultObjectAcl[].projectTeam OBJECT The project team associated with the entity, if any |
|
defaultObjectAcl[].projectTeam.projectNumber STRING The project number |
|
defaultObjectAcl[].projectTeam.team STRING The team |
|
defaultObjectAcl[].role STRING The access permission for the entity |
|
defaultObjectAcl[].selfLink STRING The link to this access-control entry |
|
encryption OBJECT Encryption configuration for a bucket |
|
encryption.defaultKmsKeyName STRING A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified |
|
etag STRING HTTP 1.1 Entity tag for the bucket |
|
iamConfiguration OBJECT The bucket's IAM configuration |
|
iamConfiguration.bucketPolicyOnly OBJECT The bucket's Bucket Policy Only configuration |
|
iamConfiguration.bucketPolicyOnly.enabled BOOLEAN If set, access checks only use bucket-level IAM policies or above |
|
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 |
|
id STRING The ID of the bucket. For buckets, the id and name properties are the same |
|
kind STRING The kind of item this is. For buckets, this is always storage#bucket |
|
labels OBJECT User-provided labels, in key/value pairs |
|
labels.customKey.value STRING Required User-provided labels, in key/value pairs |
|
lifecycle OBJECT The bucket's lifecycle configuration. See lifecycle management for more information |
|
lifecycle.rule[] OBJECT |
|
lifecycle.rule[].action OBJECT The action to take |
|
lifecycle.rule[].action.storageClass STRING Target storage class. Required iff the type of the action is SetStorageClass |
|
lifecycle.rule[].action.type STRING Type of the action. Currently, only Delete and SetStorageClass are supported |
|
lifecycle.rule[].condition OBJECT The condition(s) under which the action will be taken |
|
lifecycle.rule[].condition.age INTEGER Age of an object (in days). This condition is satisfied when an object reaches the specified age |
|
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 |
|
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 |
|
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 |
|
lifecycle.rule[].condition.matchesStorageClass[] STRING |
|
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 |
|
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 |
|
logging.logBucket STRING The destination bucket where the current bucket's logs should be placed |
|
logging.logObjectPrefix STRING A prefix for log object names |
|
metageneration INTEGER The metadata generation of this bucket |
|
name STRING The name of the bucket |
|
owner OBJECT The owner of the bucket. This is always the project team's owner group |
|
owner.entity STRING The entity, in the form project-owner-projectId |
|
owner.entityId STRING The ID for the entity |
|
projectNumber INTEGER 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 |
|
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 |
|
retentionPolicy.isLocked BOOLEAN Once locked, an object retention policy cannot be modified |
|
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 |
|
selfLink STRING The URI of this bucket |
|
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 |
|
timeCreated DATE_TIME The creation time of the bucket in RFC 3339 format |
|
updated DATE_TIME The modification time of the bucket in RFC 3339 format |
|
versioning OBJECT The bucket's versioning configuration |
|
versioning.enabled BOOLEAN While set to true, versioning is fully enabled for this bucket |
|
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 |
|
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 |
|
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 |
Output
This building block provides 85 output parameters
| Name | Format | Description |
|---|---|---|
acl[] |
OBJECT |
An access-control entry |
acl[].bucket |
STRING |
The name of the bucket |
acl[].domain |
STRING |
The domain associated with the entity, if any |
acl[].email |
STRING |
The email address associated with the entity, if any |
acl[].entity |
STRING |
The entity holding the permission, in one of the following forms:
|
acl[].entityId |
STRING |
The ID for the entity, if any |
acl[].etag |
STRING |
HTTP 1.1 Entity tag for the access-control entry |
acl[].id |
STRING |
The ID of the access-control entry |
acl[].kind |
STRING |
The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl |
acl[].projectTeam |
OBJECT |
The project team associated with the entity, if any |
acl[].projectTeam.projectNumber |
STRING |
The project number |
acl[].projectTeam.team |
STRING |
The team |
acl[].role |
STRING |
The access permission for the entity |
acl[].selfLink |
STRING |
The link to this access-control entry |
billing |
OBJECT |
The bucket's billing configuration |
billing.requesterPays |
BOOLEAN |
When set to true, Requester Pays is enabled for this bucket |
cors[] |
OBJECT |
|
cors[].maxAgeSeconds |
INTEGER |
The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses |
cors[].method[] |
STRING |
|
cors[].origin[] |
STRING |
|
cors[].responseHeader[] |
STRING |
|
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[] |
OBJECT |
An access-control entry |
defaultObjectAcl[].bucket |
STRING |
The name of the bucket |
defaultObjectAcl[].domain |
STRING |
The domain associated with the entity, if any |
defaultObjectAcl[].email |
STRING |
The email address associated with the entity, if any |
defaultObjectAcl[].entity |
STRING |
The entity holding the permission, in one of the following forms:
|
defaultObjectAcl[].entityId |
STRING |
The ID for the entity, if any |
defaultObjectAcl[].etag |
STRING |
HTTP 1.1 Entity tag for the access-control entry |
defaultObjectAcl[].generation |
INTEGER |
The content generation of the object, if applied to an object |
defaultObjectAcl[].id |
STRING |
The ID of the access-control entry |
defaultObjectAcl[].kind |
STRING |
The kind of item this is. For object access control entries, this is always storage#objectAccessControl |
defaultObjectAcl[].object |
STRING |
The name of the object, if applied to an object |
defaultObjectAcl[].projectTeam |
OBJECT |
The project team associated with the entity, if any |
defaultObjectAcl[].projectTeam.projectNumber |
STRING |
The project number |
defaultObjectAcl[].projectTeam.team |
STRING |
The team |
defaultObjectAcl[].role |
STRING |
The access permission for the entity |
defaultObjectAcl[].selfLink |
STRING |
The link to this access-control entry |
encryption |
OBJECT |
Encryption configuration for a bucket |
encryption.defaultKmsKeyName |
STRING |
A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified |
etag |
STRING |
HTTP 1.1 Entity tag for the bucket |
iamConfiguration |
OBJECT |
The bucket's IAM configuration |
iamConfiguration.bucketPolicyOnly |
OBJECT |
The bucket's Bucket Policy Only configuration |
iamConfiguration.bucketPolicyOnly.enabled |
BOOLEAN |
If set, access checks only use bucket-level IAM policies or above |
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 |
id |
STRING |
The ID of the bucket. For buckets, the id and name properties are the same |
kind |
STRING |
The kind of item this is. For buckets, this is always storage#bucket |
labels |
OBJECT |
User-provided labels, in key/value pairs |
labels.customKey.value |
STRING |
User-provided labels, in key/value pairs |
lifecycle |
OBJECT |
The bucket's lifecycle configuration. See lifecycle management for more information |
lifecycle.rule[] |
OBJECT |
|
lifecycle.rule[].action |
OBJECT |
The action to take |
lifecycle.rule[].action.storageClass |
STRING |
Target storage class. Required iff the type of the action is SetStorageClass |
lifecycle.rule[].action.type |
STRING |
Type of the action. Currently, only Delete and SetStorageClass are supported |
lifecycle.rule[].condition |
OBJECT |
The condition(s) under which the action will be taken |
lifecycle.rule[].condition.age |
INTEGER |
Age of an object (in days). This condition is satisfied when an object reaches the specified age |
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 |
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 |
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 |
lifecycle.rule[].condition.matchesStorageClass[] |
STRING |
|
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 |
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 |
logging.logBucket |
STRING |
The destination bucket where the current bucket's logs should be placed |
logging.logObjectPrefix |
STRING |
A prefix for log object names |
metageneration |
INTEGER |
The metadata generation of this bucket |
name |
STRING |
The name of the bucket |
owner |
OBJECT |
The owner of the bucket. This is always the project team's owner group |
owner.entity |
STRING |
The entity, in the form project-owner-projectId |
owner.entityId |
STRING |
The ID for the entity |
projectNumber |
INTEGER |
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 |
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 |
retentionPolicy.isLocked |
BOOLEAN |
Once locked, an object retention policy cannot be modified |
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 |
selfLink |
STRING |
The URI of this bucket |
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 |
timeCreated |
DATE_TIME |
The creation time of the bucket in RFC 3339 format |
updated |
DATE_TIME |
The modification time of the bucket in RFC 3339 format |
versioning |
OBJECT |
The bucket's versioning configuration |
versioning.enabled |
BOOLEAN |
While set to true, versioning is fully enabled for this bucket |
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 |
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 |
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 |
= Parameter name
= Format
|
acl[] OBJECT An access-control entry |
|
acl[].bucket STRING The name of the bucket |
|
acl[].domain STRING The domain associated with the entity, if any |
|
acl[].email STRING The email address associated with the entity, if any |
|
acl[].entity STRING The entity holding the permission, in one of the following forms:
|
|
acl[].entityId STRING The ID for the entity, if any |
|
acl[].etag STRING HTTP 1.1 Entity tag for the access-control entry |
|
acl[].id STRING The ID of the access-control entry |
|
acl[].kind STRING The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl |
|
acl[].projectTeam OBJECT The project team associated with the entity, if any |
|
acl[].projectTeam.projectNumber STRING The project number |
|
acl[].projectTeam.team STRING The team |
|
acl[].role STRING The access permission for the entity |
|
acl[].selfLink STRING The link to this access-control entry |
|
billing OBJECT The bucket's billing configuration |
|
billing.requesterPays BOOLEAN When set to true, Requester Pays is enabled for this bucket |
|
cors[] OBJECT |
|
cors[].maxAgeSeconds INTEGER The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses |
|
cors[].method[] STRING |
|
cors[].origin[] STRING |
|
cors[].responseHeader[] STRING |
|
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[] OBJECT An access-control entry |
|
defaultObjectAcl[].bucket STRING The name of the bucket |
|
defaultObjectAcl[].domain STRING The domain associated with the entity, if any |
|
defaultObjectAcl[].email STRING The email address associated with the entity, if any |
|
defaultObjectAcl[].entity STRING The entity holding the permission, in one of the following forms:
|
|
defaultObjectAcl[].entityId STRING The ID for the entity, if any |
|
defaultObjectAcl[].etag STRING HTTP 1.1 Entity tag for the access-control entry |
|
defaultObjectAcl[].generation INTEGER The content generation of the object, if applied to an object |
|
defaultObjectAcl[].id STRING The ID of the access-control entry |
|
defaultObjectAcl[].kind STRING The kind of item this is. For object access control entries, this is always storage#objectAccessControl |
|
defaultObjectAcl[].object STRING The name of the object, if applied to an object |
|
defaultObjectAcl[].projectTeam OBJECT The project team associated with the entity, if any |
|
defaultObjectAcl[].projectTeam.projectNumber STRING The project number |
|
defaultObjectAcl[].projectTeam.team STRING The team |
|
defaultObjectAcl[].role STRING The access permission for the entity |
|
defaultObjectAcl[].selfLink STRING The link to this access-control entry |
|
encryption OBJECT Encryption configuration for a bucket |
|
encryption.defaultKmsKeyName STRING A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified |
|
etag STRING HTTP 1.1 Entity tag for the bucket |
|
iamConfiguration OBJECT The bucket's IAM configuration |
|
iamConfiguration.bucketPolicyOnly OBJECT The bucket's Bucket Policy Only configuration |
|
iamConfiguration.bucketPolicyOnly.enabled BOOLEAN If set, access checks only use bucket-level IAM policies or above |
|
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 |
|
id STRING The ID of the bucket. For buckets, the id and name properties are the same |
|
kind STRING The kind of item this is. For buckets, this is always storage#bucket |
|
labels OBJECT User-provided labels, in key/value pairs |
|
labels.customKey.value STRING User-provided labels, in key/value pairs |
|
lifecycle OBJECT The bucket's lifecycle configuration. See lifecycle management for more information |
|
lifecycle.rule[] OBJECT |
|
lifecycle.rule[].action OBJECT The action to take |
|
lifecycle.rule[].action.storageClass STRING Target storage class. Required iff the type of the action is SetStorageClass |
|
lifecycle.rule[].action.type STRING Type of the action. Currently, only Delete and SetStorageClass are supported |
|
lifecycle.rule[].condition OBJECT The condition(s) under which the action will be taken |
|
lifecycle.rule[].condition.age INTEGER Age of an object (in days). This condition is satisfied when an object reaches the specified age |
|
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 |
|
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 |
|
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 |
|
lifecycle.rule[].condition.matchesStorageClass[] STRING |
|
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 |
|
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 |
|
logging.logBucket STRING The destination bucket where the current bucket's logs should be placed |
|
logging.logObjectPrefix STRING A prefix for log object names |
|
metageneration INTEGER The metadata generation of this bucket |
|
name STRING The name of the bucket |
|
owner OBJECT The owner of the bucket. This is always the project team's owner group |
|
owner.entity STRING The entity, in the form project-owner-projectId |
|
owner.entityId STRING The ID for the entity |
|
projectNumber INTEGER 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 |
|
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 |
|
retentionPolicy.isLocked BOOLEAN Once locked, an object retention policy cannot be modified |
|
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 |
|
selfLink STRING The URI of this bucket |
|
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 |
|
timeCreated DATE_TIME The creation time of the bucket in RFC 3339 format |
|
updated DATE_TIME The modification time of the bucket in RFC 3339 format |
|
versioning OBJECT The bucket's versioning configuration |
|
versioning.enabled BOOLEAN While set to true, versioning is fully enabled for this bucket |
|
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 |
|
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 |
|
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 |