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_v1beta1.html">Cloud Storage JSON API</a> . <a href="storage_v1beta1.buckets.html">buckets</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(bucket)</a></code></p> 79 <p class="firstline">Deletes an empty bucket.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(bucket, projection=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(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(projectId, projection=None, pageToken=None, max_results=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)</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)</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)</code> 101 <pre>Deletes an empty bucket. 102 103 Args: 104 bucket: string, Name of a bucket. (required) 105 </pre> 106 </div> 107 108 <div class="method"> 109 <code class="details" id="get">get(bucket, projection=None)</code> 110 <pre>Returns metadata for the specified bucket. 111 112 Args: 113 bucket: string, Name of a bucket. (required) 114 projection: string, Set of properties to return. Defaults to no_acl. 115 Allowed values 116 full - Include all properties. 117 no_acl - Omit acl and defaultObjectAcl properties. 118 119 Returns: 120 An object of the form: 121 122 { # A bucket. 123 "website": { # The bucket's website configuration. 124 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 125 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 126 }, 127 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 128 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 129 "projectId": "A String", # The project the bucket belongs to. 130 "acl": [ # Access controls on the bucket. 131 { # An access-control entry. 132 "domain": "A String", # The domain associated with the entity, if any. 133 "bucket": "A String", # The name of the bucket. 134 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 135 "id": "A String", # The ID of the access-control entry. 136 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 137 "entityId": "A String", # The ID for the entity, if any. 138 "entity": "A String", # The entity holding the permission, in one of the following forms: 139 # - user-userId 140 # - user-email 141 # - group-groupId 142 # - group-email 143 # - domain-domain 144 # - allUsers 145 # - allAuthenticatedUsers Examples: 146 # - The user liz (a] example.com would be user-liz (a] example.com. 147 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 148 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 149 "email": "A String", # The email address associated with the entity, if any. 150 "selfLink": "A String", # The link to this access-control entry. 151 }, 152 ], 153 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 154 { # An access-control entry. 155 "domain": "A String", # The domain associated with the entity, if any. 156 "object": "A String", # The name of the object. 157 "bucket": "A String", # The name of the bucket. 158 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 159 "id": "A String", # The ID of the access-control entry. 160 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 161 "entityId": "A String", # The ID for the entity, if any. 162 "entity": "A String", # The entity holding the permission, in one of the following forms: 163 # - user-userId 164 # - user-email 165 # - group-groupId 166 # - group-email 167 # - domain-domain 168 # - allUsers 169 # - allAuthenticatedUsers Examples: 170 # - The user liz (a] example.com would be user-liz (a] example.com. 171 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 172 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 173 "email": "A String", # The email address associated with the entity, if any. 174 "selfLink": "A String", # The link to this access-control entry. 175 }, 176 ], 177 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. 178 "owner": { # The owner of the bucket. This will always be the project team's owner group. 179 "entityId": "A String", # The ID for the entity. 180 "entity": "A String", # The entity, in the form group-groupId. 181 }, 182 "id": "A String", # The name of the bucket. 183 "selfLink": "A String", # The URI of this bucket. 184 }</pre> 185 </div> 186 187 <div class="method"> 188 <code class="details" id="insert">insert(body, projection=None)</code> 189 <pre>Creates a new bucket. 190 191 Args: 192 body: object, The request body. (required) 193 The object takes the form of: 194 195 { # A bucket. 196 "website": { # The bucket's website configuration. 197 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 198 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 199 }, 200 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 201 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 202 "projectId": "A String", # The project the bucket belongs to. 203 "acl": [ # Access controls on the bucket. 204 { # An access-control entry. 205 "domain": "A String", # The domain associated with the entity, if any. 206 "bucket": "A String", # The name of the bucket. 207 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 208 "id": "A String", # The ID of the access-control entry. 209 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 210 "entityId": "A String", # The ID for the entity, if any. 211 "entity": "A String", # The entity holding the permission, in one of the following forms: 212 # - user-userId 213 # - user-email 214 # - group-groupId 215 # - group-email 216 # - domain-domain 217 # - allUsers 218 # - allAuthenticatedUsers Examples: 219 # - The user liz (a] example.com would be user-liz (a] example.com. 220 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 221 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 222 "email": "A String", # The email address associated with the entity, if any. 223 "selfLink": "A String", # The link to this access-control entry. 224 }, 225 ], 226 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 227 { # An access-control entry. 228 "domain": "A String", # The domain associated with the entity, if any. 229 "object": "A String", # The name of the object. 230 "bucket": "A String", # The name of the bucket. 231 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 232 "id": "A String", # The ID of the access-control entry. 233 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 234 "entityId": "A String", # The ID for the entity, if any. 235 "entity": "A String", # The entity holding the permission, in one of the following forms: 236 # - user-userId 237 # - user-email 238 # - group-groupId 239 # - group-email 240 # - domain-domain 241 # - allUsers 242 # - allAuthenticatedUsers Examples: 243 # - The user liz (a] example.com would be user-liz (a] example.com. 244 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 245 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 246 "email": "A String", # The email address associated with the entity, if any. 247 "selfLink": "A String", # The link to this access-control entry. 248 }, 249 ], 250 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. 251 "owner": { # The owner of the bucket. This will always be the project team's owner group. 252 "entityId": "A String", # The ID for the entity. 253 "entity": "A String", # The entity, in the form group-groupId. 254 }, 255 "id": "A String", # The name of the bucket. 256 "selfLink": "A String", # The URI of this bucket. 257 } 258 259 projection: string, Set of properties to return. Defaults to no_acl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. 260 Allowed values 261 full - Include all properties. 262 no_acl - Omit acl and defaultObjectAcl properties. 263 264 Returns: 265 An object of the form: 266 267 { # A bucket. 268 "website": { # The bucket's website configuration. 269 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 270 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 271 }, 272 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 273 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 274 "projectId": "A String", # The project the bucket belongs to. 275 "acl": [ # Access controls on the bucket. 276 { # An access-control entry. 277 "domain": "A String", # The domain associated with the entity, if any. 278 "bucket": "A String", # The name of the bucket. 279 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 280 "id": "A String", # The ID of the access-control entry. 281 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 282 "entityId": "A String", # The ID for the entity, if any. 283 "entity": "A String", # The entity holding the permission, in one of the following forms: 284 # - user-userId 285 # - user-email 286 # - group-groupId 287 # - group-email 288 # - domain-domain 289 # - allUsers 290 # - allAuthenticatedUsers Examples: 291 # - The user liz (a] example.com would be user-liz (a] example.com. 292 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 293 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 294 "email": "A String", # The email address associated with the entity, if any. 295 "selfLink": "A String", # The link to this access-control entry. 296 }, 297 ], 298 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 299 { # An access-control entry. 300 "domain": "A String", # The domain associated with the entity, if any. 301 "object": "A String", # The name of the object. 302 "bucket": "A String", # The name of the bucket. 303 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 304 "id": "A String", # The ID of the access-control entry. 305 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 306 "entityId": "A String", # The ID for the entity, if any. 307 "entity": "A String", # The entity holding the permission, in one of the following forms: 308 # - user-userId 309 # - user-email 310 # - group-groupId 311 # - group-email 312 # - domain-domain 313 # - allUsers 314 # - allAuthenticatedUsers Examples: 315 # - The user liz (a] example.com would be user-liz (a] example.com. 316 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 317 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 318 "email": "A String", # The email address associated with the entity, if any. 319 "selfLink": "A String", # The link to this access-control entry. 320 }, 321 ], 322 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. 323 "owner": { # The owner of the bucket. This will always be the project team's owner group. 324 "entityId": "A String", # The ID for the entity. 325 "entity": "A String", # The entity, in the form group-groupId. 326 }, 327 "id": "A String", # The name of the bucket. 328 "selfLink": "A String", # The URI of this bucket. 329 }</pre> 330 </div> 331 332 <div class="method"> 333 <code class="details" id="list">list(projectId, projection=None, pageToken=None, max_results=None)</code> 334 <pre>Retrieves a list of buckets for a given project. 335 336 Args: 337 projectId: string, A valid API project identifier. (required) 338 projection: string, Set of properties to return. Defaults to no_acl. 339 Allowed values 340 full - Include all properties. 341 no_acl - Omit acl and defaultObjectAcl properties. 342 pageToken: string, A previously-returned page token representing part of the larger set of results to view. 343 max_results: integer, Maximum number of buckets to return. 344 345 Returns: 346 An object of the form: 347 348 { # A list of buckets. 349 "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. 350 "items": [ # The list of items. 351 { # A bucket. 352 "website": { # The bucket's website configuration. 353 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 354 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 355 }, 356 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 357 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 358 "projectId": "A String", # The project the bucket belongs to. 359 "acl": [ # Access controls on the bucket. 360 { # An access-control entry. 361 "domain": "A String", # The domain associated with the entity, if any. 362 "bucket": "A String", # The name of the bucket. 363 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 364 "id": "A String", # The ID of the access-control entry. 365 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 366 "entityId": "A String", # The ID for the entity, if any. 367 "entity": "A String", # The entity holding the permission, in one of the following forms: 368 # - user-userId 369 # - user-email 370 # - group-groupId 371 # - group-email 372 # - domain-domain 373 # - allUsers 374 # - allAuthenticatedUsers Examples: 375 # - The user liz (a] example.com would be user-liz (a] example.com. 376 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 377 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 378 "email": "A String", # The email address associated with the entity, if any. 379 "selfLink": "A String", # The link to this access-control entry. 380 }, 381 ], 382 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 383 { # An access-control entry. 384 "domain": "A String", # The domain associated with the entity, if any. 385 "object": "A String", # The name of the object. 386 "bucket": "A String", # The name of the bucket. 387 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 388 "id": "A String", # The ID of the access-control entry. 389 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 390 "entityId": "A String", # The ID for the entity, if any. 391 "entity": "A String", # The entity holding the permission, in one of the following forms: 392 # - user-userId 393 # - user-email 394 # - group-groupId 395 # - group-email 396 # - domain-domain 397 # - allUsers 398 # - allAuthenticatedUsers Examples: 399 # - The user liz (a] example.com would be user-liz (a] example.com. 400 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 401 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 402 "email": "A String", # The email address associated with the entity, if any. 403 "selfLink": "A String", # The link to this access-control entry. 404 }, 405 ], 406 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. 407 "owner": { # The owner of the bucket. This will always be the project team's owner group. 408 "entityId": "A String", # The ID for the entity. 409 "entity": "A String", # The entity, in the form group-groupId. 410 }, 411 "id": "A String", # The name of the bucket. 412 "selfLink": "A String", # The URI of this bucket. 413 }, 414 ], 415 "kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets. 416 }</pre> 417 </div> 418 419 <div class="method"> 420 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 421 <pre>Retrieves the next page of results. 422 423 Args: 424 previous_request: The request for the previous page. (required) 425 previous_response: The response from the request for the previous page. (required) 426 427 Returns: 428 A request object that you can call 'execute()' on to request the next 429 page. Returns None if there are no more items in the collection. 430 </pre> 431 </div> 432 433 <div class="method"> 434 <code class="details" id="patch">patch(bucket, body, projection=None)</code> 435 <pre>Updates a bucket. This method supports patch semantics. 436 437 Args: 438 bucket: string, Name of a bucket. (required) 439 body: object, The request body. (required) 440 The object takes the form of: 441 442 { # A bucket. 443 "website": { # The bucket's website configuration. 444 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 445 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 446 }, 447 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 448 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 449 "projectId": "A String", # The project the bucket belongs to. 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 "id": "A String", # The ID of the access-control entry. 456 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 457 "entityId": "A String", # The ID for the entity, if any. 458 "entity": "A String", # The entity holding the permission, in one of the following forms: 459 # - user-userId 460 # - user-email 461 # - group-groupId 462 # - group-email 463 # - domain-domain 464 # - allUsers 465 # - allAuthenticatedUsers Examples: 466 # - The user liz (a] example.com would be user-liz (a] example.com. 467 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 468 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 469 "email": "A String", # The email address associated with the entity, if any. 470 "selfLink": "A String", # The link to this access-control entry. 471 }, 472 ], 473 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 474 { # An access-control entry. 475 "domain": "A String", # The domain associated with the entity, if any. 476 "object": "A String", # The name of the object. 477 "bucket": "A String", # The name of the bucket. 478 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 479 "id": "A String", # The ID of the access-control entry. 480 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 481 "entityId": "A String", # The ID for the entity, if any. 482 "entity": "A String", # The entity holding the permission, in one of the following forms: 483 # - user-userId 484 # - user-email 485 # - group-groupId 486 # - group-email 487 # - domain-domain 488 # - allUsers 489 # - allAuthenticatedUsers Examples: 490 # - The user liz (a] example.com would be user-liz (a] example.com. 491 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 492 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 493 "email": "A String", # The email address associated with the entity, if any. 494 "selfLink": "A String", # The link to this access-control entry. 495 }, 496 ], 497 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. 498 "owner": { # The owner of the bucket. This will always be the project team's owner group. 499 "entityId": "A String", # The ID for the entity. 500 "entity": "A String", # The entity, in the form group-groupId. 501 }, 502 "id": "A String", # The name of the bucket. 503 "selfLink": "A String", # The URI of this bucket. 504 } 505 506 projection: string, Set of properties to return. Defaults to full. 507 Allowed values 508 full - Include all properties. 509 no_acl - Omit acl and defaultObjectAcl properties. 510 511 Returns: 512 An object of the form: 513 514 { # A bucket. 515 "website": { # The bucket's website configuration. 516 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 517 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 518 }, 519 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 520 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 521 "projectId": "A String", # The project the bucket belongs to. 522 "acl": [ # Access controls on the bucket. 523 { # An access-control entry. 524 "domain": "A String", # The domain associated with the entity, if any. 525 "bucket": "A String", # The name of the bucket. 526 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 527 "id": "A String", # The ID of the access-control entry. 528 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 529 "entityId": "A String", # The ID for the entity, if any. 530 "entity": "A String", # The entity holding the permission, in one of the following forms: 531 # - user-userId 532 # - user-email 533 # - group-groupId 534 # - group-email 535 # - domain-domain 536 # - allUsers 537 # - allAuthenticatedUsers Examples: 538 # - The user liz (a] example.com would be user-liz (a] example.com. 539 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 540 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 541 "email": "A String", # The email address associated with the entity, if any. 542 "selfLink": "A String", # The link to this access-control entry. 543 }, 544 ], 545 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 546 { # An access-control entry. 547 "domain": "A String", # The domain associated with the entity, if any. 548 "object": "A String", # The name of the object. 549 "bucket": "A String", # The name of the bucket. 550 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 551 "id": "A String", # The ID of the access-control entry. 552 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 553 "entityId": "A String", # The ID for the entity, if any. 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 # - allUsers 561 # - allAuthenticatedUsers Examples: 562 # - The user liz (a] example.com would be user-liz (a] example.com. 563 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 564 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 565 "email": "A String", # The email address associated with the entity, if any. 566 "selfLink": "A String", # The link to this access-control entry. 567 }, 568 ], 569 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. 570 "owner": { # The owner of the bucket. This will always be the project team's owner group. 571 "entityId": "A String", # The ID for the entity. 572 "entity": "A String", # The entity, in the form group-groupId. 573 }, 574 "id": "A String", # The name of the bucket. 575 "selfLink": "A String", # The URI of this bucket. 576 }</pre> 577 </div> 578 579 <div class="method"> 580 <code class="details" id="update">update(bucket, body, projection=None)</code> 581 <pre>Updates a bucket. 582 583 Args: 584 bucket: string, Name of a bucket. (required) 585 body: object, The request body. (required) 586 The object takes the form of: 587 588 { # A bucket. 589 "website": { # The bucket's website configuration. 590 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 591 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 592 }, 593 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 594 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 595 "projectId": "A String", # The project the bucket belongs to. 596 "acl": [ # Access controls on the bucket. 597 { # An access-control entry. 598 "domain": "A String", # The domain associated with the entity, if any. 599 "bucket": "A String", # The name of the bucket. 600 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 601 "id": "A String", # The ID of the access-control entry. 602 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 603 "entityId": "A String", # The ID for the entity, if any. 604 "entity": "A String", # The entity holding the permission, in one of the following forms: 605 # - user-userId 606 # - user-email 607 # - group-groupId 608 # - group-email 609 # - domain-domain 610 # - allUsers 611 # - allAuthenticatedUsers Examples: 612 # - The user liz (a] example.com would be user-liz (a] example.com. 613 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 614 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 615 "email": "A String", # The email address associated with the entity, if any. 616 "selfLink": "A String", # The link to this access-control entry. 617 }, 618 ], 619 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 620 { # An access-control entry. 621 "domain": "A String", # The domain associated with the entity, if any. 622 "object": "A String", # The name of the object. 623 "bucket": "A String", # The name of the bucket. 624 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 625 "id": "A String", # The ID of the access-control entry. 626 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 627 "entityId": "A String", # The ID for the entity, if any. 628 "entity": "A String", # The entity holding the permission, in one of the following forms: 629 # - user-userId 630 # - user-email 631 # - group-groupId 632 # - group-email 633 # - domain-domain 634 # - allUsers 635 # - allAuthenticatedUsers Examples: 636 # - The user liz (a] example.com would be user-liz (a] example.com. 637 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 638 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 639 "email": "A String", # The email address associated with the entity, if any. 640 "selfLink": "A String", # The link to this access-control entry. 641 }, 642 ], 643 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. 644 "owner": { # The owner of the bucket. This will always be the project team's owner group. 645 "entityId": "A String", # The ID for the entity. 646 "entity": "A String", # The entity, in the form group-groupId. 647 }, 648 "id": "A String", # The name of the bucket. 649 "selfLink": "A String", # The URI of this bucket. 650 } 651 652 projection: string, Set of properties to return. Defaults to full. 653 Allowed values 654 full - Include all properties. 655 no_acl - Omit acl and defaultObjectAcl properties. 656 657 Returns: 658 An object of the form: 659 660 { # A bucket. 661 "website": { # The bucket's website configuration. 662 "notFoundPage": "A String", # The custom object to return when a requested resource is not found. 663 "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories. 664 }, 665 "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket. 666 "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. 667 "projectId": "A String", # The project the bucket belongs to. 668 "acl": [ # Access controls on the bucket. 669 { # An access-control entry. 670 "domain": "A String", # The domain associated with the entity, if any. 671 "bucket": "A String", # The name of the bucket. 672 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 673 "id": "A String", # The ID of the access-control entry. 674 "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER. 675 "entityId": "A String", # The ID for the entity, if any. 676 "entity": "A String", # The entity holding the permission, in one of the following forms: 677 # - user-userId 678 # - user-email 679 # - group-groupId 680 # - group-email 681 # - domain-domain 682 # - allUsers 683 # - allAuthenticatedUsers Examples: 684 # - The user liz (a] example.com would be user-liz (a] example.com. 685 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 686 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 687 "email": "A String", # The email address associated with the entity, if any. 688 "selfLink": "A String", # The link to this access-control entry. 689 }, 690 ], 691 "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided. 692 { # An access-control entry. 693 "domain": "A String", # The domain associated with the entity, if any. 694 "object": "A String", # The name of the object. 695 "bucket": "A String", # The name of the bucket. 696 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 697 "id": "A String", # The ID of the access-control entry. 698 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 699 "entityId": "A String", # The ID for the entity, if any. 700 "entity": "A String", # The entity holding the permission, in one of the following forms: 701 # - user-userId 702 # - user-email 703 # - group-groupId 704 # - group-email 705 # - domain-domain 706 # - allUsers 707 # - allAuthenticatedUsers Examples: 708 # - The user liz (a] example.com would be user-liz (a] example.com. 709 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 710 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 711 "email": "A String", # The email address associated with the entity, if any. 712 "selfLink": "A String", # The link to this access-control entry. 713 }, 714 ], 715 "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US. 716 "owner": { # The owner of the bucket. This will always be the project team's owner group. 717 "entityId": "A String", # The ID for the entity. 718 "entity": "A String", # The entity, in the form group-groupId. 719 }, 720 "id": "A String", # The name of the bucket. 721 "selfLink": "A String", # The URI of this bucket. 722 }</pre> 723 </div> 724 725 </body></html>
