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.objects.html">objects</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(bucket, object)</a></code></p> 79 <p class="firstline">Deletes data blobs and associated metadata.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(bucket, object, projection=None)</a></code></p> 82 <p class="firstline">Retrieves objects or their associated metadata.</p> 83 <p class="toc_element"> 84 <code><a href="#get_media">get_media(bucket, object, projection=None)</a></code></p> 85 <p class="firstline">Retrieves objects or their associated metadata.</p> 86 <p class="toc_element"> 87 <code><a href="#insert">insert(bucket, body=None, media_body=None, name=None, media_mime_type=None, projection=None)</a></code></p> 88 <p class="firstline">Stores new data blobs and associated metadata.</p> 89 <p class="toc_element"> 90 <code><a href="#insert_media">insert_media(bucket, body=None, media_body=None, name=None, media_mime_type=None, projection=None)</a></code></p> 91 <p class="firstline">Stores new data blobs and associated metadata.</p> 92 <p class="toc_element"> 93 <code><a href="#list">list(bucket, projection=None, pageToken=None, delimiter=None, prefix=None, max_results=None)</a></code></p> 94 <p class="firstline">Retrieves a list of objects matching the criteria.</p> 95 <p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97 <p class="firstline">Retrieves the next page of results.</p> 98 <p class="toc_element"> 99 <code><a href="#patch">patch(bucket, object, body, projection=None)</a></code></p> 100 <p class="firstline">Updates a data blob's associated metadata. This method supports patch semantics.</p> 101 <p class="toc_element"> 102 <code><a href="#update">update(bucket, object, body, projection=None)</a></code></p> 103 <p class="firstline">Updates a data blob's associated metadata.</p> 104 <p class="toc_element"> 105 <code><a href="#update_media">update_media(bucket, object, body, projection=None)</a></code></p> 106 <p class="firstline">Updates a data blob's associated metadata.</p> 107 <h3>Method Details</h3> 108 <div class="method"> 109 <code class="details" id="delete">delete(bucket, object)</code> 110 <pre>Deletes data blobs and associated metadata. 111 112 Args: 113 bucket: string, Name of the bucket in which the object resides. (required) 114 object: string, Name of the object. (required) 115 </pre> 116 </div> 117 118 <div class="method"> 119 <code class="details" id="get">get(bucket, object, projection=None)</code> 120 <pre>Retrieves objects or their associated metadata. 121 122 Args: 123 bucket: string, Name of the bucket in which the object resides. (required) 124 object: string, Name of the object. (required) 125 projection: string, Set of properties to return. Defaults to no_acl. 126 Allowed values 127 full - Include all properties. 128 no_acl - Omit the acl property. 129 130 Returns: 131 An object of the form: 132 133 { # An object. 134 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 135 "name": "A String", # The name of this object. Required if not specified by URL parameter. 136 "contentLanguage": "A String", # Content-Language of the object data. 137 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 138 "contentType": "A String", # Content-Type of the object data. 139 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 140 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 141 "length": "A String", # Content-Length of the data in bytes. 142 "link": "A String", # Media download link. 143 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 144 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 145 }, 146 "bucket": "A String", # The bucket containing this object. 147 "contentEncoding": "A String", # Content-Encoding of the object data. 148 "selfLink": "A String", # The link to this object. 149 "owner": { # The owner of the object. This will always be the uploader of the object. 150 "entityId": "A String", # The ID for the entity. 151 "entity": "A String", # The entity, in the form user-userId. 152 }, 153 "cacheControl": "A String", # Cache-Control directive for the object data. 154 "acl": [ # Access controls on the object. 155 { # An access-control entry. 156 "domain": "A String", # The domain associated with the entity, if any. 157 "object": "A String", # The name of the object. 158 "bucket": "A String", # The name of the bucket. 159 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 160 "id": "A String", # The ID of the access-control entry. 161 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 162 "entityId": "A String", # The ID for the entity, if any. 163 "entity": "A String", # The entity holding the permission, in one of the following forms: 164 # - user-userId 165 # - user-email 166 # - group-groupId 167 # - group-email 168 # - domain-domain 169 # - allUsers 170 # - allAuthenticatedUsers Examples: 171 # - The user liz (a] example.com would be user-liz (a] example.com. 172 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 173 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 174 "email": "A String", # The email address associated with the entity, if any. 175 "selfLink": "A String", # The link to this access-control entry. 176 }, 177 ], 178 "id": "A String", # The ID of the object. 179 "contentDisposition": "A String", # Content-Disposition of the object data. 180 "metadata": { # User-provided metadata, in key/value pairs. 181 "a_key": "A String", # An individual metadata entry. 182 }, 183 }</pre> 184 </div> 185 186 <div class="method"> 187 <code class="details" id="get_media">get_media(bucket, object, projection=None)</code> 188 <pre>Retrieves objects or their associated metadata. 189 190 Args: 191 bucket: string, Name of the bucket in which the object resides. (required) 192 object: string, Name of the object. (required) 193 projection: string, Set of properties to return. Defaults to no_acl. 194 Allowed values 195 full - Include all properties. 196 no_acl - Omit the acl property. 197 198 Returns: 199 The media object as a string. 200 201 </pre> 202 </div> 203 204 <div class="method"> 205 <code class="details" id="insert">insert(bucket, body=None, media_body=None, name=None, media_mime_type=None, projection=None)</code> 206 <pre>Stores new data blobs and associated metadata. 207 208 Args: 209 bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required) 210 body: object, The request body. 211 The object takes the form of: 212 213 { # An object. 214 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 215 "name": "A String", # The name of this object. Required if not specified by URL parameter. 216 "contentLanguage": "A String", # Content-Language of the object data. 217 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 218 "contentType": "A String", # Content-Type of the object data. 219 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 220 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 221 "length": "A String", # Content-Length of the data in bytes. 222 "link": "A String", # Media download link. 223 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 224 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 225 }, 226 "bucket": "A String", # The bucket containing this object. 227 "contentEncoding": "A String", # Content-Encoding of the object data. 228 "selfLink": "A String", # The link to this object. 229 "owner": { # The owner of the object. This will always be the uploader of the object. 230 "entityId": "A String", # The ID for the entity. 231 "entity": "A String", # The entity, in the form user-userId. 232 }, 233 "cacheControl": "A String", # Cache-Control directive for the object data. 234 "acl": [ # Access controls on the object. 235 { # An access-control entry. 236 "domain": "A String", # The domain associated with the entity, if any. 237 "object": "A String", # The name of the object. 238 "bucket": "A String", # The name of the bucket. 239 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 240 "id": "A String", # The ID of the access-control entry. 241 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 242 "entityId": "A String", # The ID for the entity, if any. 243 "entity": "A String", # The entity holding the permission, in one of the following forms: 244 # - user-userId 245 # - user-email 246 # - group-groupId 247 # - group-email 248 # - domain-domain 249 # - allUsers 250 # - allAuthenticatedUsers Examples: 251 # - The user liz (a] example.com would be user-liz (a] example.com. 252 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 253 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 254 "email": "A String", # The email address associated with the entity, if any. 255 "selfLink": "A String", # The link to this access-control entry. 256 }, 257 ], 258 "id": "A String", # The ID of the object. 259 "contentDisposition": "A String", # Content-Disposition of the object data. 260 "metadata": { # User-provided metadata, in key/value pairs. 261 "a_key": "A String", # An individual metadata entry. 262 }, 263 } 264 265 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 266 name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. 267 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 268 projection: string, Set of properties to return. Defaults to no_acl, unless the object resource specifies the acl property, when it defaults to full. 269 Allowed values 270 full - Include all properties. 271 no_acl - Omit the acl property. 272 273 Returns: 274 An object of the form: 275 276 { # An object. 277 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 278 "name": "A String", # The name of this object. Required if not specified by URL parameter. 279 "contentLanguage": "A String", # Content-Language of the object data. 280 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 281 "contentType": "A String", # Content-Type of the object data. 282 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 283 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 284 "length": "A String", # Content-Length of the data in bytes. 285 "link": "A String", # Media download link. 286 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 287 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 288 }, 289 "bucket": "A String", # The bucket containing this object. 290 "contentEncoding": "A String", # Content-Encoding of the object data. 291 "selfLink": "A String", # The link to this object. 292 "owner": { # The owner of the object. This will always be the uploader of the object. 293 "entityId": "A String", # The ID for the entity. 294 "entity": "A String", # The entity, in the form user-userId. 295 }, 296 "cacheControl": "A String", # Cache-Control directive for the object data. 297 "acl": [ # Access controls on the object. 298 { # An access-control entry. 299 "domain": "A String", # The domain associated with the entity, if any. 300 "object": "A String", # The name of the object. 301 "bucket": "A String", # The name of the bucket. 302 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 303 "id": "A String", # The ID of the access-control entry. 304 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 305 "entityId": "A String", # The ID for the entity, if any. 306 "entity": "A String", # The entity holding the permission, in one of the following forms: 307 # - user-userId 308 # - user-email 309 # - group-groupId 310 # - group-email 311 # - domain-domain 312 # - allUsers 313 # - allAuthenticatedUsers Examples: 314 # - The user liz (a] example.com would be user-liz (a] example.com. 315 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 316 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 317 "email": "A String", # The email address associated with the entity, if any. 318 "selfLink": "A String", # The link to this access-control entry. 319 }, 320 ], 321 "id": "A String", # The ID of the object. 322 "contentDisposition": "A String", # Content-Disposition of the object data. 323 "metadata": { # User-provided metadata, in key/value pairs. 324 "a_key": "A String", # An individual metadata entry. 325 }, 326 }</pre> 327 </div> 328 329 <div class="method"> 330 <code class="details" id="insert_media">insert_media(bucket, body=None, media_body=None, name=None, media_mime_type=None, projection=None)</code> 331 <pre>Stores new data blobs and associated metadata. 332 333 Args: 334 bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required) 335 body: object, The request body. 336 The object takes the form of: 337 338 { # An object. 339 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 340 "name": "A String", # The name of this object. Required if not specified by URL parameter. 341 "contentLanguage": "A String", # Content-Language of the object data. 342 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 343 "contentType": "A String", # Content-Type of the object data. 344 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 345 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 346 "length": "A String", # Content-Length of the data in bytes. 347 "link": "A String", # Media download link. 348 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 349 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 350 }, 351 "bucket": "A String", # The bucket containing this object. 352 "contentEncoding": "A String", # Content-Encoding of the object data. 353 "selfLink": "A String", # The link to this object. 354 "owner": { # The owner of the object. This will always be the uploader of the object. 355 "entityId": "A String", # The ID for the entity. 356 "entity": "A String", # The entity, in the form user-userId. 357 }, 358 "cacheControl": "A String", # Cache-Control directive for the object data. 359 "acl": [ # Access controls on the object. 360 { # An access-control entry. 361 "domain": "A String", # The domain associated with the entity, if any. 362 "object": "A String", # The name of the object. 363 "bucket": "A String", # The name of the bucket. 364 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 365 "id": "A String", # The ID of the access-control entry. 366 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 367 "entityId": "A String", # The ID for the entity, if any. 368 "entity": "A String", # The entity holding the permission, in one of the following forms: 369 # - user-userId 370 # - user-email 371 # - group-groupId 372 # - group-email 373 # - domain-domain 374 # - allUsers 375 # - allAuthenticatedUsers Examples: 376 # - The user liz (a] example.com would be user-liz (a] example.com. 377 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 378 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 379 "email": "A String", # The email address associated with the entity, if any. 380 "selfLink": "A String", # The link to this access-control entry. 381 }, 382 ], 383 "id": "A String", # The ID of the object. 384 "contentDisposition": "A String", # Content-Disposition of the object data. 385 "metadata": { # User-provided metadata, in key/value pairs. 386 "a_key": "A String", # An individual metadata entry. 387 }, 388 } 389 390 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 391 name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. 392 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 393 projection: string, Set of properties to return. Defaults to no_acl, unless the object resource specifies the acl property, when it defaults to full. 394 Allowed values 395 full - Include all properties. 396 no_acl - Omit the acl property. 397 398 Returns: 399 The media object as a string. 400 401 </pre> 402 </div> 403 404 <div class="method"> 405 <code class="details" id="list">list(bucket, projection=None, pageToken=None, delimiter=None, prefix=None, max_results=None)</code> 406 <pre>Retrieves a list of objects matching the criteria. 407 408 Args: 409 bucket: string, Name of the bucket in which to look for objects. (required) 410 projection: string, Set of properties to return. Defaults to no_acl. 411 Allowed values 412 full - Include all properties. 413 no_acl - Omit the acl property. 414 pageToken: string, A previously-returned page token representing part of the larger set of results to view. 415 delimiter: string, Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted. 416 prefix: string, Filter results to objects whose names begin with this prefix. 417 max_results: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. 418 419 Returns: 420 An object of the form: 421 422 { # A list of objects. 423 "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. 424 "items": [ # The list of items. 425 { # An object. 426 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 427 "name": "A String", # The name of this object. Required if not specified by URL parameter. 428 "contentLanguage": "A String", # Content-Language of the object data. 429 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 430 "contentType": "A String", # Content-Type of the object data. 431 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 432 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 433 "length": "A String", # Content-Length of the data in bytes. 434 "link": "A String", # Media download link. 435 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 436 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 437 }, 438 "bucket": "A String", # The bucket containing this object. 439 "contentEncoding": "A String", # Content-Encoding of the object data. 440 "selfLink": "A String", # The link to this object. 441 "owner": { # The owner of the object. This will always be the uploader of the object. 442 "entityId": "A String", # The ID for the entity. 443 "entity": "A String", # The entity, in the form user-userId. 444 }, 445 "cacheControl": "A String", # Cache-Control directive for the object data. 446 "acl": [ # Access controls on the object. 447 { # An access-control entry. 448 "domain": "A String", # The domain associated with the entity, if any. 449 "object": "A String", # The name of the object. 450 "bucket": "A String", # The name of the bucket. 451 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 452 "id": "A String", # The ID of the access-control entry. 453 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 454 "entityId": "A String", # The ID for the entity, if any. 455 "entity": "A String", # The entity holding the permission, in one of the following forms: 456 # - user-userId 457 # - user-email 458 # - group-groupId 459 # - group-email 460 # - domain-domain 461 # - allUsers 462 # - allAuthenticatedUsers Examples: 463 # - The user liz (a] example.com would be user-liz (a] example.com. 464 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 465 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 466 "email": "A String", # The email address associated with the entity, if any. 467 "selfLink": "A String", # The link to this access-control entry. 468 }, 469 ], 470 "id": "A String", # The ID of the object. 471 "contentDisposition": "A String", # Content-Disposition of the object data. 472 "metadata": { # User-provided metadata, in key/value pairs. 473 "a_key": "A String", # An individual metadata entry. 474 }, 475 }, 476 ], 477 "kind": "storage#objects", # The kind of item this is. For lists of objects, this is always storage#objects. 478 "prefixes": [ # The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter. 479 "A String", 480 ], 481 }</pre> 482 </div> 483 484 <div class="method"> 485 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 486 <pre>Retrieves the next page of results. 487 488 Args: 489 previous_request: The request for the previous page. (required) 490 previous_response: The response from the request for the previous page. (required) 491 492 Returns: 493 A request object that you can call 'execute()' on to request the next 494 page. Returns None if there are no more items in the collection. 495 </pre> 496 </div> 497 498 <div class="method"> 499 <code class="details" id="patch">patch(bucket, object, body, projection=None)</code> 500 <pre>Updates a data blob's associated metadata. This method supports patch semantics. 501 502 Args: 503 bucket: string, Name of the bucket in which the object resides. (required) 504 object: string, Name of the object. (required) 505 body: object, The request body. (required) 506 The object takes the form of: 507 508 { # An object. 509 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 510 "name": "A String", # The name of this object. Required if not specified by URL parameter. 511 "contentLanguage": "A String", # Content-Language of the object data. 512 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 513 "contentType": "A String", # Content-Type of the object data. 514 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 515 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 516 "length": "A String", # Content-Length of the data in bytes. 517 "link": "A String", # Media download link. 518 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 519 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 520 }, 521 "bucket": "A String", # The bucket containing this object. 522 "contentEncoding": "A String", # Content-Encoding of the object data. 523 "selfLink": "A String", # The link to this object. 524 "owner": { # The owner of the object. This will always be the uploader of the object. 525 "entityId": "A String", # The ID for the entity. 526 "entity": "A String", # The entity, in the form user-userId. 527 }, 528 "cacheControl": "A String", # Cache-Control directive for the object data. 529 "acl": [ # Access controls on the object. 530 { # An access-control entry. 531 "domain": "A String", # The domain associated with the entity, if any. 532 "object": "A String", # The name of the object. 533 "bucket": "A String", # The name of the bucket. 534 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 535 "id": "A String", # The ID of the access-control entry. 536 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 537 "entityId": "A String", # The ID for the entity, if any. 538 "entity": "A String", # The entity holding the permission, in one of the following forms: 539 # - user-userId 540 # - user-email 541 # - group-groupId 542 # - group-email 543 # - domain-domain 544 # - allUsers 545 # - allAuthenticatedUsers Examples: 546 # - The user liz (a] example.com would be user-liz (a] example.com. 547 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 548 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 549 "email": "A String", # The email address associated with the entity, if any. 550 "selfLink": "A String", # The link to this access-control entry. 551 }, 552 ], 553 "id": "A String", # The ID of the object. 554 "contentDisposition": "A String", # Content-Disposition of the object data. 555 "metadata": { # User-provided metadata, in key/value pairs. 556 "a_key": "A String", # An individual metadata entry. 557 }, 558 } 559 560 projection: string, Set of properties to return. Defaults to full. 561 Allowed values 562 full - Include all properties. 563 no_acl - Omit the acl property. 564 565 Returns: 566 An object of the form: 567 568 { # An object. 569 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 570 "name": "A String", # The name of this object. Required if not specified by URL parameter. 571 "contentLanguage": "A String", # Content-Language of the object data. 572 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 573 "contentType": "A String", # Content-Type of the object data. 574 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 575 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 576 "length": "A String", # Content-Length of the data in bytes. 577 "link": "A String", # Media download link. 578 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 579 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 580 }, 581 "bucket": "A String", # The bucket containing this object. 582 "contentEncoding": "A String", # Content-Encoding of the object data. 583 "selfLink": "A String", # The link to this object. 584 "owner": { # The owner of the object. This will always be the uploader of the object. 585 "entityId": "A String", # The ID for the entity. 586 "entity": "A String", # The entity, in the form user-userId. 587 }, 588 "cacheControl": "A String", # Cache-Control directive for the object data. 589 "acl": [ # Access controls on the object. 590 { # An access-control entry. 591 "domain": "A String", # The domain associated with the entity, if any. 592 "object": "A String", # The name of the object. 593 "bucket": "A String", # The name of the bucket. 594 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 595 "id": "A String", # The ID of the access-control entry. 596 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 597 "entityId": "A String", # The ID for the entity, if any. 598 "entity": "A String", # The entity holding the permission, in one of the following forms: 599 # - user-userId 600 # - user-email 601 # - group-groupId 602 # - group-email 603 # - domain-domain 604 # - allUsers 605 # - allAuthenticatedUsers Examples: 606 # - The user liz (a] example.com would be user-liz (a] example.com. 607 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 608 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 609 "email": "A String", # The email address associated with the entity, if any. 610 "selfLink": "A String", # The link to this access-control entry. 611 }, 612 ], 613 "id": "A String", # The ID of the object. 614 "contentDisposition": "A String", # Content-Disposition of the object data. 615 "metadata": { # User-provided metadata, in key/value pairs. 616 "a_key": "A String", # An individual metadata entry. 617 }, 618 }</pre> 619 </div> 620 621 <div class="method"> 622 <code class="details" id="update">update(bucket, object, body, projection=None)</code> 623 <pre>Updates a data blob's associated metadata. 624 625 Args: 626 bucket: string, Name of the bucket in which the object resides. (required) 627 object: string, Name of the object. (required) 628 body: object, The request body. (required) 629 The object takes the form of: 630 631 { # An object. 632 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 633 "name": "A String", # The name of this object. Required if not specified by URL parameter. 634 "contentLanguage": "A String", # Content-Language of the object data. 635 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 636 "contentType": "A String", # Content-Type of the object data. 637 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 638 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 639 "length": "A String", # Content-Length of the data in bytes. 640 "link": "A String", # Media download link. 641 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 642 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 643 }, 644 "bucket": "A String", # The bucket containing this object. 645 "contentEncoding": "A String", # Content-Encoding of the object data. 646 "selfLink": "A String", # The link to this object. 647 "owner": { # The owner of the object. This will always be the uploader of the object. 648 "entityId": "A String", # The ID for the entity. 649 "entity": "A String", # The entity, in the form user-userId. 650 }, 651 "cacheControl": "A String", # Cache-Control directive for the object data. 652 "acl": [ # Access controls on the object. 653 { # An access-control entry. 654 "domain": "A String", # The domain associated with the entity, if any. 655 "object": "A String", # The name of the object. 656 "bucket": "A String", # The name of the bucket. 657 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 658 "id": "A String", # The ID of the access-control entry. 659 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 660 "entityId": "A String", # The ID for the entity, if any. 661 "entity": "A String", # The entity holding the permission, in one of the following forms: 662 # - user-userId 663 # - user-email 664 # - group-groupId 665 # - group-email 666 # - domain-domain 667 # - allUsers 668 # - allAuthenticatedUsers Examples: 669 # - The user liz (a] example.com would be user-liz (a] example.com. 670 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 671 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 672 "email": "A String", # The email address associated with the entity, if any. 673 "selfLink": "A String", # The link to this access-control entry. 674 }, 675 ], 676 "id": "A String", # The ID of the object. 677 "contentDisposition": "A String", # Content-Disposition of the object data. 678 "metadata": { # User-provided metadata, in key/value pairs. 679 "a_key": "A String", # An individual metadata entry. 680 }, 681 } 682 683 projection: string, Set of properties to return. Defaults to full. 684 Allowed values 685 full - Include all properties. 686 no_acl - Omit the acl property. 687 688 Returns: 689 An object of the form: 690 691 { # An object. 692 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 693 "name": "A String", # The name of this object. Required if not specified by URL parameter. 694 "contentLanguage": "A String", # Content-Language of the object data. 695 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 696 "contentType": "A String", # Content-Type of the object data. 697 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 698 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 699 "length": "A String", # Content-Length of the data in bytes. 700 "link": "A String", # Media download link. 701 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 702 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 703 }, 704 "bucket": "A String", # The bucket containing this object. 705 "contentEncoding": "A String", # Content-Encoding of the object data. 706 "selfLink": "A String", # The link to this object. 707 "owner": { # The owner of the object. This will always be the uploader of the object. 708 "entityId": "A String", # The ID for the entity. 709 "entity": "A String", # The entity, in the form user-userId. 710 }, 711 "cacheControl": "A String", # Cache-Control directive for the object data. 712 "acl": [ # Access controls on the object. 713 { # An access-control entry. 714 "domain": "A String", # The domain associated with the entity, if any. 715 "object": "A String", # The name of the object. 716 "bucket": "A String", # The name of the bucket. 717 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 718 "id": "A String", # The ID of the access-control entry. 719 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 720 "entityId": "A String", # The ID for the entity, if any. 721 "entity": "A String", # The entity holding the permission, in one of the following forms: 722 # - user-userId 723 # - user-email 724 # - group-groupId 725 # - group-email 726 # - domain-domain 727 # - allUsers 728 # - allAuthenticatedUsers Examples: 729 # - The user liz (a] example.com would be user-liz (a] example.com. 730 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 731 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 732 "email": "A String", # The email address associated with the entity, if any. 733 "selfLink": "A String", # The link to this access-control entry. 734 }, 735 ], 736 "id": "A String", # The ID of the object. 737 "contentDisposition": "A String", # Content-Disposition of the object data. 738 "metadata": { # User-provided metadata, in key/value pairs. 739 "a_key": "A String", # An individual metadata entry. 740 }, 741 }</pre> 742 </div> 743 744 <div class="method"> 745 <code class="details" id="update_media">update_media(bucket, object, body, projection=None)</code> 746 <pre>Updates a data blob's associated metadata. 747 748 Args: 749 bucket: string, Name of the bucket in which the object resides. (required) 750 object: string, Name of the object. (required) 751 body: object, The request body. (required) 752 The object takes the form of: 753 754 { # An object. 755 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 756 "name": "A String", # The name of this object. Required if not specified by URL parameter. 757 "contentLanguage": "A String", # Content-Language of the object data. 758 "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. 759 "contentType": "A String", # Content-Type of the object data. 760 "timeCreated": "A String", # Creation time of the data in RFC 3339 format. 761 "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided. 762 "length": "A String", # Content-Length of the data in bytes. 763 "link": "A String", # Media download link. 764 "hash": "A String", # Hash of the data. Required if a hash algorithm is provided. 765 "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. 766 }, 767 "bucket": "A String", # The bucket containing this object. 768 "contentEncoding": "A String", # Content-Encoding of the object data. 769 "selfLink": "A String", # The link to this object. 770 "owner": { # The owner of the object. This will always be the uploader of the object. 771 "entityId": "A String", # The ID for the entity. 772 "entity": "A String", # The entity, in the form user-userId. 773 }, 774 "cacheControl": "A String", # Cache-Control directive for the object data. 775 "acl": [ # Access controls on the object. 776 { # An access-control entry. 777 "domain": "A String", # The domain associated with the entity, if any. 778 "object": "A String", # The name of the object. 779 "bucket": "A String", # The name of the bucket. 780 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 781 "id": "A String", # The ID of the access-control entry. 782 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 783 "entityId": "A String", # The ID for the entity, if any. 784 "entity": "A String", # The entity holding the permission, in one of the following forms: 785 # - user-userId 786 # - user-email 787 # - group-groupId 788 # - group-email 789 # - domain-domain 790 # - allUsers 791 # - allAuthenticatedUsers Examples: 792 # - The user liz (a] example.com would be user-liz (a] example.com. 793 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 794 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 795 "email": "A String", # The email address associated with the entity, if any. 796 "selfLink": "A String", # The link to this access-control entry. 797 }, 798 ], 799 "id": "A String", # The ID of the object. 800 "contentDisposition": "A String", # Content-Disposition of the object data. 801 "metadata": { # User-provided metadata, in key/value pairs. 802 "a_key": "A String", # An individual metadata entry. 803 }, 804 } 805 806 projection: string, Set of properties to return. Defaults to full. 807 Allowed values 808 full - Include all properties. 809 no_acl - Omit the acl property. 810 811 Returns: 812 The media object as a string. 813 814 </pre> 815 </div> 816 817 </body></html>
