1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="storage_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.buckets.html">buckets</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(bucket, ifMetagenerationMatch=None, userProject=None, provisionalUserProject=None, ifMetagenerationNotMatch=None)</a></code></p> 79<p class="firstline">Permanently deletes an empty bucket.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(bucket, projection=None, ifMetagenerationMatch=None, userProject=None, provisionalUserProject=None, ifMetagenerationNotMatch=None)</a></code></p> 82<p class="firstline">Returns metadata for the specified bucket.</p> 83<p class="toc_element"> 84 <code><a href="#getIamPolicy">getIamPolicy(bucket, userProject=None, provisionalUserProject=None)</a></code></p> 85<p class="firstline">Returns an IAM policy for the specified bucket.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body, projection=None, userProject=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, provisionalUserProject=None)</a></code></p> 88<p class="firstline">Creates a new bucket.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, projection=None, pageToken=None, userProject=None, prefix=None, maxResults=None, provisionalUserProject=None)</a></code></p> 91<p class="firstline">Retrieves a list of buckets for a given project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#lockRetentionPolicy">lockRetentionPolicy(bucket, ifMetagenerationMatch, userProject=None, provisionalUserProject=None)</a></code></p> 97<p class="firstline">Locks retention policy on a bucket.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(bucket, body, projection=None, ifMetagenerationMatch=None, userProject=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, provisionalUserProject=None, ifMetagenerationNotMatch=None)</a></code></p> 100<p class="firstline">Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.</p> 101<p class="toc_element"> 102 <code><a href="#setIamPolicy">setIamPolicy(bucket, body, userProject=None, provisionalUserProject=None)</a></code></p> 103<p class="firstline">Updates an IAM policy for the specified bucket.</p> 104<p class="toc_element"> 105 <code><a href="#testIamPermissions">testIamPermissions(bucket, permissions, userProject=None, provisionalUserProject=None)</a></code></p> 106<p class="firstline">Tests a set of permissions on the given bucket to see which, if any, are held by the caller.</p> 107<p class="toc_element"> 108 <code><a href="#update">update(bucket, body, projection=None, ifMetagenerationMatch=None, userProject=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, provisionalUserProject=None, ifMetagenerationNotMatch=None)</a></code></p> 109<p class="firstline">Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="delete">delete(bucket, ifMetagenerationMatch=None, userProject=None, provisionalUserProject=None, ifMetagenerationNotMatch=None)</code> 113 <pre>Permanently deletes an empty bucket. 114 115Args: 116 bucket: string, Name of a bucket. (required) 117 ifMetagenerationMatch: string, If set, only deletes the bucket if its metageneration matches this value. 118 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 119 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 120 ifMetagenerationNotMatch: string, If set, only deletes the bucket if its metageneration does not match this value. 121</pre> 122</div> 123 124<div class="method"> 125 <code class="details" id="get">get(bucket, projection=None, ifMetagenerationMatch=None, userProject=None, provisionalUserProject=None, ifMetagenerationNotMatch=None)</code> 126 <pre>Returns metadata for the specified bucket. 127 128Args: 129 bucket: string, Name of a bucket. (required) 130 projection: string, Set of properties to return. Defaults to noAcl. 131 Allowed values 132 full - Include all properties. 133 noAcl - Omit owner, acl and defaultObjectAcl properties. 134 ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. 135 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 136 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 137 ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. 138 139Returns: 140 An object of the form: 141 142 { # A bucket. 143 "labels": { # User-provided labels, in key/value pairs. 144 "a_key": "A String", # An individual label entry. 145 }, 146 "versioning": { # The bucket's versioning configuration. 147 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 148 }, 149 "owner": { # The owner of the bucket. This is always the project team's owner group. 150 "entityId": "A String", # The ID for the entity. 151 "entity": "A String", # The entity, in the form project-owner-projectId. 152 }, 153 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 154 "defaultEventBasedHold": True or False, # 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. 155 "billing": { # The bucket's billing configuration. 156 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 157 }, 158 "encryption": { # Encryption configuration for a bucket. 159 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 160 }, 161 "projectNumber": "A String", # The project number of the project the bucket belongs to. 162 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 163 "location": "A 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. 164 "website": { # 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. 165 "notFoundPage": "A 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. 166 "mainPageSuffix": "A 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. 167 }, 168 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 169 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 170 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 171 { # An access-control entry. 172 "domain": "A String", # The domain associated with the entity, if any. 173 "generation": "A String", # The content generation of the object, if applied to an object. 174 "object": "A String", # The name of the object, if applied to an object. 175 "bucket": "A String", # The name of the bucket. 176 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 177 "entity": "A String", # The entity holding the permission, in one of the following forms: 178 # - user-userId 179 # - user-email 180 # - group-groupId 181 # - group-email 182 # - domain-domain 183 # - project-team-projectId 184 # - allUsers 185 # - allAuthenticatedUsers Examples: 186 # - The user liz@example.com would be user-liz@example.com. 187 # - The group example@googlegroups.com would be group-example@googlegroups.com. 188 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 189 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 190 "role": "A String", # The access permission for the entity. 191 "id": "A String", # The ID of the access-control entry. 192 "entityId": "A String", # The ID for the entity, if any. 193 "projectTeam": { # The project team associated with the entity, if any. 194 "projectNumber": "A String", # The project number. 195 "team": "A String", # The team. 196 }, 197 "email": "A String", # The email address associated with the entity, if any. 198 "selfLink": "A String", # The link to this access-control entry. 199 }, 200 ], 201 "metageneration": "A String", # The metadata generation of this bucket. 202 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 203 { 204 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 205 "A String", 206 ], 207 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 208 "A String", 209 ], 210 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 211 "A String", 212 ], 213 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 214 }, 215 ], 216 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 217 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 218 { 219 "action": { # The action to take. 220 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 221 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 222 }, 223 "condition": { # The condition(s) under which the action will be taken. 224 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 225 "A String", 226 ], 227 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 228 "numNewerVersions": 42, # 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. 229 "createdBefore": "A String", # 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. 230 "matchesPattern": "A 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. 231 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 232 }, 233 }, 234 ], 235 }, 236 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 237 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 238 "logObjectPrefix": "A String", # A prefix for log object names. 239 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 240 }, 241 "name": "A String", # The name of the bucket. 242 "locationType": "A String", # The type of the bucket location. 243 "acl": [ # Access controls on the bucket. 244 { # An access-control entry. 245 "domain": "A String", # The domain associated with the entity, if any. 246 "bucket": "A String", # The name of the bucket. 247 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 248 "entity": "A String", # The entity holding the permission, in one of the following forms: 249 # - user-userId 250 # - user-email 251 # - group-groupId 252 # - group-email 253 # - domain-domain 254 # - project-team-projectId 255 # - allUsers 256 # - allAuthenticatedUsers Examples: 257 # - The user liz@example.com would be user-liz@example.com. 258 # - The group example@googlegroups.com would be group-example@googlegroups.com. 259 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 260 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 261 "role": "A String", # The access permission for the entity. 262 "id": "A String", # The ID of the access-control entry. 263 "entityId": "A String", # The ID for the entity, if any. 264 "projectTeam": { # The project team associated with the entity, if any. 265 "projectNumber": "A String", # The project number. 266 "team": "A String", # The team. 267 }, 268 "email": "A String", # The email address associated with the entity, if any. 269 "selfLink": "A String", # The link to this access-control entry. 270 }, 271 ], 272 "retentionPolicy": { # 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. 273 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 274 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 275 "retentionPeriod": "A String", # 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. 276 }, 277 "storageClass": "A 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. 278 "iamConfiguration": { # The bucket's IAM configuration. 279 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 280 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 281 "lockedTime": "A String", # 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. 282 }, 283 }, 284 "selfLink": "A String", # The URI of this bucket. 285 }</pre> 286</div> 287 288<div class="method"> 289 <code class="details" id="getIamPolicy">getIamPolicy(bucket, userProject=None, provisionalUserProject=None)</code> 290 <pre>Returns an IAM policy for the specified bucket. 291 292Args: 293 bucket: string, Name of a bucket. (required) 294 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 295 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 296 297Returns: 298 An object of the form: 299 300 { # A bucket/object IAM policy. 301 "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. 302 "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role. 303 { 304 "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole. 305 # The new IAM roles are: 306 # - roles/storage.admin — Full control of Google Cloud Storage resources. 307 # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects. 308 # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage. 309 # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are: 310 # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role. 311 # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role. 312 # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role. 313 # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role. 314 # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role. 315 "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows: 316 # - allUsers — A special identifier that represents anyone on the internet; with or without a Google account. 317 # - allAuthenticatedUsers — A special identifier that represents anyone who is authenticated with a Google account or a service account. 318 # - user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com. 319 # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . 320 # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com. 321 # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com. 322 # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project 323 # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project 324 # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project 325 "A String", 326 ], 327 "condition": { # Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" # The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 328 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 329 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. 330 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 331 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 332 }, 333 }, 334 ], 335 "etag": "A String", # HTTP 1.1 Entity tag for the policy. 336 "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. 337 }</pre> 338</div> 339 340<div class="method"> 341 <code class="details" id="insert">insert(project, body, projection=None, userProject=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, provisionalUserProject=None)</code> 342 <pre>Creates a new bucket. 343 344Args: 345 project: string, A valid API project identifier. (required) 346 body: object, The request body. (required) 347 The object takes the form of: 348 349{ # A bucket. 350 "labels": { # User-provided labels, in key/value pairs. 351 "a_key": "A String", # An individual label entry. 352 }, 353 "versioning": { # The bucket's versioning configuration. 354 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 355 }, 356 "owner": { # The owner of the bucket. This is always the project team's owner group. 357 "entityId": "A String", # The ID for the entity. 358 "entity": "A String", # The entity, in the form project-owner-projectId. 359 }, 360 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 361 "defaultEventBasedHold": True or False, # 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. 362 "billing": { # The bucket's billing configuration. 363 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 364 }, 365 "encryption": { # Encryption configuration for a bucket. 366 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 367 }, 368 "projectNumber": "A String", # The project number of the project the bucket belongs to. 369 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 370 "location": "A 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. 371 "website": { # 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. 372 "notFoundPage": "A 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. 373 "mainPageSuffix": "A 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. 374 }, 375 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 376 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 377 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 378 { # An access-control entry. 379 "domain": "A String", # The domain associated with the entity, if any. 380 "generation": "A String", # The content generation of the object, if applied to an object. 381 "object": "A String", # The name of the object, if applied to an object. 382 "bucket": "A String", # The name of the bucket. 383 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 384 "entity": "A String", # The entity holding the permission, in one of the following forms: 385 # - user-userId 386 # - user-email 387 # - group-groupId 388 # - group-email 389 # - domain-domain 390 # - project-team-projectId 391 # - allUsers 392 # - allAuthenticatedUsers Examples: 393 # - The user liz@example.com would be user-liz@example.com. 394 # - The group example@googlegroups.com would be group-example@googlegroups.com. 395 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 396 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 397 "role": "A String", # The access permission for the entity. 398 "id": "A String", # The ID of the access-control entry. 399 "entityId": "A String", # The ID for the entity, if any. 400 "projectTeam": { # The project team associated with the entity, if any. 401 "projectNumber": "A String", # The project number. 402 "team": "A String", # The team. 403 }, 404 "email": "A String", # The email address associated with the entity, if any. 405 "selfLink": "A String", # The link to this access-control entry. 406 }, 407 ], 408 "metageneration": "A String", # The metadata generation of this bucket. 409 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 410 { 411 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 412 "A String", 413 ], 414 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 415 "A String", 416 ], 417 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 418 "A String", 419 ], 420 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 421 }, 422 ], 423 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 424 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 425 { 426 "action": { # The action to take. 427 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 428 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 429 }, 430 "condition": { # The condition(s) under which the action will be taken. 431 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 432 "A String", 433 ], 434 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 435 "numNewerVersions": 42, # 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. 436 "createdBefore": "A String", # 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. 437 "matchesPattern": "A 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. 438 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 439 }, 440 }, 441 ], 442 }, 443 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 444 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 445 "logObjectPrefix": "A String", # A prefix for log object names. 446 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 447 }, 448 "name": "A String", # The name of the bucket. 449 "locationType": "A String", # The type of the bucket location. 450 "acl": [ # Access controls on the bucket. 451 { # An access-control entry. 452 "domain": "A String", # The domain associated with the entity, if any. 453 "bucket": "A String", # The name of the bucket. 454 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 455 "entity": "A String", # The entity holding the permission, in one of the following forms: 456 # - user-userId 457 # - user-email 458 # - group-groupId 459 # - group-email 460 # - domain-domain 461 # - project-team-projectId 462 # - allUsers 463 # - allAuthenticatedUsers Examples: 464 # - The user liz@example.com would be user-liz@example.com. 465 # - The group example@googlegroups.com would be group-example@googlegroups.com. 466 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 467 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 468 "role": "A String", # The access permission for the entity. 469 "id": "A String", # The ID of the access-control entry. 470 "entityId": "A String", # The ID for the entity, if any. 471 "projectTeam": { # The project team associated with the entity, if any. 472 "projectNumber": "A String", # The project number. 473 "team": "A String", # The team. 474 }, 475 "email": "A String", # The email address associated with the entity, if any. 476 "selfLink": "A String", # The link to this access-control entry. 477 }, 478 ], 479 "retentionPolicy": { # 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. 480 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 481 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 482 "retentionPeriod": "A String", # 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. 483 }, 484 "storageClass": "A 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. 485 "iamConfiguration": { # The bucket's IAM configuration. 486 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 487 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 488 "lockedTime": "A String", # 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. 489 }, 490 }, 491 "selfLink": "A String", # The URI of this bucket. 492 } 493 494 projection: string, Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. 495 Allowed values 496 full - Include all properties. 497 noAcl - Omit owner, acl and defaultObjectAcl properties. 498 userProject: string, The project to be billed for this request. 499 predefinedDefaultObjectAcl: string, Apply a predefined set of default object access controls to this bucket. 500 Allowed values 501 authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access. 502 bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access. 503 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access. 504 private - Object owner gets OWNER access. 505 projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles. 506 publicRead - Object owner gets OWNER access, and allUsers get READER access. 507 predefinedAcl: string, Apply a predefined set of access controls to this bucket. 508 Allowed values 509 authenticatedRead - Project team owners get OWNER access, and allAuthenticatedUsers get READER access. 510 private - Project team owners get OWNER access. 511 projectPrivate - Project team members get access according to their roles. 512 publicRead - Project team owners get OWNER access, and allUsers get READER access. 513 publicReadWrite - Project team owners get OWNER access, and allUsers get WRITER access. 514 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 515 516Returns: 517 An object of the form: 518 519 { # A bucket. 520 "labels": { # User-provided labels, in key/value pairs. 521 "a_key": "A String", # An individual label entry. 522 }, 523 "versioning": { # The bucket's versioning configuration. 524 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 525 }, 526 "owner": { # The owner of the bucket. This is always the project team's owner group. 527 "entityId": "A String", # The ID for the entity. 528 "entity": "A String", # The entity, in the form project-owner-projectId. 529 }, 530 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 531 "defaultEventBasedHold": True or False, # 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. 532 "billing": { # The bucket's billing configuration. 533 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 534 }, 535 "encryption": { # Encryption configuration for a bucket. 536 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 537 }, 538 "projectNumber": "A String", # The project number of the project the bucket belongs to. 539 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 540 "location": "A 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. 541 "website": { # 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. 542 "notFoundPage": "A 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. 543 "mainPageSuffix": "A 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. 544 }, 545 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 546 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 547 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 548 { # An access-control entry. 549 "domain": "A String", # The domain associated with the entity, if any. 550 "generation": "A String", # The content generation of the object, if applied to an object. 551 "object": "A String", # The name of the object, if applied to an object. 552 "bucket": "A String", # The name of the bucket. 553 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 554 "entity": "A String", # The entity holding the permission, in one of the following forms: 555 # - user-userId 556 # - user-email 557 # - group-groupId 558 # - group-email 559 # - domain-domain 560 # - project-team-projectId 561 # - allUsers 562 # - allAuthenticatedUsers Examples: 563 # - The user liz@example.com would be user-liz@example.com. 564 # - The group example@googlegroups.com would be group-example@googlegroups.com. 565 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 566 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 567 "role": "A String", # The access permission for the entity. 568 "id": "A String", # The ID of the access-control entry. 569 "entityId": "A String", # The ID for the entity, if any. 570 "projectTeam": { # The project team associated with the entity, if any. 571 "projectNumber": "A String", # The project number. 572 "team": "A String", # The team. 573 }, 574 "email": "A String", # The email address associated with the entity, if any. 575 "selfLink": "A String", # The link to this access-control entry. 576 }, 577 ], 578 "metageneration": "A String", # The metadata generation of this bucket. 579 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 580 { 581 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 582 "A String", 583 ], 584 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 585 "A String", 586 ], 587 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 588 "A String", 589 ], 590 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 591 }, 592 ], 593 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 594 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 595 { 596 "action": { # The action to take. 597 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 598 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 599 }, 600 "condition": { # The condition(s) under which the action will be taken. 601 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 602 "A String", 603 ], 604 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 605 "numNewerVersions": 42, # 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. 606 "createdBefore": "A String", # 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. 607 "matchesPattern": "A 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. 608 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 609 }, 610 }, 611 ], 612 }, 613 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 614 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 615 "logObjectPrefix": "A String", # A prefix for log object names. 616 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 617 }, 618 "name": "A String", # The name of the bucket. 619 "locationType": "A String", # The type of the bucket location. 620 "acl": [ # Access controls on the bucket. 621 { # An access-control entry. 622 "domain": "A String", # The domain associated with the entity, if any. 623 "bucket": "A String", # The name of the bucket. 624 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 625 "entity": "A String", # The entity holding the permission, in one of the following forms: 626 # - user-userId 627 # - user-email 628 # - group-groupId 629 # - group-email 630 # - domain-domain 631 # - project-team-projectId 632 # - allUsers 633 # - allAuthenticatedUsers Examples: 634 # - The user liz@example.com would be user-liz@example.com. 635 # - The group example@googlegroups.com would be group-example@googlegroups.com. 636 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 637 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 638 "role": "A String", # The access permission for the entity. 639 "id": "A String", # The ID of the access-control entry. 640 "entityId": "A String", # The ID for the entity, if any. 641 "projectTeam": { # The project team associated with the entity, if any. 642 "projectNumber": "A String", # The project number. 643 "team": "A String", # The team. 644 }, 645 "email": "A String", # The email address associated with the entity, if any. 646 "selfLink": "A String", # The link to this access-control entry. 647 }, 648 ], 649 "retentionPolicy": { # 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. 650 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 651 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 652 "retentionPeriod": "A String", # 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. 653 }, 654 "storageClass": "A 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. 655 "iamConfiguration": { # The bucket's IAM configuration. 656 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 657 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 658 "lockedTime": "A String", # 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. 659 }, 660 }, 661 "selfLink": "A String", # The URI of this bucket. 662 }</pre> 663</div> 664 665<div class="method"> 666 <code class="details" id="list">list(project, projection=None, pageToken=None, userProject=None, prefix=None, maxResults=None, provisionalUserProject=None)</code> 667 <pre>Retrieves a list of buckets for a given project. 668 669Args: 670 project: string, A valid API project identifier. (required) 671 projection: string, Set of properties to return. Defaults to noAcl. 672 Allowed values 673 full - Include all properties. 674 noAcl - Omit owner, acl and defaultObjectAcl properties. 675 pageToken: string, A previously-returned page token representing part of the larger set of results to view. 676 userProject: string, The project to be billed for this request. 677 prefix: string, Filter results to buckets whose names begin with this prefix. 678 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. 679 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 680 681Returns: 682 An object of the form: 683 684 { # A list of buckets. 685 "nextPageToken": "A 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. 686 "items": [ # The list of items. 687 { # A bucket. 688 "labels": { # User-provided labels, in key/value pairs. 689 "a_key": "A String", # An individual label entry. 690 }, 691 "versioning": { # The bucket's versioning configuration. 692 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 693 }, 694 "owner": { # The owner of the bucket. This is always the project team's owner group. 695 "entityId": "A String", # The ID for the entity. 696 "entity": "A String", # The entity, in the form project-owner-projectId. 697 }, 698 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 699 "defaultEventBasedHold": True or False, # 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. 700 "billing": { # The bucket's billing configuration. 701 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 702 }, 703 "encryption": { # Encryption configuration for a bucket. 704 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 705 }, 706 "projectNumber": "A String", # The project number of the project the bucket belongs to. 707 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 708 "location": "A 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. 709 "website": { # 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. 710 "notFoundPage": "A 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. 711 "mainPageSuffix": "A 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. 712 }, 713 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 714 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 715 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 716 { # An access-control entry. 717 "domain": "A String", # The domain associated with the entity, if any. 718 "generation": "A String", # The content generation of the object, if applied to an object. 719 "object": "A String", # The name of the object, if applied to an object. 720 "bucket": "A String", # The name of the bucket. 721 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 722 "entity": "A String", # The entity holding the permission, in one of the following forms: 723 # - user-userId 724 # - user-email 725 # - group-groupId 726 # - group-email 727 # - domain-domain 728 # - project-team-projectId 729 # - allUsers 730 # - allAuthenticatedUsers Examples: 731 # - The user liz@example.com would be user-liz@example.com. 732 # - The group example@googlegroups.com would be group-example@googlegroups.com. 733 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 734 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 735 "role": "A String", # The access permission for the entity. 736 "id": "A String", # The ID of the access-control entry. 737 "entityId": "A String", # The ID for the entity, if any. 738 "projectTeam": { # The project team associated with the entity, if any. 739 "projectNumber": "A String", # The project number. 740 "team": "A String", # The team. 741 }, 742 "email": "A String", # The email address associated with the entity, if any. 743 "selfLink": "A String", # The link to this access-control entry. 744 }, 745 ], 746 "metageneration": "A String", # The metadata generation of this bucket. 747 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 748 { 749 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 750 "A String", 751 ], 752 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 753 "A String", 754 ], 755 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 756 "A String", 757 ], 758 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 759 }, 760 ], 761 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 762 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 763 { 764 "action": { # The action to take. 765 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 766 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 767 }, 768 "condition": { # The condition(s) under which the action will be taken. 769 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 770 "A String", 771 ], 772 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 773 "numNewerVersions": 42, # 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. 774 "createdBefore": "A String", # 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. 775 "matchesPattern": "A 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. 776 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 777 }, 778 }, 779 ], 780 }, 781 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 782 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 783 "logObjectPrefix": "A String", # A prefix for log object names. 784 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 785 }, 786 "name": "A String", # The name of the bucket. 787 "locationType": "A String", # The type of the bucket location. 788 "acl": [ # Access controls on the bucket. 789 { # An access-control entry. 790 "domain": "A String", # The domain associated with the entity, if any. 791 "bucket": "A String", # The name of the bucket. 792 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 793 "entity": "A String", # The entity holding the permission, in one of the following forms: 794 # - user-userId 795 # - user-email 796 # - group-groupId 797 # - group-email 798 # - domain-domain 799 # - project-team-projectId 800 # - allUsers 801 # - allAuthenticatedUsers Examples: 802 # - The user liz@example.com would be user-liz@example.com. 803 # - The group example@googlegroups.com would be group-example@googlegroups.com. 804 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 805 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 806 "role": "A String", # The access permission for the entity. 807 "id": "A String", # The ID of the access-control entry. 808 "entityId": "A String", # The ID for the entity, if any. 809 "projectTeam": { # The project team associated with the entity, if any. 810 "projectNumber": "A String", # The project number. 811 "team": "A String", # The team. 812 }, 813 "email": "A String", # The email address associated with the entity, if any. 814 "selfLink": "A String", # The link to this access-control entry. 815 }, 816 ], 817 "retentionPolicy": { # 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. 818 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 819 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 820 "retentionPeriod": "A String", # 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. 821 }, 822 "storageClass": "A 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. 823 "iamConfiguration": { # The bucket's IAM configuration. 824 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 825 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 826 "lockedTime": "A String", # 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. 827 }, 828 }, 829 "selfLink": "A String", # The URI of this bucket. 830 }, 831 ], 832 "kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets. 833 }</pre> 834</div> 835 836<div class="method"> 837 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 838 <pre>Retrieves the next page of results. 839 840Args: 841 previous_request: The request for the previous page. (required) 842 previous_response: The response from the request for the previous page. (required) 843 844Returns: 845 A request object that you can call 'execute()' on to request the next 846 page. Returns None if there are no more items in the collection. 847 </pre> 848</div> 849 850<div class="method"> 851 <code class="details" id="lockRetentionPolicy">lockRetentionPolicy(bucket, ifMetagenerationMatch, userProject=None, provisionalUserProject=None)</code> 852 <pre>Locks retention policy on a bucket. 853 854Args: 855 bucket: string, Name of a bucket. (required) 856 ifMetagenerationMatch: string, Makes the operation conditional on whether bucket's current metageneration matches the given value. (required) 857 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 858 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 859 860Returns: 861 An object of the form: 862 863 { # A bucket. 864 "labels": { # User-provided labels, in key/value pairs. 865 "a_key": "A String", # An individual label entry. 866 }, 867 "versioning": { # The bucket's versioning configuration. 868 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 869 }, 870 "owner": { # The owner of the bucket. This is always the project team's owner group. 871 "entityId": "A String", # The ID for the entity. 872 "entity": "A String", # The entity, in the form project-owner-projectId. 873 }, 874 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 875 "defaultEventBasedHold": True or False, # 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. 876 "billing": { # The bucket's billing configuration. 877 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 878 }, 879 "encryption": { # Encryption configuration for a bucket. 880 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 881 }, 882 "projectNumber": "A String", # The project number of the project the bucket belongs to. 883 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 884 "location": "A 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. 885 "website": { # 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. 886 "notFoundPage": "A 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. 887 "mainPageSuffix": "A 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. 888 }, 889 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 890 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 891 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 892 { # An access-control entry. 893 "domain": "A String", # The domain associated with the entity, if any. 894 "generation": "A String", # The content generation of the object, if applied to an object. 895 "object": "A String", # The name of the object, if applied to an object. 896 "bucket": "A String", # The name of the bucket. 897 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 898 "entity": "A String", # The entity holding the permission, in one of the following forms: 899 # - user-userId 900 # - user-email 901 # - group-groupId 902 # - group-email 903 # - domain-domain 904 # - project-team-projectId 905 # - allUsers 906 # - allAuthenticatedUsers Examples: 907 # - The user liz@example.com would be user-liz@example.com. 908 # - The group example@googlegroups.com would be group-example@googlegroups.com. 909 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 910 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 911 "role": "A String", # The access permission for the entity. 912 "id": "A String", # The ID of the access-control entry. 913 "entityId": "A String", # The ID for the entity, if any. 914 "projectTeam": { # The project team associated with the entity, if any. 915 "projectNumber": "A String", # The project number. 916 "team": "A String", # The team. 917 }, 918 "email": "A String", # The email address associated with the entity, if any. 919 "selfLink": "A String", # The link to this access-control entry. 920 }, 921 ], 922 "metageneration": "A String", # The metadata generation of this bucket. 923 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 924 { 925 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 926 "A String", 927 ], 928 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 929 "A String", 930 ], 931 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 932 "A String", 933 ], 934 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 935 }, 936 ], 937 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 938 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 939 { 940 "action": { # The action to take. 941 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 942 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 943 }, 944 "condition": { # The condition(s) under which the action will be taken. 945 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 946 "A String", 947 ], 948 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 949 "numNewerVersions": 42, # 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. 950 "createdBefore": "A String", # 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. 951 "matchesPattern": "A 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. 952 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 953 }, 954 }, 955 ], 956 }, 957 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 958 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 959 "logObjectPrefix": "A String", # A prefix for log object names. 960 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 961 }, 962 "name": "A String", # The name of the bucket. 963 "locationType": "A String", # The type of the bucket location. 964 "acl": [ # Access controls on the bucket. 965 { # An access-control entry. 966 "domain": "A String", # The domain associated with the entity, if any. 967 "bucket": "A String", # The name of the bucket. 968 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 969 "entity": "A String", # The entity holding the permission, in one of the following forms: 970 # - user-userId 971 # - user-email 972 # - group-groupId 973 # - group-email 974 # - domain-domain 975 # - project-team-projectId 976 # - allUsers 977 # - allAuthenticatedUsers Examples: 978 # - The user liz@example.com would be user-liz@example.com. 979 # - The group example@googlegroups.com would be group-example@googlegroups.com. 980 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 981 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 982 "role": "A String", # The access permission for the entity. 983 "id": "A String", # The ID of the access-control entry. 984 "entityId": "A String", # The ID for the entity, if any. 985 "projectTeam": { # The project team associated with the entity, if any. 986 "projectNumber": "A String", # The project number. 987 "team": "A String", # The team. 988 }, 989 "email": "A String", # The email address associated with the entity, if any. 990 "selfLink": "A String", # The link to this access-control entry. 991 }, 992 ], 993 "retentionPolicy": { # 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. 994 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 995 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 996 "retentionPeriod": "A String", # 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. 997 }, 998 "storageClass": "A 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. 999 "iamConfiguration": { # The bucket's IAM configuration. 1000 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 1001 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 1002 "lockedTime": "A String", # 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. 1003 }, 1004 }, 1005 "selfLink": "A String", # The URI of this bucket. 1006 }</pre> 1007</div> 1008 1009<div class="method"> 1010 <code class="details" id="patch">patch(bucket, body, projection=None, ifMetagenerationMatch=None, userProject=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, provisionalUserProject=None, ifMetagenerationNotMatch=None)</code> 1011 <pre>Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. 1012 1013Args: 1014 bucket: string, Name of a bucket. (required) 1015 body: object, The request body. (required) 1016 The object takes the form of: 1017 1018{ # A bucket. 1019 "labels": { # User-provided labels, in key/value pairs. 1020 "a_key": "A String", # An individual label entry. 1021 }, 1022 "versioning": { # The bucket's versioning configuration. 1023 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 1024 }, 1025 "owner": { # The owner of the bucket. This is always the project team's owner group. 1026 "entityId": "A String", # The ID for the entity. 1027 "entity": "A String", # The entity, in the form project-owner-projectId. 1028 }, 1029 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 1030 "defaultEventBasedHold": True or False, # 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. 1031 "billing": { # The bucket's billing configuration. 1032 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 1033 }, 1034 "encryption": { # Encryption configuration for a bucket. 1035 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 1036 }, 1037 "projectNumber": "A String", # The project number of the project the bucket belongs to. 1038 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 1039 "location": "A 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. 1040 "website": { # 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. 1041 "notFoundPage": "A 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. 1042 "mainPageSuffix": "A 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. 1043 }, 1044 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 1045 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 1046 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 1047 { # An access-control entry. 1048 "domain": "A String", # The domain associated with the entity, if any. 1049 "generation": "A String", # The content generation of the object, if applied to an object. 1050 "object": "A String", # The name of the object, if applied to an object. 1051 "bucket": "A String", # The name of the bucket. 1052 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1053 "entity": "A String", # The entity holding the permission, in one of the following forms: 1054 # - user-userId 1055 # - user-email 1056 # - group-groupId 1057 # - group-email 1058 # - domain-domain 1059 # - project-team-projectId 1060 # - allUsers 1061 # - allAuthenticatedUsers Examples: 1062 # - The user liz@example.com would be user-liz@example.com. 1063 # - The group example@googlegroups.com would be group-example@googlegroups.com. 1064 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1065 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1066 "role": "A String", # The access permission for the entity. 1067 "id": "A String", # The ID of the access-control entry. 1068 "entityId": "A String", # The ID for the entity, if any. 1069 "projectTeam": { # The project team associated with the entity, if any. 1070 "projectNumber": "A String", # The project number. 1071 "team": "A String", # The team. 1072 }, 1073 "email": "A String", # The email address associated with the entity, if any. 1074 "selfLink": "A String", # The link to this access-control entry. 1075 }, 1076 ], 1077 "metageneration": "A String", # The metadata generation of this bucket. 1078 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 1079 { 1080 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 1081 "A String", 1082 ], 1083 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 1084 "A String", 1085 ], 1086 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 1087 "A String", 1088 ], 1089 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 1090 }, 1091 ], 1092 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 1093 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 1094 { 1095 "action": { # The action to take. 1096 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 1097 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 1098 }, 1099 "condition": { # The condition(s) under which the action will be taken. 1100 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 1101 "A String", 1102 ], 1103 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 1104 "numNewerVersions": 42, # 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. 1105 "createdBefore": "A String", # 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. 1106 "matchesPattern": "A 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. 1107 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 1108 }, 1109 }, 1110 ], 1111 }, 1112 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 1113 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 1114 "logObjectPrefix": "A String", # A prefix for log object names. 1115 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 1116 }, 1117 "name": "A String", # The name of the bucket. 1118 "locationType": "A String", # The type of the bucket location. 1119 "acl": [ # Access controls on the bucket. 1120 { # An access-control entry. 1121 "domain": "A String", # The domain associated with the entity, if any. 1122 "bucket": "A String", # The name of the bucket. 1123 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 1124 "entity": "A String", # The entity holding the permission, in one of the following forms: 1125 # - user-userId 1126 # - user-email 1127 # - group-groupId 1128 # - group-email 1129 # - domain-domain 1130 # - project-team-projectId 1131 # - allUsers 1132 # - allAuthenticatedUsers Examples: 1133 # - The user liz@example.com would be user-liz@example.com. 1134 # - The group example@googlegroups.com would be group-example@googlegroups.com. 1135 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1136 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1137 "role": "A String", # The access permission for the entity. 1138 "id": "A String", # The ID of the access-control entry. 1139 "entityId": "A String", # The ID for the entity, if any. 1140 "projectTeam": { # The project team associated with the entity, if any. 1141 "projectNumber": "A String", # The project number. 1142 "team": "A String", # The team. 1143 }, 1144 "email": "A String", # The email address associated with the entity, if any. 1145 "selfLink": "A String", # The link to this access-control entry. 1146 }, 1147 ], 1148 "retentionPolicy": { # 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. 1149 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 1150 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 1151 "retentionPeriod": "A String", # 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. 1152 }, 1153 "storageClass": "A 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. 1154 "iamConfiguration": { # The bucket's IAM configuration. 1155 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 1156 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 1157 "lockedTime": "A String", # 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. 1158 }, 1159 }, 1160 "selfLink": "A String", # The URI of this bucket. 1161 } 1162 1163 projection: string, Set of properties to return. Defaults to full. 1164 Allowed values 1165 full - Include all properties. 1166 noAcl - Omit owner, acl and defaultObjectAcl properties. 1167 ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. 1168 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 1169 predefinedDefaultObjectAcl: string, Apply a predefined set of default object access controls to this bucket. 1170 Allowed values 1171 authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access. 1172 bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access. 1173 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access. 1174 private - Object owner gets OWNER access. 1175 projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles. 1176 publicRead - Object owner gets OWNER access, and allUsers get READER access. 1177 predefinedAcl: string, Apply a predefined set of access controls to this bucket. 1178 Allowed values 1179 authenticatedRead - Project team owners get OWNER access, and allAuthenticatedUsers get READER access. 1180 private - Project team owners get OWNER access. 1181 projectPrivate - Project team members get access according to their roles. 1182 publicRead - Project team owners get OWNER access, and allUsers get READER access. 1183 publicReadWrite - Project team owners get OWNER access, and allUsers get WRITER access. 1184 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 1185 ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. 1186 1187Returns: 1188 An object of the form: 1189 1190 { # A bucket. 1191 "labels": { # User-provided labels, in key/value pairs. 1192 "a_key": "A String", # An individual label entry. 1193 }, 1194 "versioning": { # The bucket's versioning configuration. 1195 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 1196 }, 1197 "owner": { # The owner of the bucket. This is always the project team's owner group. 1198 "entityId": "A String", # The ID for the entity. 1199 "entity": "A String", # The entity, in the form project-owner-projectId. 1200 }, 1201 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 1202 "defaultEventBasedHold": True or False, # 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. 1203 "billing": { # The bucket's billing configuration. 1204 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 1205 }, 1206 "encryption": { # Encryption configuration for a bucket. 1207 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 1208 }, 1209 "projectNumber": "A String", # The project number of the project the bucket belongs to. 1210 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 1211 "location": "A 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. 1212 "website": { # 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. 1213 "notFoundPage": "A 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. 1214 "mainPageSuffix": "A 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. 1215 }, 1216 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 1217 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 1218 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 1219 { # An access-control entry. 1220 "domain": "A String", # The domain associated with the entity, if any. 1221 "generation": "A String", # The content generation of the object, if applied to an object. 1222 "object": "A String", # The name of the object, if applied to an object. 1223 "bucket": "A String", # The name of the bucket. 1224 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1225 "entity": "A String", # The entity holding the permission, in one of the following forms: 1226 # - user-userId 1227 # - user-email 1228 # - group-groupId 1229 # - group-email 1230 # - domain-domain 1231 # - project-team-projectId 1232 # - allUsers 1233 # - allAuthenticatedUsers Examples: 1234 # - The user liz@example.com would be user-liz@example.com. 1235 # - The group example@googlegroups.com would be group-example@googlegroups.com. 1236 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1237 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1238 "role": "A String", # The access permission for the entity. 1239 "id": "A String", # The ID of the access-control entry. 1240 "entityId": "A String", # The ID for the entity, if any. 1241 "projectTeam": { # The project team associated with the entity, if any. 1242 "projectNumber": "A String", # The project number. 1243 "team": "A String", # The team. 1244 }, 1245 "email": "A String", # The email address associated with the entity, if any. 1246 "selfLink": "A String", # The link to this access-control entry. 1247 }, 1248 ], 1249 "metageneration": "A String", # The metadata generation of this bucket. 1250 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 1251 { 1252 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 1253 "A String", 1254 ], 1255 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 1256 "A String", 1257 ], 1258 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 1259 "A String", 1260 ], 1261 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 1262 }, 1263 ], 1264 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 1265 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 1266 { 1267 "action": { # The action to take. 1268 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 1269 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 1270 }, 1271 "condition": { # The condition(s) under which the action will be taken. 1272 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 1273 "A String", 1274 ], 1275 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 1276 "numNewerVersions": 42, # 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. 1277 "createdBefore": "A String", # 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. 1278 "matchesPattern": "A 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. 1279 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 1280 }, 1281 }, 1282 ], 1283 }, 1284 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 1285 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 1286 "logObjectPrefix": "A String", # A prefix for log object names. 1287 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 1288 }, 1289 "name": "A String", # The name of the bucket. 1290 "locationType": "A String", # The type of the bucket location. 1291 "acl": [ # Access controls on the bucket. 1292 { # An access-control entry. 1293 "domain": "A String", # The domain associated with the entity, if any. 1294 "bucket": "A String", # The name of the bucket. 1295 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 1296 "entity": "A String", # The entity holding the permission, in one of the following forms: 1297 # - user-userId 1298 # - user-email 1299 # - group-groupId 1300 # - group-email 1301 # - domain-domain 1302 # - project-team-projectId 1303 # - allUsers 1304 # - allAuthenticatedUsers Examples: 1305 # - The user liz@example.com would be user-liz@example.com. 1306 # - The group example@googlegroups.com would be group-example@googlegroups.com. 1307 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1308 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1309 "role": "A String", # The access permission for the entity. 1310 "id": "A String", # The ID of the access-control entry. 1311 "entityId": "A String", # The ID for the entity, if any. 1312 "projectTeam": { # The project team associated with the entity, if any. 1313 "projectNumber": "A String", # The project number. 1314 "team": "A String", # The team. 1315 }, 1316 "email": "A String", # The email address associated with the entity, if any. 1317 "selfLink": "A String", # The link to this access-control entry. 1318 }, 1319 ], 1320 "retentionPolicy": { # 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. 1321 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 1322 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 1323 "retentionPeriod": "A String", # 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. 1324 }, 1325 "storageClass": "A 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. 1326 "iamConfiguration": { # The bucket's IAM configuration. 1327 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 1328 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 1329 "lockedTime": "A String", # 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. 1330 }, 1331 }, 1332 "selfLink": "A String", # The URI of this bucket. 1333 }</pre> 1334</div> 1335 1336<div class="method"> 1337 <code class="details" id="setIamPolicy">setIamPolicy(bucket, body, userProject=None, provisionalUserProject=None)</code> 1338 <pre>Updates an IAM policy for the specified bucket. 1339 1340Args: 1341 bucket: string, Name of a bucket. (required) 1342 body: object, The request body. (required) 1343 The object takes the form of: 1344 1345{ # A bucket/object IAM policy. 1346 "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. 1347 "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role. 1348 { 1349 "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole. 1350 # The new IAM roles are: 1351 # - roles/storage.admin — Full control of Google Cloud Storage resources. 1352 # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects. 1353 # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage. 1354 # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are: 1355 # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role. 1356 # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role. 1357 # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role. 1358 # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role. 1359 # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role. 1360 "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows: 1361 # - allUsers — A special identifier that represents anyone on the internet; with or without a Google account. 1362 # - allAuthenticatedUsers — A special identifier that represents anyone who is authenticated with a Google account or a service account. 1363 # - user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com. 1364 # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . 1365 # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com. 1366 # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com. 1367 # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project 1368 # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project 1369 # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project 1370 "A String", 1371 ], 1372 "condition": { # Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" # The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1373 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1374 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. 1375 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1376 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1377 }, 1378 }, 1379 ], 1380 "etag": "A String", # HTTP 1.1 Entity tag for the policy. 1381 "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. 1382} 1383 1384 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 1385 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 1386 1387Returns: 1388 An object of the form: 1389 1390 { # A bucket/object IAM policy. 1391 "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. 1392 "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role. 1393 { 1394 "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole. 1395 # The new IAM roles are: 1396 # - roles/storage.admin — Full control of Google Cloud Storage resources. 1397 # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects. 1398 # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage. 1399 # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are: 1400 # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role. 1401 # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role. 1402 # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role. 1403 # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role. 1404 # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role. 1405 "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows: 1406 # - allUsers — A special identifier that represents anyone on the internet; with or without a Google account. 1407 # - allAuthenticatedUsers — A special identifier that represents anyone who is authenticated with a Google account or a service account. 1408 # - user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com. 1409 # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . 1410 # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com. 1411 # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com. 1412 # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project 1413 # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project 1414 # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project 1415 "A String", 1416 ], 1417 "condition": { # Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" # The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1418 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1419 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. 1420 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1421 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1422 }, 1423 }, 1424 ], 1425 "etag": "A String", # HTTP 1.1 Entity tag for the policy. 1426 "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. 1427 }</pre> 1428</div> 1429 1430<div class="method"> 1431 <code class="details" id="testIamPermissions">testIamPermissions(bucket, permissions, userProject=None, provisionalUserProject=None)</code> 1432 <pre>Tests a set of permissions on the given bucket to see which, if any, are held by the caller. 1433 1434Args: 1435 bucket: string, Name of a bucket. (required) 1436 permissions: string, Permissions to test. (required) (repeated) 1437 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 1438 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 1439 1440Returns: 1441 An object of the form: 1442 1443 { # A storage.(buckets|objects).testIamPermissions response. 1444 "kind": "storage#testIamPermissionsResponse", # The kind of item this is. 1445 "permissions": [ # The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows: 1446 # - storage.buckets.delete — Delete bucket. 1447 # - storage.buckets.get — Read bucket metadata. 1448 # - storage.buckets.getIamPolicy — Read bucket IAM policy. 1449 # - storage.buckets.create — Create bucket. 1450 # - storage.buckets.list — List buckets. 1451 # - storage.buckets.setIamPolicy — Update bucket IAM policy. 1452 # - storage.buckets.update — Update bucket metadata. 1453 # - storage.objects.delete — Delete object. 1454 # - storage.objects.get — Read object data and metadata. 1455 # - storage.objects.getIamPolicy — Read object IAM policy. 1456 # - storage.objects.create — Create object. 1457 # - storage.objects.list — List objects. 1458 # - storage.objects.setIamPolicy — Update object IAM policy. 1459 # - storage.objects.update — Update object metadata. 1460 "A String", 1461 ], 1462 }</pre> 1463</div> 1464 1465<div class="method"> 1466 <code class="details" id="update">update(bucket, body, projection=None, ifMetagenerationMatch=None, userProject=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, provisionalUserProject=None, ifMetagenerationNotMatch=None)</code> 1467 <pre>Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. 1468 1469Args: 1470 bucket: string, Name of a bucket. (required) 1471 body: object, The request body. (required) 1472 The object takes the form of: 1473 1474{ # A bucket. 1475 "labels": { # User-provided labels, in key/value pairs. 1476 "a_key": "A String", # An individual label entry. 1477 }, 1478 "versioning": { # The bucket's versioning configuration. 1479 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 1480 }, 1481 "owner": { # The owner of the bucket. This is always the project team's owner group. 1482 "entityId": "A String", # The ID for the entity. 1483 "entity": "A String", # The entity, in the form project-owner-projectId. 1484 }, 1485 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 1486 "defaultEventBasedHold": True or False, # 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. 1487 "billing": { # The bucket's billing configuration. 1488 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 1489 }, 1490 "encryption": { # Encryption configuration for a bucket. 1491 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 1492 }, 1493 "projectNumber": "A String", # The project number of the project the bucket belongs to. 1494 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 1495 "location": "A 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. 1496 "website": { # 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. 1497 "notFoundPage": "A 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. 1498 "mainPageSuffix": "A 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. 1499 }, 1500 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 1501 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 1502 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 1503 { # An access-control entry. 1504 "domain": "A String", # The domain associated with the entity, if any. 1505 "generation": "A String", # The content generation of the object, if applied to an object. 1506 "object": "A String", # The name of the object, if applied to an object. 1507 "bucket": "A String", # The name of the bucket. 1508 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1509 "entity": "A String", # The entity holding the permission, in one of the following forms: 1510 # - user-userId 1511 # - user-email 1512 # - group-groupId 1513 # - group-email 1514 # - domain-domain 1515 # - project-team-projectId 1516 # - allUsers 1517 # - allAuthenticatedUsers Examples: 1518 # - The user liz@example.com would be user-liz@example.com. 1519 # - The group example@googlegroups.com would be group-example@googlegroups.com. 1520 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1521 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1522 "role": "A String", # The access permission for the entity. 1523 "id": "A String", # The ID of the access-control entry. 1524 "entityId": "A String", # The ID for the entity, if any. 1525 "projectTeam": { # The project team associated with the entity, if any. 1526 "projectNumber": "A String", # The project number. 1527 "team": "A String", # The team. 1528 }, 1529 "email": "A String", # The email address associated with the entity, if any. 1530 "selfLink": "A String", # The link to this access-control entry. 1531 }, 1532 ], 1533 "metageneration": "A String", # The metadata generation of this bucket. 1534 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 1535 { 1536 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 1537 "A String", 1538 ], 1539 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 1540 "A String", 1541 ], 1542 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 1543 "A String", 1544 ], 1545 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 1546 }, 1547 ], 1548 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 1549 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 1550 { 1551 "action": { # The action to take. 1552 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 1553 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 1554 }, 1555 "condition": { # The condition(s) under which the action will be taken. 1556 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 1557 "A String", 1558 ], 1559 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 1560 "numNewerVersions": 42, # 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. 1561 "createdBefore": "A String", # 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. 1562 "matchesPattern": "A 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. 1563 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 1564 }, 1565 }, 1566 ], 1567 }, 1568 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 1569 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 1570 "logObjectPrefix": "A String", # A prefix for log object names. 1571 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 1572 }, 1573 "name": "A String", # The name of the bucket. 1574 "locationType": "A String", # The type of the bucket location. 1575 "acl": [ # Access controls on the bucket. 1576 { # An access-control entry. 1577 "domain": "A String", # The domain associated with the entity, if any. 1578 "bucket": "A String", # The name of the bucket. 1579 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 1580 "entity": "A String", # The entity holding the permission, in one of the following forms: 1581 # - user-userId 1582 # - user-email 1583 # - group-groupId 1584 # - group-email 1585 # - domain-domain 1586 # - project-team-projectId 1587 # - allUsers 1588 # - allAuthenticatedUsers Examples: 1589 # - The user liz@example.com would be user-liz@example.com. 1590 # - The group example@googlegroups.com would be group-example@googlegroups.com. 1591 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1592 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1593 "role": "A String", # The access permission for the entity. 1594 "id": "A String", # The ID of the access-control entry. 1595 "entityId": "A String", # The ID for the entity, if any. 1596 "projectTeam": { # The project team associated with the entity, if any. 1597 "projectNumber": "A String", # The project number. 1598 "team": "A String", # The team. 1599 }, 1600 "email": "A String", # The email address associated with the entity, if any. 1601 "selfLink": "A String", # The link to this access-control entry. 1602 }, 1603 ], 1604 "retentionPolicy": { # 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. 1605 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 1606 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 1607 "retentionPeriod": "A String", # 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. 1608 }, 1609 "storageClass": "A 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. 1610 "iamConfiguration": { # The bucket's IAM configuration. 1611 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 1612 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 1613 "lockedTime": "A String", # 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. 1614 }, 1615 }, 1616 "selfLink": "A String", # The URI of this bucket. 1617 } 1618 1619 projection: string, Set of properties to return. Defaults to full. 1620 Allowed values 1621 full - Include all properties. 1622 noAcl - Omit owner, acl and defaultObjectAcl properties. 1623 ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. 1624 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 1625 predefinedDefaultObjectAcl: string, Apply a predefined set of default object access controls to this bucket. 1626 Allowed values 1627 authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access. 1628 bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access. 1629 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access. 1630 private - Object owner gets OWNER access. 1631 projectPrivate - Object owner gets OWNER access, and project team members get access according to their roles. 1632 publicRead - Object owner gets OWNER access, and allUsers get READER access. 1633 predefinedAcl: string, Apply a predefined set of access controls to this bucket. 1634 Allowed values 1635 authenticatedRead - Project team owners get OWNER access, and allAuthenticatedUsers get READER access. 1636 private - Project team owners get OWNER access. 1637 projectPrivate - Project team members get access according to their roles. 1638 publicRead - Project team owners get OWNER access, and allUsers get READER access. 1639 publicReadWrite - Project team owners get OWNER access, and allUsers get WRITER access. 1640 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 1641 ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. 1642 1643Returns: 1644 An object of the form: 1645 1646 { # A bucket. 1647 "labels": { # User-provided labels, in key/value pairs. 1648 "a_key": "A String", # An individual label entry. 1649 }, 1650 "versioning": { # The bucket's versioning configuration. 1651 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 1652 }, 1653 "owner": { # The owner of the bucket. This is always the project team's owner group. 1654 "entityId": "A String", # The ID for the entity. 1655 "entity": "A String", # The entity, in the form project-owner-projectId. 1656 }, 1657 "id": "A String", # The ID of the bucket. For buckets, the id and name properties are the same. 1658 "defaultEventBasedHold": True or False, # 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. 1659 "billing": { # The bucket's billing configuration. 1660 "requesterPays": True or False, # When set to true, Requester Pays is enabled for this bucket. 1661 }, 1662 "encryption": { # Encryption configuration for a bucket. 1663 "defaultKmsKeyName": "A String", # A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. 1664 }, 1665 "projectNumber": "A String", # The project number of the project the bucket belongs to. 1666 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 1667 "location": "A 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. 1668 "website": { # 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. 1669 "notFoundPage": "A 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. 1670 "mainPageSuffix": "A 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. 1671 }, 1672 "updated": "A String", # The modification time of the bucket in RFC 3339 format. 1673 "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. 1674 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 1675 { # An access-control entry. 1676 "domain": "A String", # The domain associated with the entity, if any. 1677 "generation": "A String", # The content generation of the object, if applied to an object. 1678 "object": "A String", # The name of the object, if applied to an object. 1679 "bucket": "A String", # The name of the bucket. 1680 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1681 "entity": "A String", # The entity holding the permission, in one of the following forms: 1682 # - user-userId 1683 # - user-email 1684 # - group-groupId 1685 # - group-email 1686 # - domain-domain 1687 # - project-team-projectId 1688 # - allUsers 1689 # - allAuthenticatedUsers Examples: 1690 # - The user liz@example.com would be user-liz@example.com. 1691 # - The group example@googlegroups.com would be group-example@googlegroups.com. 1692 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1693 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1694 "role": "A String", # The access permission for the entity. 1695 "id": "A String", # The ID of the access-control entry. 1696 "entityId": "A String", # The ID for the entity, if any. 1697 "projectTeam": { # The project team associated with the entity, if any. 1698 "projectNumber": "A String", # The project number. 1699 "team": "A String", # The team. 1700 }, 1701 "email": "A String", # The email address associated with the entity, if any. 1702 "selfLink": "A String", # The link to this access-control entry. 1703 }, 1704 ], 1705 "metageneration": "A String", # The metadata generation of this bucket. 1706 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 1707 { 1708 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 1709 "A String", 1710 ], 1711 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 1712 "A String", 1713 ], 1714 "method": [ # The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method". 1715 "A String", 1716 ], 1717 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 1718 }, 1719 ], 1720 "lifecycle": { # The bucket's lifecycle configuration. See lifecycle management for more information. 1721 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 1722 { 1723 "action": { # The action to take. 1724 "type": "A String", # Type of the action. Currently, only Delete and SetStorageClass are supported. 1725 "storageClass": "A String", # Target storage class. Required iff the type of the action is SetStorageClass. 1726 }, 1727 "condition": { # The condition(s) under which the action will be taken. 1728 "matchesStorageClass": [ # Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, STANDARD, and DURABLE_REDUCED_AVAILABILITY. 1729 "A String", 1730 ], 1731 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 1732 "numNewerVersions": 42, # 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. 1733 "createdBefore": "A String", # 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. 1734 "matchesPattern": "A 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. 1735 "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects. 1736 }, 1737 }, 1738 ], 1739 }, 1740 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 1741 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 1742 "logObjectPrefix": "A String", # A prefix for log object names. 1743 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 1744 }, 1745 "name": "A String", # The name of the bucket. 1746 "locationType": "A String", # The type of the bucket location. 1747 "acl": [ # Access controls on the bucket. 1748 { # An access-control entry. 1749 "domain": "A String", # The domain associated with the entity, if any. 1750 "bucket": "A String", # The name of the bucket. 1751 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 1752 "entity": "A String", # The entity holding the permission, in one of the following forms: 1753 # - user-userId 1754 # - user-email 1755 # - group-groupId 1756 # - group-email 1757 # - domain-domain 1758 # - project-team-projectId 1759 # - allUsers 1760 # - allAuthenticatedUsers Examples: 1761 # - The user liz@example.com would be user-liz@example.com. 1762 # - The group example@googlegroups.com would be group-example@googlegroups.com. 1763 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1764 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1765 "role": "A String", # The access permission for the entity. 1766 "id": "A String", # The ID of the access-control entry. 1767 "entityId": "A String", # The ID for the entity, if any. 1768 "projectTeam": { # The project team associated with the entity, if any. 1769 "projectNumber": "A String", # The project number. 1770 "team": "A String", # The team. 1771 }, 1772 "email": "A String", # The email address associated with the entity, if any. 1773 "selfLink": "A String", # The link to this access-control entry. 1774 }, 1775 ], 1776 "retentionPolicy": { # 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. 1777 "effectiveTime": "A String", # Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. 1778 "isLocked": True or False, # Once locked, an object retention policy cannot be modified. 1779 "retentionPeriod": "A String", # 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. 1780 }, 1781 "storageClass": "A 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. 1782 "iamConfiguration": { # The bucket's IAM configuration. 1783 "bucketPolicyOnly": { # The bucket's Bucket Policy Only configuration. 1784 "enabled": True or False, # If set, access checks only use bucket-level IAM policies or above. 1785 "lockedTime": "A String", # 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. 1786 }, 1787 }, 1788 "selfLink": "A String", # The URI of this bucket. 1789 }</pre> 1790</div> 1791 1792</body></html>