1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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_v1beta2.html">Cloud Storage JSON API</a> . <a href="storage_v1beta2.buckets.html">buckets</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(bucket, ifMetagenerationMatch=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, 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="#insert">insert(project, body, projection=None)</a></code></p> 85 <p class="firstline">Creates a new bucket.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(project, projection=None, pageToken=None, maxResults=None)</a></code></p> 88 <p class="firstline">Retrieves a list of buckets for a given project.</p> 89 <p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91 <p class="firstline">Retrieves the next page of results.</p> 92 <p class="toc_element"> 93 <code><a href="#patch">patch(bucket, body, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p> 94 <p class="firstline">Updates a bucket. This method supports patch semantics.</p> 95 <p class="toc_element"> 96 <code><a href="#update">update(bucket, body, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p> 97 <p class="firstline">Updates a bucket.</p> 98 <h3>Method Details</h3> 99 <div class="method"> 100 <code class="details" id="delete">delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code> 101 <pre>Permanently deletes an empty bucket. 102 103 Args: 104 bucket: string, Name of a bucket. (required) 105 ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. 106 ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. 107 </pre> 108 </div> 109 110 <div class="method"> 111 <code class="details" id="get">get(bucket, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code> 112 <pre>Returns metadata for the specified bucket. 113 114 Args: 115 bucket: string, Name of a bucket. (required) 116 projection: string, Set of properties to return. Defaults to noAcl. 117 Allowed values 118 full - Include all properties. 119 noAcl - Omit acl and defaultObjectAcl properties. 120 ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. 121 ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. 122 123 Returns: 124 An object of the form: 125 126 { # A bucket. 127 "website": { # The bucket's website configuration. 128 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 129 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 130 }, 131 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 132 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 133 "logObjectPrefix": "A String", # A prefix for log object names. 134 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 135 }, 136 "name": "A String", # The name of the bucket. 137 "metageneration": "A String", # The metadata generation of this bucket. 138 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 139 "versioning": { # The bucket's versioning configuration. 140 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 141 }, 142 "acl": [ # Access controls on the bucket. 143 { # An access-control entry. 144 "domain": "A String", # The domain associated with the entity, if any. 145 "bucket": "A String", # The name of the bucket. 146 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 147 "entity": "A String", # The entity holding the permission, in one of the following forms: 148 # - user-userId 149 # - user-email 150 # - group-groupId 151 # - group-email 152 # - domain-domain 153 # - allUsers 154 # - allAuthenticatedUsers Examples: 155 # - The user liz (a] example.com would be user-liz (a] example.com. 156 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 157 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 158 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 159 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 160 "id": "A String", # The ID of the access-control entry. 161 "entityId": "A String", # The ID for the entity, if any. 162 "email": "A String", # The email address associated with the entity, if any. 163 "selfLink": "A String", # The link to this access-control entry. 164 }, 165 ], 166 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 167 { # An access-control entry. 168 "domain": "A String", # The domain associated with the entity, if any. 169 "generation": "A String", # The content generation of the object. 170 "object": "A String", # The name of the object. 171 "bucket": "A String", # The name of the bucket. 172 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 173 "entity": "A String", # The entity holding the permission, in one of the following forms: 174 # - user-userId 175 # - user-email 176 # - group-groupId 177 # - group-email 178 # - domain-domain 179 # - allUsers 180 # - allAuthenticatedUsers Examples: 181 # - The user liz (a] example.com would be user-liz (a] example.com. 182 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 183 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 184 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 185 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 186 "id": "A String", # The ID of the access-control entry. 187 "entityId": "A String", # The ID for the entity, if any. 188 "email": "A String", # The email address associated with the entity, if any. 189 "selfLink": "A String", # The link to this access-control entry. 190 }, 191 ], 192 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 193 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. 194 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 195 { 196 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 197 "A String", 198 ], 199 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 200 "A String", 201 ], 202 "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". 203 "A String", 204 ], 205 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 206 }, 207 ], 208 "owner": { # The owner of the bucket. This is always the project team's owner group. 209 "entityId": "A String", # The ID for the entity. 210 "entity": "A String", # The entity, in the form group-groupId. 211 }, 212 "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information. 213 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 214 { 215 "action": { # The action to take. 216 "type": "A String", # Type of the action. Currently only Delete is supported. 217 }, 218 "condition": { # The condition(s) under which the action will be taken. 219 "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. 220 "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. 221 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 222 "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC. 223 }, 224 }, 225 ], 226 }, 227 "id": "A String", # The ID of the bucket. 228 "selfLink": "A String", # The URI of this bucket. 229 "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. 230 }</pre> 231 </div> 232 233 <div class="method"> 234 <code class="details" id="insert">insert(project, body, projection=None)</code> 235 <pre>Creates a new bucket. 236 237 Args: 238 project: string, A valid API project identifier. (required) 239 body: object, The request body. (required) 240 The object takes the form of: 241 242 { # A bucket. 243 "website": { # The bucket's website configuration. 244 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 245 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 246 }, 247 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 248 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 249 "logObjectPrefix": "A String", # A prefix for log object names. 250 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 251 }, 252 "name": "A String", # The name of the bucket. 253 "metageneration": "A String", # The metadata generation of this bucket. 254 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 255 "versioning": { # The bucket's versioning configuration. 256 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 257 }, 258 "acl": [ # Access controls on the bucket. 259 { # An access-control entry. 260 "domain": "A String", # The domain associated with the entity, if any. 261 "bucket": "A String", # The name of the bucket. 262 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 263 "entity": "A String", # The entity holding the permission, in one of the following forms: 264 # - user-userId 265 # - user-email 266 # - group-groupId 267 # - group-email 268 # - domain-domain 269 # - allUsers 270 # - allAuthenticatedUsers Examples: 271 # - The user liz (a] example.com would be user-liz (a] example.com. 272 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 273 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 274 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 275 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 276 "id": "A String", # The ID of the access-control entry. 277 "entityId": "A String", # The ID for the entity, if any. 278 "email": "A String", # The email address associated with the entity, if any. 279 "selfLink": "A String", # The link to this access-control entry. 280 }, 281 ], 282 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 283 { # An access-control entry. 284 "domain": "A String", # The domain associated with the entity, if any. 285 "generation": "A String", # The content generation of the object. 286 "object": "A String", # The name of the object. 287 "bucket": "A String", # The name of the bucket. 288 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 289 "entity": "A String", # The entity holding the permission, in one of the following forms: 290 # - user-userId 291 # - user-email 292 # - group-groupId 293 # - group-email 294 # - domain-domain 295 # - allUsers 296 # - allAuthenticatedUsers Examples: 297 # - The user liz (a] example.com would be user-liz (a] example.com. 298 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 299 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 300 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 301 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 302 "id": "A String", # The ID of the access-control entry. 303 "entityId": "A String", # The ID for the entity, if any. 304 "email": "A String", # The email address associated with the entity, if any. 305 "selfLink": "A String", # The link to this access-control entry. 306 }, 307 ], 308 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 309 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. 310 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 311 { 312 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 313 "A String", 314 ], 315 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 316 "A String", 317 ], 318 "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". 319 "A String", 320 ], 321 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 322 }, 323 ], 324 "owner": { # The owner of the bucket. This is always the project team's owner group. 325 "entityId": "A String", # The ID for the entity. 326 "entity": "A String", # The entity, in the form group-groupId. 327 }, 328 "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information. 329 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 330 { 331 "action": { # The action to take. 332 "type": "A String", # Type of the action. Currently only Delete is supported. 333 }, 334 "condition": { # The condition(s) under which the action will be taken. 335 "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. 336 "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. 337 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 338 "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC. 339 }, 340 }, 341 ], 342 }, 343 "id": "A String", # The ID of the bucket. 344 "selfLink": "A String", # The URI of this bucket. 345 "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. 346 } 347 348 projection: string, Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. 349 Allowed values 350 full - Include all properties. 351 noAcl - Omit acl and defaultObjectAcl properties. 352 353 Returns: 354 An object of the form: 355 356 { # A bucket. 357 "website": { # The bucket's website configuration. 358 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 359 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 360 }, 361 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 362 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 363 "logObjectPrefix": "A String", # A prefix for log object names. 364 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 365 }, 366 "name": "A String", # The name of the bucket. 367 "metageneration": "A String", # The metadata generation of this bucket. 368 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 369 "versioning": { # The bucket's versioning configuration. 370 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 371 }, 372 "acl": [ # Access controls on the bucket. 373 { # An access-control entry. 374 "domain": "A String", # The domain associated with the entity, if any. 375 "bucket": "A String", # The name of the bucket. 376 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 377 "entity": "A String", # The entity holding the permission, in one of the following forms: 378 # - user-userId 379 # - user-email 380 # - group-groupId 381 # - group-email 382 # - domain-domain 383 # - allUsers 384 # - allAuthenticatedUsers Examples: 385 # - The user liz (a] example.com would be user-liz (a] example.com. 386 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 387 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 388 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 389 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 390 "id": "A String", # The ID of the access-control entry. 391 "entityId": "A String", # The ID for the entity, if any. 392 "email": "A String", # The email address associated with the entity, if any. 393 "selfLink": "A String", # The link to this access-control entry. 394 }, 395 ], 396 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 397 { # An access-control entry. 398 "domain": "A String", # The domain associated with the entity, if any. 399 "generation": "A String", # The content generation of the object. 400 "object": "A String", # The name of the object. 401 "bucket": "A String", # The name of the bucket. 402 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 403 "entity": "A String", # The entity holding the permission, in one of the following forms: 404 # - user-userId 405 # - user-email 406 # - group-groupId 407 # - group-email 408 # - domain-domain 409 # - allUsers 410 # - allAuthenticatedUsers Examples: 411 # - The user liz (a] example.com would be user-liz (a] example.com. 412 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 413 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 414 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 415 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 416 "id": "A String", # The ID of the access-control entry. 417 "entityId": "A String", # The ID for the entity, if any. 418 "email": "A String", # The email address associated with the entity, if any. 419 "selfLink": "A String", # The link to this access-control entry. 420 }, 421 ], 422 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 423 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. 424 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 425 { 426 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 427 "A String", 428 ], 429 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 430 "A String", 431 ], 432 "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". 433 "A String", 434 ], 435 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 436 }, 437 ], 438 "owner": { # The owner of the bucket. This is always the project team's owner group. 439 "entityId": "A String", # The ID for the entity. 440 "entity": "A String", # The entity, in the form group-groupId. 441 }, 442 "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information. 443 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 444 { 445 "action": { # The action to take. 446 "type": "A String", # Type of the action. Currently only Delete is supported. 447 }, 448 "condition": { # The condition(s) under which the action will be taken. 449 "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. 450 "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. 451 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 452 "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC. 453 }, 454 }, 455 ], 456 }, 457 "id": "A String", # The ID of the bucket. 458 "selfLink": "A String", # The URI of this bucket. 459 "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. 460 }</pre> 461 </div> 462 463 <div class="method"> 464 <code class="details" id="list">list(project, projection=None, pageToken=None, maxResults=None)</code> 465 <pre>Retrieves a list of buckets for a given project. 466 467 Args: 468 project: string, A valid API project identifier. (required) 469 projection: string, Set of properties to return. Defaults to noAcl. 470 Allowed values 471 full - Include all properties. 472 noAcl - Omit acl and defaultObjectAcl properties. 473 pageToken: string, A previously-returned page token representing part of the larger set of results to view. 474 maxResults: integer, Maximum number of buckets to return. 475 476 Returns: 477 An object of the form: 478 479 { # A list of buckets. 480 "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. 481 "items": [ # The list of items. 482 { # A bucket. 483 "website": { # The bucket's website configuration. 484 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 485 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 486 }, 487 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 488 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 489 "logObjectPrefix": "A String", # A prefix for log object names. 490 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 491 }, 492 "name": "A String", # The name of the bucket. 493 "metageneration": "A String", # The metadata generation of this bucket. 494 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 495 "versioning": { # The bucket's versioning configuration. 496 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 497 }, 498 "acl": [ # Access controls on the bucket. 499 { # An access-control entry. 500 "domain": "A String", # The domain associated with the entity, if any. 501 "bucket": "A String", # The name of the bucket. 502 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 503 "entity": "A String", # The entity holding the permission, in one of the following forms: 504 # - user-userId 505 # - user-email 506 # - group-groupId 507 # - group-email 508 # - domain-domain 509 # - allUsers 510 # - allAuthenticatedUsers Examples: 511 # - The user liz (a] example.com would be user-liz (a] example.com. 512 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 513 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 514 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 515 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 516 "id": "A String", # The ID of the access-control entry. 517 "entityId": "A String", # The ID for the entity, if any. 518 "email": "A String", # The email address associated with the entity, if any. 519 "selfLink": "A String", # The link to this access-control entry. 520 }, 521 ], 522 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 523 { # An access-control entry. 524 "domain": "A String", # The domain associated with the entity, if any. 525 "generation": "A String", # The content generation of the object. 526 "object": "A String", # The name of the object. 527 "bucket": "A String", # The name of the bucket. 528 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 529 "entity": "A String", # The entity holding the permission, in one of the following forms: 530 # - user-userId 531 # - user-email 532 # - group-groupId 533 # - group-email 534 # - domain-domain 535 # - allUsers 536 # - allAuthenticatedUsers Examples: 537 # - The user liz (a] example.com would be user-liz (a] example.com. 538 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 539 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 540 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 541 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 542 "id": "A String", # The ID of the access-control entry. 543 "entityId": "A String", # The ID for the entity, if any. 544 "email": "A String", # The email address associated with the entity, if any. 545 "selfLink": "A String", # The link to this access-control entry. 546 }, 547 ], 548 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 549 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. 550 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 551 { 552 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 553 "A String", 554 ], 555 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 556 "A String", 557 ], 558 "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". 559 "A String", 560 ], 561 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 562 }, 563 ], 564 "owner": { # The owner of the bucket. This is always the project team's owner group. 565 "entityId": "A String", # The ID for the entity. 566 "entity": "A String", # The entity, in the form group-groupId. 567 }, 568 "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information. 569 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 570 { 571 "action": { # The action to take. 572 "type": "A String", # Type of the action. Currently only Delete is supported. 573 }, 574 "condition": { # The condition(s) under which the action will be taken. 575 "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. 576 "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. 577 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 578 "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC. 579 }, 580 }, 581 ], 582 }, 583 "id": "A String", # The ID of the bucket. 584 "selfLink": "A String", # The URI of this bucket. 585 "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. 586 }, 587 ], 588 "kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets. 589 }</pre> 590 </div> 591 592 <div class="method"> 593 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 594 <pre>Retrieves the next page of results. 595 596 Args: 597 previous_request: The request for the previous page. (required) 598 previous_response: The response from the request for the previous page. (required) 599 600 Returns: 601 A request object that you can call 'execute()' on to request the next 602 page. Returns None if there are no more items in the collection. 603 </pre> 604 </div> 605 606 <div class="method"> 607 <code class="details" id="patch">patch(bucket, body, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code> 608 <pre>Updates a bucket. This method supports patch semantics. 609 610 Args: 611 bucket: string, Name of a bucket. (required) 612 body: object, The request body. (required) 613 The object takes the form of: 614 615 { # A bucket. 616 "website": { # The bucket's website configuration. 617 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 618 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 619 }, 620 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 621 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 622 "logObjectPrefix": "A String", # A prefix for log object names. 623 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 624 }, 625 "name": "A String", # The name of the bucket. 626 "metageneration": "A String", # The metadata generation of this bucket. 627 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 628 "versioning": { # The bucket's versioning configuration. 629 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 630 }, 631 "acl": [ # Access controls on the bucket. 632 { # An access-control entry. 633 "domain": "A String", # The domain associated with the entity, if any. 634 "bucket": "A String", # The name of the bucket. 635 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 636 "entity": "A String", # The entity holding the permission, in one of the following forms: 637 # - user-userId 638 # - user-email 639 # - group-groupId 640 # - group-email 641 # - domain-domain 642 # - allUsers 643 # - allAuthenticatedUsers Examples: 644 # - The user liz (a] example.com would be user-liz (a] example.com. 645 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 646 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 647 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 648 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 649 "id": "A String", # The ID of the access-control entry. 650 "entityId": "A String", # The ID for the entity, if any. 651 "email": "A String", # The email address associated with the entity, if any. 652 "selfLink": "A String", # The link to this access-control entry. 653 }, 654 ], 655 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 656 { # An access-control entry. 657 "domain": "A String", # The domain associated with the entity, if any. 658 "generation": "A String", # The content generation of the object. 659 "object": "A String", # The name of the object. 660 "bucket": "A String", # The name of the bucket. 661 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 662 "entity": "A String", # The entity holding the permission, in one of the following forms: 663 # - user-userId 664 # - user-email 665 # - group-groupId 666 # - group-email 667 # - domain-domain 668 # - allUsers 669 # - allAuthenticatedUsers Examples: 670 # - The user liz (a] example.com would be user-liz (a] example.com. 671 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 672 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 673 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 674 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 675 "id": "A String", # The ID of the access-control entry. 676 "entityId": "A String", # The ID for the entity, if any. 677 "email": "A String", # The email address associated with the entity, if any. 678 "selfLink": "A String", # The link to this access-control entry. 679 }, 680 ], 681 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 682 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. 683 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 684 { 685 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 686 "A String", 687 ], 688 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 689 "A String", 690 ], 691 "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". 692 "A String", 693 ], 694 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 695 }, 696 ], 697 "owner": { # The owner of the bucket. This is always the project team's owner group. 698 "entityId": "A String", # The ID for the entity. 699 "entity": "A String", # The entity, in the form group-groupId. 700 }, 701 "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information. 702 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 703 { 704 "action": { # The action to take. 705 "type": "A String", # Type of the action. Currently only Delete is supported. 706 }, 707 "condition": { # The condition(s) under which the action will be taken. 708 "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. 709 "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. 710 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 711 "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC. 712 }, 713 }, 714 ], 715 }, 716 "id": "A String", # The ID of the bucket. 717 "selfLink": "A String", # The URI of this bucket. 718 "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. 719 } 720 721 projection: string, Set of properties to return. Defaults to full. 722 Allowed values 723 full - Include all properties. 724 noAcl - Omit acl and defaultObjectAcl properties. 725 ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. 726 ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. 727 728 Returns: 729 An object of the form: 730 731 { # A bucket. 732 "website": { # The bucket's website configuration. 733 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 734 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 735 }, 736 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 737 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 738 "logObjectPrefix": "A String", # A prefix for log object names. 739 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 740 }, 741 "name": "A String", # The name of the bucket. 742 "metageneration": "A String", # The metadata generation of this bucket. 743 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 744 "versioning": { # The bucket's versioning configuration. 745 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 746 }, 747 "acl": [ # Access controls on the bucket. 748 { # An access-control entry. 749 "domain": "A String", # The domain associated with the entity, if any. 750 "bucket": "A String", # The name of the bucket. 751 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 752 "entity": "A String", # The entity holding the permission, in one of the following forms: 753 # - user-userId 754 # - user-email 755 # - group-groupId 756 # - group-email 757 # - domain-domain 758 # - allUsers 759 # - allAuthenticatedUsers Examples: 760 # - The user liz (a] example.com would be user-liz (a] example.com. 761 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 762 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 763 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 764 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 765 "id": "A String", # The ID of the access-control entry. 766 "entityId": "A String", # The ID for the entity, if any. 767 "email": "A String", # The email address associated with the entity, if any. 768 "selfLink": "A String", # The link to this access-control entry. 769 }, 770 ], 771 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 772 { # An access-control entry. 773 "domain": "A String", # The domain associated with the entity, if any. 774 "generation": "A String", # The content generation of the object. 775 "object": "A String", # The name of the object. 776 "bucket": "A String", # The name of the bucket. 777 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 778 "entity": "A String", # The entity holding the permission, in one of the following forms: 779 # - user-userId 780 # - user-email 781 # - group-groupId 782 # - group-email 783 # - domain-domain 784 # - allUsers 785 # - allAuthenticatedUsers Examples: 786 # - The user liz (a] example.com would be user-liz (a] example.com. 787 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 788 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 789 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 790 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 791 "id": "A String", # The ID of the access-control entry. 792 "entityId": "A String", # The ID for the entity, if any. 793 "email": "A String", # The email address associated with the entity, if any. 794 "selfLink": "A String", # The link to this access-control entry. 795 }, 796 ], 797 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 798 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. 799 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 800 { 801 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 802 "A String", 803 ], 804 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 805 "A String", 806 ], 807 "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". 808 "A String", 809 ], 810 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 811 }, 812 ], 813 "owner": { # The owner of the bucket. This is always the project team's owner group. 814 "entityId": "A String", # The ID for the entity. 815 "entity": "A String", # The entity, in the form group-groupId. 816 }, 817 "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information. 818 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 819 { 820 "action": { # The action to take. 821 "type": "A String", # Type of the action. Currently only Delete is supported. 822 }, 823 "condition": { # The condition(s) under which the action will be taken. 824 "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. 825 "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. 826 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 827 "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC. 828 }, 829 }, 830 ], 831 }, 832 "id": "A String", # The ID of the bucket. 833 "selfLink": "A String", # The URI of this bucket. 834 "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. 835 }</pre> 836 </div> 837 838 <div class="method"> 839 <code class="details" id="update">update(bucket, body, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code> 840 <pre>Updates a bucket. 841 842 Args: 843 bucket: string, Name of a bucket. (required) 844 body: object, The request body. (required) 845 The object takes the form of: 846 847 { # A bucket. 848 "website": { # The bucket's website configuration. 849 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 850 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 851 }, 852 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 853 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 854 "logObjectPrefix": "A String", # A prefix for log object names. 855 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 856 }, 857 "name": "A String", # The name of the bucket. 858 "metageneration": "A String", # The metadata generation of this bucket. 859 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 860 "versioning": { # The bucket's versioning configuration. 861 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 862 }, 863 "acl": [ # Access controls on the bucket. 864 { # An access-control entry. 865 "domain": "A String", # The domain associated with the entity, if any. 866 "bucket": "A String", # The name of the bucket. 867 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 868 "entity": "A String", # The entity holding the permission, in one of the following forms: 869 # - user-userId 870 # - user-email 871 # - group-groupId 872 # - group-email 873 # - domain-domain 874 # - allUsers 875 # - allAuthenticatedUsers Examples: 876 # - The user liz (a] example.com would be user-liz (a] example.com. 877 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 878 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 879 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 880 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 881 "id": "A String", # The ID of the access-control entry. 882 "entityId": "A String", # The ID for the entity, if any. 883 "email": "A String", # The email address associated with the entity, if any. 884 "selfLink": "A String", # The link to this access-control entry. 885 }, 886 ], 887 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 888 { # An access-control entry. 889 "domain": "A String", # The domain associated with the entity, if any. 890 "generation": "A String", # The content generation of the object. 891 "object": "A String", # The name of the object. 892 "bucket": "A String", # The name of the bucket. 893 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 894 "entity": "A String", # The entity holding the permission, in one of the following forms: 895 # - user-userId 896 # - user-email 897 # - group-groupId 898 # - group-email 899 # - domain-domain 900 # - allUsers 901 # - allAuthenticatedUsers Examples: 902 # - The user liz (a] example.com would be user-liz (a] example.com. 903 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 904 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 905 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 906 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 907 "id": "A String", # The ID of the access-control entry. 908 "entityId": "A String", # The ID for the entity, if any. 909 "email": "A String", # The email address associated with the entity, if any. 910 "selfLink": "A String", # The link to this access-control entry. 911 }, 912 ], 913 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 914 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. 915 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 916 { 917 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 918 "A String", 919 ], 920 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 921 "A String", 922 ], 923 "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". 924 "A String", 925 ], 926 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 927 }, 928 ], 929 "owner": { # The owner of the bucket. This is always the project team's owner group. 930 "entityId": "A String", # The ID for the entity. 931 "entity": "A String", # The entity, in the form group-groupId. 932 }, 933 "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information. 934 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 935 { 936 "action": { # The action to take. 937 "type": "A String", # Type of the action. Currently only Delete is supported. 938 }, 939 "condition": { # The condition(s) under which the action will be taken. 940 "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. 941 "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. 942 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 943 "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC. 944 }, 945 }, 946 ], 947 }, 948 "id": "A String", # The ID of the bucket. 949 "selfLink": "A String", # The URI of this bucket. 950 "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. 951 } 952 953 projection: string, Set of properties to return. Defaults to full. 954 Allowed values 955 full - Include all properties. 956 noAcl - Omit acl and defaultObjectAcl properties. 957 ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. 958 ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. 959 960 Returns: 961 An object of the form: 962 963 { # A bucket. 964 "website": { # The bucket's website configuration. 965 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 966 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 967 }, 968 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 969 "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. 970 "logObjectPrefix": "A String", # A prefix for log object names. 971 "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed. 972 }, 973 "name": "A String", # The name of the bucket. 974 "metageneration": "A String", # The metadata generation of this bucket. 975 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 976 "versioning": { # The bucket's versioning configuration. 977 "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. 978 }, 979 "acl": [ # Access controls on the bucket. 980 { # An access-control entry. 981 "domain": "A String", # The domain associated with the entity, if any. 982 "bucket": "A String", # The name of the bucket. 983 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 984 "entity": "A String", # The entity holding the permission, in one of the following forms: 985 # - user-userId 986 # - user-email 987 # - group-groupId 988 # - group-email 989 # - domain-domain 990 # - allUsers 991 # - allAuthenticatedUsers Examples: 992 # - The user liz (a] example.com would be user-liz (a] example.com. 993 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 994 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 995 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 996 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 997 "id": "A String", # The ID of the access-control entry. 998 "entityId": "A String", # The ID for the entity, if any. 999 "email": "A String", # The email address associated with the entity, if any. 1000 "selfLink": "A String", # The link to this access-control entry. 1001 }, 1002 ], 1003 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 1004 { # An access-control entry. 1005 "domain": "A String", # The domain associated with the entity, if any. 1006 "generation": "A String", # The content generation of the object. 1007 "object": "A String", # The name of the object. 1008 "bucket": "A String", # The name of the bucket. 1009 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1010 "entity": "A String", # The entity holding the permission, in one of the following forms: 1011 # - user-userId 1012 # - user-email 1013 # - group-groupId 1014 # - group-email 1015 # - domain-domain 1016 # - allUsers 1017 # - allAuthenticatedUsers Examples: 1018 # - The user liz (a] example.com would be user-liz (a] example.com. 1019 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 1020 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1021 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1022 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 1023 "id": "A String", # The ID of the access-control entry. 1024 "entityId": "A String", # The ID for the entity, if any. 1025 "email": "A String", # The email address associated with the entity, if any. 1026 "selfLink": "A String", # The link to this access-control entry. 1027 }, 1028 ], 1029 "etag": "A String", # HTTP 1.1 Entity tag for the bucket. 1030 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list. 1031 "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration. 1032 { 1033 "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". 1034 "A String", 1035 ], 1036 "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 1037 "A String", 1038 ], 1039 "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". 1040 "A String", 1041 ], 1042 "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. 1043 }, 1044 ], 1045 "owner": { # The owner of the bucket. This is always the project team's owner group. 1046 "entityId": "A String", # The ID for the entity. 1047 "entity": "A String", # The entity, in the form group-groupId. 1048 }, 1049 "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information. 1050 "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. 1051 { 1052 "action": { # The action to take. 1053 "type": "A String", # Type of the action. Currently only Delete is supported. 1054 }, 1055 "condition": { # The condition(s) under which the action will be taken. 1056 "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. 1057 "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. 1058 "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age. 1059 "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC. 1060 }, 1061 }, 1062 ], 1063 }, 1064 "id": "A String", # The ID of the bucket. 1065 "selfLink": "A String", # The URI of this bucket. 1066 "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list. 1067 }</pre> 1068 </div> 1069 1070 </body></html>
