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.objects.html">objects</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#compose">compose(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)</a></code></p> 79 <p class="firstline">Concatenates a list of existing objects into a new object in the same bucket.</p> 80 <p class="toc_element"> 81 <code><a href="#compose_media">compose_media(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)</a></code></p> 82 <p class="firstline">Concatenates a list of existing objects into a new object in the same bucket.</p> 83 <p class="toc_element"> 84 <code><a href="#copy">copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationMatch=None)</a></code></p> 85 <p class="firstline">Copies an object to a destination in the same location. Optionally overrides metadata.</p> 86 <p class="toc_element"> 87 <code><a href="#copy_media">copy_media(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationMatch=None)</a></code></p> 88 <p class="firstline">Copies an object to a destination in the same location. Optionally overrides metadata.</p> 89 <p class="toc_element"> 90 <code><a href="#delete">delete(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p> 91 <p class="firstline">Deletes data blobs and associated metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.</p> 92 <p class="toc_element"> 93 <code><a href="#get">get(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p> 94 <p class="firstline">Retrieves objects or their associated metadata.</p> 95 <p class="toc_element"> 96 <code><a href="#get_media">get_media(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p> 97 <p class="firstline">Retrieves objects or their associated metadata.</p> 98 <p class="toc_element"> 99 <code><a href="#insert">insert(bucket, body=None, media_body=None, projection=None, media_mime_type=None, ifMetagenerationMatch=None, name=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, ifGenerationNotMatch=None)</a></code></p> 100 <p class="firstline">Stores new data blobs and associated metadata.</p> 101 <p class="toc_element"> 102 <code><a href="#insert_media">insert_media(bucket, body=None, media_body=None, projection=None, media_mime_type=None, ifMetagenerationMatch=None, name=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, ifGenerationNotMatch=None)</a></code></p> 103 <p class="firstline">Stores new data blobs and associated metadata.</p> 104 <p class="toc_element"> 105 <code><a href="#list">list(bucket, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)</a></code></p> 106 <p class="firstline">Retrieves a list of objects matching the criteria.</p> 107 <p class="toc_element"> 108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 109 <p class="firstline">Retrieves the next page of results.</p> 110 <p class="toc_element"> 111 <code><a href="#patch">patch(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p> 112 <p class="firstline">Updates a data blob's associated metadata. This method supports patch semantics.</p> 113 <p class="toc_element"> 114 <code><a href="#update">update(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p> 115 <p class="firstline">Updates a data blob's associated metadata.</p> 116 <p class="toc_element"> 117 <code><a href="#update_media">update_media(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</a></code></p> 118 <p class="firstline">Updates a data blob's associated metadata.</p> 119 <p class="toc_element"> 120 <code><a href="#watchAll">watchAll(bucket, body, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)</a></code></p> 121 <p class="firstline">Watch for changes on all objects in a bucket.</p> 122 <h3>Method Details</h3> 123 <div class="method"> 124 <code class="details" id="compose">compose(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)</code> 125 <pre>Concatenates a list of existing objects into a new object in the same bucket. 126 127 Args: 128 destinationBucket: string, Name of the bucket in which to store the new object. (required) 129 destinationObject: string, Name of the new object. (required) 130 body: object, The request body. (required) 131 The object takes the form of: 132 133 { # A Compose request. 134 "kind": "storage#composeRequest", # The kind of item this is. 135 "destination": { # An object. # Properties of the resulting object 136 "generation": "A String", # The content generation of this object. Used for object versioning. 137 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 138 "mediaLink": "A String", # Media download link. 139 "owner": { # The owner of the object. This will always be the uploader of the object. 140 "entityId": "A String", # The ID for the entity. 141 "entity": "A String", # The entity, in the form user-userId. 142 }, 143 "cacheControl": "A String", # Cache-Control directive for the object data. 144 "acl": [ # Access controls on the object. 145 { # An access-control entry. 146 "domain": "A String", # The domain associated with the entity, if any. 147 "generation": "A String", # The content generation of the object. 148 "object": "A String", # The name of the object. 149 "bucket": "A String", # The name of the bucket. 150 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 151 "entity": "A String", # The entity holding the permission, in one of the following forms: 152 # - user-userId 153 # - user-email 154 # - group-groupId 155 # - group-email 156 # - domain-domain 157 # - allUsers 158 # - allAuthenticatedUsers Examples: 159 # - The user liz (a] example.com would be user-liz (a] example.com. 160 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 161 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 162 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 163 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 164 "id": "A String", # The ID of the access-control entry. 165 "entityId": "A String", # The ID for the entity, if any. 166 "email": "A String", # The email address associated with the entity, if any. 167 "selfLink": "A String", # The link to this access-control entry. 168 }, 169 ], 170 "id": "A String", # The ID of the object. 171 "size": "A String", # Content-Length of the data in bytes. 172 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 173 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 174 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 175 "etag": "A String", # HTTP 1.1 Entity tag for the object. 176 "metadata": { # User-provided metadata, in key/value pairs. 177 "a_key": "A String", # An individual metadata entry. 178 }, 179 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 180 "contentType": "A String", # Content-Type of the object data. 181 "contentDisposition": "A String", # Content-Disposition of the object data. 182 "contentLanguage": "A String", # Content-Language of the object data. 183 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 184 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 185 "name": "A String", # The name of this object. Required if not specified by URL parameter. 186 "bucket": "A String", # The bucket containing this object. 187 "contentEncoding": "A String", # Content-Encoding of the object data. 188 "storageClass": "A String", # Storage class of the object. 189 "selfLink": "A String", # The link to this object. 190 }, 191 "sourceObjects": [ # The list of source objects that will be concatenated into a single object. 192 { 193 "generation": "A String", # The generation of this object to use as the source. 194 "name": "A String", # The source object's name. The source object's bucket is implicitly the destination bucket. 195 "objectPreconditions": { # Conditions that must be met for this operation to execute. 196 "ifGenerationMatch": "A String", # Only perform the composition if the generation of the source object that would be used matches this value. If this value and a generation are both specified, they must be the same value or the call will fail. 197 }, 198 }, 199 ], 200 } 201 202 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 203 ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. 204 205 Returns: 206 An object of the form: 207 208 { # An object. 209 "generation": "A String", # The content generation of this object. Used for object versioning. 210 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 211 "mediaLink": "A String", # Media download link. 212 "owner": { # The owner of the object. This will always be the uploader of the object. 213 "entityId": "A String", # The ID for the entity. 214 "entity": "A String", # The entity, in the form user-userId. 215 }, 216 "cacheControl": "A String", # Cache-Control directive for the object data. 217 "acl": [ # Access controls on the object. 218 { # An access-control entry. 219 "domain": "A String", # The domain associated with the entity, if any. 220 "generation": "A String", # The content generation of the object. 221 "object": "A String", # The name of the object. 222 "bucket": "A String", # The name of the bucket. 223 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 224 "entity": "A String", # The entity holding the permission, in one of the following forms: 225 # - user-userId 226 # - user-email 227 # - group-groupId 228 # - group-email 229 # - domain-domain 230 # - allUsers 231 # - allAuthenticatedUsers Examples: 232 # - The user liz (a] example.com would be user-liz (a] example.com. 233 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 234 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 235 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 236 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 237 "id": "A String", # The ID of the access-control entry. 238 "entityId": "A String", # The ID for the entity, if any. 239 "email": "A String", # The email address associated with the entity, if any. 240 "selfLink": "A String", # The link to this access-control entry. 241 }, 242 ], 243 "id": "A String", # The ID of the object. 244 "size": "A String", # Content-Length of the data in bytes. 245 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 246 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 247 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 248 "etag": "A String", # HTTP 1.1 Entity tag for the object. 249 "metadata": { # User-provided metadata, in key/value pairs. 250 "a_key": "A String", # An individual metadata entry. 251 }, 252 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 253 "contentType": "A String", # Content-Type of the object data. 254 "contentDisposition": "A String", # Content-Disposition of the object data. 255 "contentLanguage": "A String", # Content-Language of the object data. 256 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 257 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 258 "name": "A String", # The name of this object. Required if not specified by URL parameter. 259 "bucket": "A String", # The bucket containing this object. 260 "contentEncoding": "A String", # Content-Encoding of the object data. 261 "storageClass": "A String", # Storage class of the object. 262 "selfLink": "A String", # The link to this object. 263 }</pre> 264 </div> 265 266 <div class="method"> 267 <code class="details" id="compose_media">compose_media(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)</code> 268 <pre>Concatenates a list of existing objects into a new object in the same bucket. 269 270 Args: 271 destinationBucket: string, Name of the bucket in which to store the new object. (required) 272 destinationObject: string, Name of the new object. (required) 273 body: object, The request body. (required) 274 The object takes the form of: 275 276 { # A Compose request. 277 "kind": "storage#composeRequest", # The kind of item this is. 278 "destination": { # An object. # Properties of the resulting object 279 "generation": "A String", # The content generation of this object. Used for object versioning. 280 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 281 "mediaLink": "A String", # Media download link. 282 "owner": { # The owner of the object. This will always be the uploader of the object. 283 "entityId": "A String", # The ID for the entity. 284 "entity": "A String", # The entity, in the form user-userId. 285 }, 286 "cacheControl": "A String", # Cache-Control directive for the object data. 287 "acl": [ # Access controls on the object. 288 { # An access-control entry. 289 "domain": "A String", # The domain associated with the entity, if any. 290 "generation": "A String", # The content generation of the object. 291 "object": "A String", # The name of the object. 292 "bucket": "A String", # The name of the bucket. 293 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 294 "entity": "A String", # The entity holding the permission, in one of the following forms: 295 # - user-userId 296 # - user-email 297 # - group-groupId 298 # - group-email 299 # - domain-domain 300 # - allUsers 301 # - allAuthenticatedUsers Examples: 302 # - The user liz (a] example.com would be user-liz (a] example.com. 303 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 304 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 305 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 306 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 307 "id": "A String", # The ID of the access-control entry. 308 "entityId": "A String", # The ID for the entity, if any. 309 "email": "A String", # The email address associated with the entity, if any. 310 "selfLink": "A String", # The link to this access-control entry. 311 }, 312 ], 313 "id": "A String", # The ID of the object. 314 "size": "A String", # Content-Length of the data in bytes. 315 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 316 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 317 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 318 "etag": "A String", # HTTP 1.1 Entity tag for the object. 319 "metadata": { # User-provided metadata, in key/value pairs. 320 "a_key": "A String", # An individual metadata entry. 321 }, 322 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 323 "contentType": "A String", # Content-Type of the object data. 324 "contentDisposition": "A String", # Content-Disposition of the object data. 325 "contentLanguage": "A String", # Content-Language of the object data. 326 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 327 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 328 "name": "A String", # The name of this object. Required if not specified by URL parameter. 329 "bucket": "A String", # The bucket containing this object. 330 "contentEncoding": "A String", # Content-Encoding of the object data. 331 "storageClass": "A String", # Storage class of the object. 332 "selfLink": "A String", # The link to this object. 333 }, 334 "sourceObjects": [ # The list of source objects that will be concatenated into a single object. 335 { 336 "generation": "A String", # The generation of this object to use as the source. 337 "name": "A String", # The source object's name. The source object's bucket is implicitly the destination bucket. 338 "objectPreconditions": { # Conditions that must be met for this operation to execute. 339 "ifGenerationMatch": "A String", # Only perform the composition if the generation of the source object that would be used matches this value. If this value and a generation are both specified, they must be the same value or the call will fail. 340 }, 341 }, 342 ], 343 } 344 345 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 346 ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. 347 348 Returns: 349 The media object as a string. 350 351 </pre> 352 </div> 353 354 <div class="method"> 355 <code class="details" id="copy">copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationMatch=None)</code> 356 <pre>Copies an object to a destination in the same location. Optionally overrides metadata. 357 358 Args: 359 sourceBucket: string, Name of the bucket in which to find the source object. (required) 360 sourceObject: string, Name of the source object. (required) 361 destinationBucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required) 362 destinationObject: string, Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. (required) 363 body: object, The request body. (required) 364 The object takes the form of: 365 366 { # An object. 367 "generation": "A String", # The content generation of this object. Used for object versioning. 368 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 369 "mediaLink": "A String", # Media download link. 370 "owner": { # The owner of the object. This will always be the uploader of the object. 371 "entityId": "A String", # The ID for the entity. 372 "entity": "A String", # The entity, in the form user-userId. 373 }, 374 "cacheControl": "A String", # Cache-Control directive for the object data. 375 "acl": [ # Access controls on the object. 376 { # An access-control entry. 377 "domain": "A String", # The domain associated with the entity, if any. 378 "generation": "A String", # The content generation of the object. 379 "object": "A String", # The name of the object. 380 "bucket": "A String", # The name of the bucket. 381 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 382 "entity": "A String", # The entity holding the permission, in one of the following forms: 383 # - user-userId 384 # - user-email 385 # - group-groupId 386 # - group-email 387 # - domain-domain 388 # - allUsers 389 # - allAuthenticatedUsers Examples: 390 # - The user liz (a] example.com would be user-liz (a] example.com. 391 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 392 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 393 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 394 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 395 "id": "A String", # The ID of the access-control entry. 396 "entityId": "A String", # The ID for the entity, if any. 397 "email": "A String", # The email address associated with the entity, if any. 398 "selfLink": "A String", # The link to this access-control entry. 399 }, 400 ], 401 "id": "A String", # The ID of the object. 402 "size": "A String", # Content-Length of the data in bytes. 403 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 404 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 405 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 406 "etag": "A String", # HTTP 1.1 Entity tag for the object. 407 "metadata": { # User-provided metadata, in key/value pairs. 408 "a_key": "A String", # An individual metadata entry. 409 }, 410 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 411 "contentType": "A String", # Content-Type of the object data. 412 "contentDisposition": "A String", # Content-Disposition of the object data. 413 "contentLanguage": "A String", # Content-Language of the object data. 414 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 415 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 416 "name": "A String", # The name of this object. Required if not specified by URL parameter. 417 "bucket": "A String", # The bucket containing this object. 418 "contentEncoding": "A String", # Content-Encoding of the object data. 419 "storageClass": "A String", # Storage class of the object. 420 "selfLink": "A String", # The link to this object. 421 } 422 423 projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. 424 Allowed values 425 full - Include all properties. 426 noAcl - Omit the acl property. 427 sourceGeneration: string, If present, selects a specific revision of the source object (as opposed to the latest version, the default). 428 ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's generation does not match the given value. 429 ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value. 430 ifGenerationMatch: string, Makes the operation conditional on whether the destination object's current generation matches the given value. 431 ifGenerationNotMatch: string, Makes the operation conditional on whether the destination object's current generation does not match the given value. 432 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration does not match the given value. 433 ifSourceGenerationMatch: string, Makes the operation conditional on whether the source object's generation matches the given value. 434 ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source object's current metageneration matches the given value. 435 ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value. 436 437 Returns: 438 An object of the form: 439 440 { # An object. 441 "generation": "A String", # The content generation of this object. Used for object versioning. 442 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 443 "mediaLink": "A String", # Media download link. 444 "owner": { # The owner of the object. This will always be the uploader of the object. 445 "entityId": "A String", # The ID for the entity. 446 "entity": "A String", # The entity, in the form user-userId. 447 }, 448 "cacheControl": "A String", # Cache-Control directive for the object data. 449 "acl": [ # Access controls on the object. 450 { # An access-control entry. 451 "domain": "A String", # The domain associated with the entity, if any. 452 "generation": "A String", # The content generation of the object. 453 "object": "A String", # The name of the object. 454 "bucket": "A String", # The name of the bucket. 455 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 456 "entity": "A String", # The entity holding the permission, in one of the following forms: 457 # - user-userId 458 # - user-email 459 # - group-groupId 460 # - group-email 461 # - domain-domain 462 # - allUsers 463 # - allAuthenticatedUsers Examples: 464 # - The user liz (a] example.com would be user-liz (a] example.com. 465 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 466 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 467 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 468 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 469 "id": "A String", # The ID of the access-control entry. 470 "entityId": "A String", # The ID for the entity, if any. 471 "email": "A String", # The email address associated with the entity, if any. 472 "selfLink": "A String", # The link to this access-control entry. 473 }, 474 ], 475 "id": "A String", # The ID of the object. 476 "size": "A String", # Content-Length of the data in bytes. 477 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 478 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 479 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 480 "etag": "A String", # HTTP 1.1 Entity tag for the object. 481 "metadata": { # User-provided metadata, in key/value pairs. 482 "a_key": "A String", # An individual metadata entry. 483 }, 484 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 485 "contentType": "A String", # Content-Type of the object data. 486 "contentDisposition": "A String", # Content-Disposition of the object data. 487 "contentLanguage": "A String", # Content-Language of the object data. 488 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 489 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 490 "name": "A String", # The name of this object. Required if not specified by URL parameter. 491 "bucket": "A String", # The bucket containing this object. 492 "contentEncoding": "A String", # Content-Encoding of the object data. 493 "storageClass": "A String", # Storage class of the object. 494 "selfLink": "A String", # The link to this object. 495 }</pre> 496 </div> 497 498 <div class="method"> 499 <code class="details" id="copy_media">copy_media(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationMatch=None)</code> 500 <pre>Copies an object to a destination in the same location. Optionally overrides metadata. 501 502 Args: 503 sourceBucket: string, Name of the bucket in which to find the source object. (required) 504 sourceObject: string, Name of the source object. (required) 505 destinationBucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required) 506 destinationObject: string, Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. (required) 507 body: object, The request body. (required) 508 The object takes the form of: 509 510 { # An object. 511 "generation": "A String", # The content generation of this object. Used for object versioning. 512 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 513 "mediaLink": "A String", # Media download link. 514 "owner": { # The owner of the object. This will always be the uploader of the object. 515 "entityId": "A String", # The ID for the entity. 516 "entity": "A String", # The entity, in the form user-userId. 517 }, 518 "cacheControl": "A String", # Cache-Control directive for the object data. 519 "acl": [ # Access controls on the object. 520 { # An access-control entry. 521 "domain": "A String", # The domain associated with the entity, if any. 522 "generation": "A String", # The content generation of the object. 523 "object": "A String", # The name of the object. 524 "bucket": "A String", # The name of the bucket. 525 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 526 "entity": "A String", # The entity holding the permission, in one of the following forms: 527 # - user-userId 528 # - user-email 529 # - group-groupId 530 # - group-email 531 # - domain-domain 532 # - allUsers 533 # - allAuthenticatedUsers Examples: 534 # - The user liz (a] example.com would be user-liz (a] example.com. 535 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 536 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 537 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 538 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 539 "id": "A String", # The ID of the access-control entry. 540 "entityId": "A String", # The ID for the entity, if any. 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 "id": "A String", # The ID of the object. 546 "size": "A String", # Content-Length of the data in bytes. 547 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 548 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 549 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 550 "etag": "A String", # HTTP 1.1 Entity tag for the object. 551 "metadata": { # User-provided metadata, in key/value pairs. 552 "a_key": "A String", # An individual metadata entry. 553 }, 554 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 555 "contentType": "A String", # Content-Type of the object data. 556 "contentDisposition": "A String", # Content-Disposition of the object data. 557 "contentLanguage": "A String", # Content-Language of the object data. 558 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 559 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 560 "name": "A String", # The name of this object. Required if not specified by URL parameter. 561 "bucket": "A String", # The bucket containing this object. 562 "contentEncoding": "A String", # Content-Encoding of the object data. 563 "storageClass": "A String", # Storage class of the object. 564 "selfLink": "A String", # The link to this object. 565 } 566 567 projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. 568 Allowed values 569 full - Include all properties. 570 noAcl - Omit the acl property. 571 sourceGeneration: string, If present, selects a specific revision of the source object (as opposed to the latest version, the default). 572 ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's generation does not match the given value. 573 ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value. 574 ifGenerationMatch: string, Makes the operation conditional on whether the destination object's current generation matches the given value. 575 ifGenerationNotMatch: string, Makes the operation conditional on whether the destination object's current generation does not match the given value. 576 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration does not match the given value. 577 ifSourceGenerationMatch: string, Makes the operation conditional on whether the source object's generation matches the given value. 578 ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source object's current metageneration matches the given value. 579 ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value. 580 581 Returns: 582 The media object as a string. 583 584 </pre> 585 </div> 586 587 <div class="method"> 588 <code class="details" id="delete">delete(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None)</code> 589 <pre>Deletes data blobs and associated metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. 590 591 Args: 592 bucket: string, Name of the bucket in which the object resides. (required) 593 object: string, Name of the object. (required) 594 ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. 595 generation: string, If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). 596 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 597 ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. 598 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value. 599 </pre> 600 </div> 601 602 <div class="method"> 603 <code class="details" id="get">get(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</code> 604 <pre>Retrieves objects or their associated metadata. 605 606 Args: 607 bucket: string, Name of the bucket in which the object resides. (required) 608 object: string, Name of the object. (required) 609 ifGenerationNotMatch: string, Makes the operation conditional on whether the object's generation does not match the given value. 610 generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default). 611 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 612 ifGenerationMatch: string, Makes the operation conditional on whether the object's generation matches the given value. 613 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value. 614 projection: string, Set of properties to return. Defaults to noAcl. 615 Allowed values 616 full - Include all properties. 617 noAcl - Omit the acl property. 618 619 Returns: 620 An object of the form: 621 622 { # An object. 623 "generation": "A String", # The content generation of this object. Used for object versioning. 624 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 625 "mediaLink": "A String", # Media download link. 626 "owner": { # The owner of the object. This will always be the uploader of the object. 627 "entityId": "A String", # The ID for the entity. 628 "entity": "A String", # The entity, in the form user-userId. 629 }, 630 "cacheControl": "A String", # Cache-Control directive for the object data. 631 "acl": [ # Access controls on the object. 632 { # An access-control entry. 633 "domain": "A String", # The domain associated with the entity, if any. 634 "generation": "A String", # The content generation of the object. 635 "object": "A String", # The name of the object. 636 "bucket": "A String", # The name of the bucket. 637 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 638 "entity": "A String", # The entity holding the permission, in one of the following forms: 639 # - user-userId 640 # - user-email 641 # - group-groupId 642 # - group-email 643 # - domain-domain 644 # - allUsers 645 # - allAuthenticatedUsers Examples: 646 # - The user liz (a] example.com would be user-liz (a] example.com. 647 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 648 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 649 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 650 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 651 "id": "A String", # The ID of the access-control entry. 652 "entityId": "A String", # The ID for the entity, if any. 653 "email": "A String", # The email address associated with the entity, if any. 654 "selfLink": "A String", # The link to this access-control entry. 655 }, 656 ], 657 "id": "A String", # The ID of the object. 658 "size": "A String", # Content-Length of the data in bytes. 659 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 660 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 661 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 662 "etag": "A String", # HTTP 1.1 Entity tag for the object. 663 "metadata": { # User-provided metadata, in key/value pairs. 664 "a_key": "A String", # An individual metadata entry. 665 }, 666 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 667 "contentType": "A String", # Content-Type of the object data. 668 "contentDisposition": "A String", # Content-Disposition of the object data. 669 "contentLanguage": "A String", # Content-Language of the object data. 670 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 671 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 672 "name": "A String", # The name of this object. Required if not specified by URL parameter. 673 "bucket": "A String", # The bucket containing this object. 674 "contentEncoding": "A String", # Content-Encoding of the object data. 675 "storageClass": "A String", # Storage class of the object. 676 "selfLink": "A String", # The link to this object. 677 }</pre> 678 </div> 679 680 <div class="method"> 681 <code class="details" id="get_media">get_media(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</code> 682 <pre>Retrieves objects or their associated metadata. 683 684 Args: 685 bucket: string, Name of the bucket in which the object resides. (required) 686 object: string, Name of the object. (required) 687 ifGenerationNotMatch: string, Makes the operation conditional on whether the object's generation does not match the given value. 688 generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default). 689 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 690 ifGenerationMatch: string, Makes the operation conditional on whether the object's generation matches the given value. 691 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value. 692 projection: string, Set of properties to return. Defaults to noAcl. 693 Allowed values 694 full - Include all properties. 695 noAcl - Omit the acl property. 696 697 Returns: 698 The media object as a string. 699 700 </pre> 701 </div> 702 703 <div class="method"> 704 <code class="details" id="insert">insert(bucket, body=None, media_body=None, projection=None, media_mime_type=None, ifMetagenerationMatch=None, name=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, ifGenerationNotMatch=None)</code> 705 <pre>Stores new data blobs and associated metadata. 706 707 Args: 708 bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required) 709 body: object, The request body. 710 The object takes the form of: 711 712 { # An object. 713 "generation": "A String", # The content generation of this object. Used for object versioning. 714 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 715 "mediaLink": "A String", # Media download link. 716 "owner": { # The owner of the object. This will always be the uploader of the object. 717 "entityId": "A String", # The ID for the entity. 718 "entity": "A String", # The entity, in the form user-userId. 719 }, 720 "cacheControl": "A String", # Cache-Control directive for the object data. 721 "acl": [ # Access controls on the object. 722 { # An access-control entry. 723 "domain": "A String", # The domain associated with the entity, if any. 724 "generation": "A String", # The content generation of the object. 725 "object": "A String", # The name of the object. 726 "bucket": "A String", # The name of the bucket. 727 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 728 "entity": "A String", # The entity holding the permission, in one of the following forms: 729 # - user-userId 730 # - user-email 731 # - group-groupId 732 # - group-email 733 # - domain-domain 734 # - allUsers 735 # - allAuthenticatedUsers Examples: 736 # - The user liz (a] example.com would be user-liz (a] example.com. 737 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 738 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 739 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 740 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 741 "id": "A String", # The ID of the access-control entry. 742 "entityId": "A String", # The ID for the entity, if any. 743 "email": "A String", # The email address associated with the entity, if any. 744 "selfLink": "A String", # The link to this access-control entry. 745 }, 746 ], 747 "id": "A String", # The ID of the object. 748 "size": "A String", # Content-Length of the data in bytes. 749 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 750 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 751 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 752 "etag": "A String", # HTTP 1.1 Entity tag for the object. 753 "metadata": { # User-provided metadata, in key/value pairs. 754 "a_key": "A String", # An individual metadata entry. 755 }, 756 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 757 "contentType": "A String", # Content-Type of the object data. 758 "contentDisposition": "A String", # Content-Disposition of the object data. 759 "contentLanguage": "A String", # Content-Language of the object data. 760 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 761 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 762 "name": "A String", # The name of this object. Required if not specified by URL parameter. 763 "bucket": "A String", # The bucket containing this object. 764 "contentEncoding": "A String", # Content-Encoding of the object data. 765 "storageClass": "A String", # Storage class of the object. 766 "selfLink": "A String", # The link to this object. 767 } 768 769 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 770 projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. 771 Allowed values 772 full - Include all properties. 773 noAcl - Omit the acl property. 774 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 775 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 776 name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. 777 ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. 778 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value. 779 ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. 780 781 Returns: 782 An object of the form: 783 784 { # An object. 785 "generation": "A String", # The content generation of this object. Used for object versioning. 786 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 787 "mediaLink": "A String", # Media download link. 788 "owner": { # The owner of the object. This will always be the uploader of the object. 789 "entityId": "A String", # The ID for the entity. 790 "entity": "A String", # The entity, in the form user-userId. 791 }, 792 "cacheControl": "A String", # Cache-Control directive for the object data. 793 "acl": [ # Access controls on the object. 794 { # An access-control entry. 795 "domain": "A String", # The domain associated with the entity, if any. 796 "generation": "A String", # The content generation of the object. 797 "object": "A String", # The name of the object. 798 "bucket": "A String", # The name of the bucket. 799 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 800 "entity": "A String", # The entity holding the permission, in one of the following forms: 801 # - user-userId 802 # - user-email 803 # - group-groupId 804 # - group-email 805 # - domain-domain 806 # - allUsers 807 # - allAuthenticatedUsers Examples: 808 # - The user liz (a] example.com would be user-liz (a] example.com. 809 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 810 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 811 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 812 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 813 "id": "A String", # The ID of the access-control entry. 814 "entityId": "A String", # The ID for the entity, if any. 815 "email": "A String", # The email address associated with the entity, if any. 816 "selfLink": "A String", # The link to this access-control entry. 817 }, 818 ], 819 "id": "A String", # The ID of the object. 820 "size": "A String", # Content-Length of the data in bytes. 821 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 822 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 823 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 824 "etag": "A String", # HTTP 1.1 Entity tag for the object. 825 "metadata": { # User-provided metadata, in key/value pairs. 826 "a_key": "A String", # An individual metadata entry. 827 }, 828 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 829 "contentType": "A String", # Content-Type of the object data. 830 "contentDisposition": "A String", # Content-Disposition of the object data. 831 "contentLanguage": "A String", # Content-Language of the object data. 832 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 833 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 834 "name": "A String", # The name of this object. Required if not specified by URL parameter. 835 "bucket": "A String", # The bucket containing this object. 836 "contentEncoding": "A String", # Content-Encoding of the object data. 837 "storageClass": "A String", # Storage class of the object. 838 "selfLink": "A String", # The link to this object. 839 }</pre> 840 </div> 841 842 <div class="method"> 843 <code class="details" id="insert_media">insert_media(bucket, body=None, media_body=None, projection=None, media_mime_type=None, ifMetagenerationMatch=None, name=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, ifGenerationNotMatch=None)</code> 844 <pre>Stores new data blobs and associated metadata. 845 846 Args: 847 bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required) 848 body: object, The request body. 849 The object takes the form of: 850 851 { # An object. 852 "generation": "A String", # The content generation of this object. Used for object versioning. 853 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 854 "mediaLink": "A String", # Media download link. 855 "owner": { # The owner of the object. This will always be the uploader of the object. 856 "entityId": "A String", # The ID for the entity. 857 "entity": "A String", # The entity, in the form user-userId. 858 }, 859 "cacheControl": "A String", # Cache-Control directive for the object data. 860 "acl": [ # Access controls on the object. 861 { # An access-control entry. 862 "domain": "A String", # The domain associated with the entity, if any. 863 "generation": "A String", # The content generation of the object. 864 "object": "A String", # The name of the object. 865 "bucket": "A String", # The name of the bucket. 866 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 867 "entity": "A String", # The entity holding the permission, in one of the following forms: 868 # - user-userId 869 # - user-email 870 # - group-groupId 871 # - group-email 872 # - domain-domain 873 # - allUsers 874 # - allAuthenticatedUsers Examples: 875 # - The user liz (a] example.com would be user-liz (a] example.com. 876 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 877 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 878 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 879 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 880 "id": "A String", # The ID of the access-control entry. 881 "entityId": "A String", # The ID for the entity, if any. 882 "email": "A String", # The email address associated with the entity, if any. 883 "selfLink": "A String", # The link to this access-control entry. 884 }, 885 ], 886 "id": "A String", # The ID of the object. 887 "size": "A String", # Content-Length of the data in bytes. 888 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 889 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 890 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 891 "etag": "A String", # HTTP 1.1 Entity tag for the object. 892 "metadata": { # User-provided metadata, in key/value pairs. 893 "a_key": "A String", # An individual metadata entry. 894 }, 895 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 896 "contentType": "A String", # Content-Type of the object data. 897 "contentDisposition": "A String", # Content-Disposition of the object data. 898 "contentLanguage": "A String", # Content-Language of the object data. 899 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 900 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 901 "name": "A String", # The name of this object. Required if not specified by URL parameter. 902 "bucket": "A String", # The bucket containing this object. 903 "contentEncoding": "A String", # Content-Encoding of the object data. 904 "storageClass": "A String", # Storage class of the object. 905 "selfLink": "A String", # The link to this object. 906 } 907 908 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 909 projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. 910 Allowed values 911 full - Include all properties. 912 noAcl - Omit the acl property. 913 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 914 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 915 name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. 916 ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. 917 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value. 918 ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. 919 920 Returns: 921 The media object as a string. 922 923 </pre> 924 </div> 925 926 <div class="method"> 927 <code class="details" id="list">list(bucket, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)</code> 928 <pre>Retrieves a list of objects matching the criteria. 929 930 Args: 931 bucket: string, Name of the bucket in which to look for objects. (required) 932 projection: string, Set of properties to return. Defaults to noAcl. 933 Allowed values 934 full - Include all properties. 935 noAcl - Omit the acl property. 936 versions: boolean, If true, lists all versions of a file as distinct results. 937 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. 938 maxResults: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. 939 pageToken: string, A previously-returned page token representing part of the larger set of results to view. 940 prefix: string, Filter results to objects whose names begin with this prefix. 941 942 Returns: 943 An object of the form: 944 945 { # A list of objects. 946 "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. 947 "items": [ # The list of items. 948 { # An object. 949 "generation": "A String", # The content generation of this object. Used for object versioning. 950 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 951 "mediaLink": "A String", # Media download link. 952 "owner": { # The owner of the object. This will always be the uploader of the object. 953 "entityId": "A String", # The ID for the entity. 954 "entity": "A String", # The entity, in the form user-userId. 955 }, 956 "cacheControl": "A String", # Cache-Control directive for the object data. 957 "acl": [ # Access controls on the object. 958 { # An access-control entry. 959 "domain": "A String", # The domain associated with the entity, if any. 960 "generation": "A String", # The content generation of the object. 961 "object": "A String", # The name of the object. 962 "bucket": "A String", # The name of the bucket. 963 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 964 "entity": "A String", # The entity holding the permission, in one of the following forms: 965 # - user-userId 966 # - user-email 967 # - group-groupId 968 # - group-email 969 # - domain-domain 970 # - allUsers 971 # - allAuthenticatedUsers Examples: 972 # - The user liz (a] example.com would be user-liz (a] example.com. 973 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 974 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 975 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 976 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 977 "id": "A String", # The ID of the access-control entry. 978 "entityId": "A String", # The ID for the entity, if any. 979 "email": "A String", # The email address associated with the entity, if any. 980 "selfLink": "A String", # The link to this access-control entry. 981 }, 982 ], 983 "id": "A String", # The ID of the object. 984 "size": "A String", # Content-Length of the data in bytes. 985 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 986 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 987 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 988 "etag": "A String", # HTTP 1.1 Entity tag for the object. 989 "metadata": { # User-provided metadata, in key/value pairs. 990 "a_key": "A String", # An individual metadata entry. 991 }, 992 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 993 "contentType": "A String", # Content-Type of the object data. 994 "contentDisposition": "A String", # Content-Disposition of the object data. 995 "contentLanguage": "A String", # Content-Language of the object data. 996 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 997 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 998 "name": "A String", # The name of this object. Required if not specified by URL parameter. 999 "bucket": "A String", # The bucket containing this object. 1000 "contentEncoding": "A String", # Content-Encoding of the object data. 1001 "storageClass": "A String", # Storage class of the object. 1002 "selfLink": "A String", # The link to this object. 1003 }, 1004 ], 1005 "kind": "storage#objects", # The kind of item this is. For lists of objects, this is always storage#objects. 1006 "prefixes": [ # The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter. 1007 "A String", 1008 ], 1009 }</pre> 1010 </div> 1011 1012 <div class="method"> 1013 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1014 <pre>Retrieves the next page of results. 1015 1016 Args: 1017 previous_request: The request for the previous page. (required) 1018 previous_response: The response from the request for the previous page. (required) 1019 1020 Returns: 1021 A request object that you can call 'execute()' on to request the next 1022 page. Returns None if there are no more items in the collection. 1023 </pre> 1024 </div> 1025 1026 <div class="method"> 1027 <code class="details" id="patch">patch(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</code> 1028 <pre>Updates a data blob's associated metadata. This method supports patch semantics. 1029 1030 Args: 1031 bucket: string, Name of the bucket in which the object resides. (required) 1032 object: string, Name of the object. (required) 1033 body: object, The request body. (required) 1034 The object takes the form of: 1035 1036 { # An object. 1037 "generation": "A String", # The content generation of this object. Used for object versioning. 1038 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 1039 "mediaLink": "A String", # Media download link. 1040 "owner": { # The owner of the object. This will always be the uploader of the object. 1041 "entityId": "A String", # The ID for the entity. 1042 "entity": "A String", # The entity, in the form user-userId. 1043 }, 1044 "cacheControl": "A String", # Cache-Control directive for the object data. 1045 "acl": [ # Access controls on the object. 1046 { # An access-control entry. 1047 "domain": "A String", # The domain associated with the entity, if any. 1048 "generation": "A String", # The content generation of the object. 1049 "object": "A String", # The name of the object. 1050 "bucket": "A String", # The name of the bucket. 1051 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1052 "entity": "A String", # The entity holding the permission, in one of the following forms: 1053 # - user-userId 1054 # - user-email 1055 # - group-groupId 1056 # - group-email 1057 # - domain-domain 1058 # - allUsers 1059 # - allAuthenticatedUsers Examples: 1060 # - The user liz (a] example.com would be user-liz (a] example.com. 1061 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 1062 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1063 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1064 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 1065 "id": "A String", # The ID of the access-control entry. 1066 "entityId": "A String", # The ID for the entity, if any. 1067 "email": "A String", # The email address associated with the entity, if any. 1068 "selfLink": "A String", # The link to this access-control entry. 1069 }, 1070 ], 1071 "id": "A String", # The ID of the object. 1072 "size": "A String", # Content-Length of the data in bytes. 1073 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 1074 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 1075 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 1076 "etag": "A String", # HTTP 1.1 Entity tag for the object. 1077 "metadata": { # User-provided metadata, in key/value pairs. 1078 "a_key": "A String", # An individual metadata entry. 1079 }, 1080 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 1081 "contentType": "A String", # Content-Type of the object data. 1082 "contentDisposition": "A String", # Content-Disposition of the object data. 1083 "contentLanguage": "A String", # Content-Language of the object data. 1084 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 1085 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 1086 "name": "A String", # The name of this object. Required if not specified by URL parameter. 1087 "bucket": "A String", # The bucket containing this object. 1088 "contentEncoding": "A String", # Content-Encoding of the object data. 1089 "storageClass": "A String", # Storage class of the object. 1090 "selfLink": "A String", # The link to this object. 1091 } 1092 1093 ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. 1094 generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default). 1095 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 1096 ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. 1097 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value. 1098 projection: string, Set of properties to return. Defaults to full. 1099 Allowed values 1100 full - Include all properties. 1101 noAcl - Omit the acl property. 1102 1103 Returns: 1104 An object of the form: 1105 1106 { # An object. 1107 "generation": "A String", # The content generation of this object. Used for object versioning. 1108 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 1109 "mediaLink": "A String", # Media download link. 1110 "owner": { # The owner of the object. This will always be the uploader of the object. 1111 "entityId": "A String", # The ID for the entity. 1112 "entity": "A String", # The entity, in the form user-userId. 1113 }, 1114 "cacheControl": "A String", # Cache-Control directive for the object data. 1115 "acl": [ # Access controls on the object. 1116 { # An access-control entry. 1117 "domain": "A String", # The domain associated with the entity, if any. 1118 "generation": "A String", # The content generation of the object. 1119 "object": "A String", # The name of the object. 1120 "bucket": "A String", # The name of the bucket. 1121 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1122 "entity": "A String", # The entity holding the permission, in one of the following forms: 1123 # - user-userId 1124 # - user-email 1125 # - group-groupId 1126 # - group-email 1127 # - domain-domain 1128 # - allUsers 1129 # - allAuthenticatedUsers Examples: 1130 # - The user liz (a] example.com would be user-liz (a] example.com. 1131 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 1132 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1133 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1134 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 1135 "id": "A String", # The ID of the access-control entry. 1136 "entityId": "A String", # The ID for the entity, if any. 1137 "email": "A String", # The email address associated with the entity, if any. 1138 "selfLink": "A String", # The link to this access-control entry. 1139 }, 1140 ], 1141 "id": "A String", # The ID of the object. 1142 "size": "A String", # Content-Length of the data in bytes. 1143 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 1144 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 1145 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 1146 "etag": "A String", # HTTP 1.1 Entity tag for the object. 1147 "metadata": { # User-provided metadata, in key/value pairs. 1148 "a_key": "A String", # An individual metadata entry. 1149 }, 1150 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 1151 "contentType": "A String", # Content-Type of the object data. 1152 "contentDisposition": "A String", # Content-Disposition of the object data. 1153 "contentLanguage": "A String", # Content-Language of the object data. 1154 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 1155 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 1156 "name": "A String", # The name of this object. Required if not specified by URL parameter. 1157 "bucket": "A String", # The bucket containing this object. 1158 "contentEncoding": "A String", # Content-Encoding of the object data. 1159 "storageClass": "A String", # Storage class of the object. 1160 "selfLink": "A String", # The link to this object. 1161 }</pre> 1162 </div> 1163 1164 <div class="method"> 1165 <code class="details" id="update">update(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</code> 1166 <pre>Updates a data blob's associated metadata. 1167 1168 Args: 1169 bucket: string, Name of the bucket in which the object resides. (required) 1170 object: string, Name of the object. (required) 1171 body: object, The request body. (required) 1172 The object takes the form of: 1173 1174 { # An object. 1175 "generation": "A String", # The content generation of this object. Used for object versioning. 1176 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 1177 "mediaLink": "A String", # Media download link. 1178 "owner": { # The owner of the object. This will always be the uploader of the object. 1179 "entityId": "A String", # The ID for the entity. 1180 "entity": "A String", # The entity, in the form user-userId. 1181 }, 1182 "cacheControl": "A String", # Cache-Control directive for the object data. 1183 "acl": [ # Access controls on the object. 1184 { # An access-control entry. 1185 "domain": "A String", # The domain associated with the entity, if any. 1186 "generation": "A String", # The content generation of the object. 1187 "object": "A String", # The name of the object. 1188 "bucket": "A String", # The name of the bucket. 1189 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1190 "entity": "A String", # The entity holding the permission, in one of the following forms: 1191 # - user-userId 1192 # - user-email 1193 # - group-groupId 1194 # - group-email 1195 # - domain-domain 1196 # - allUsers 1197 # - allAuthenticatedUsers Examples: 1198 # - The user liz (a] example.com would be user-liz (a] example.com. 1199 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 1200 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1201 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1202 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 1203 "id": "A String", # The ID of the access-control entry. 1204 "entityId": "A String", # The ID for the entity, if any. 1205 "email": "A String", # The email address associated with the entity, if any. 1206 "selfLink": "A String", # The link to this access-control entry. 1207 }, 1208 ], 1209 "id": "A String", # The ID of the object. 1210 "size": "A String", # Content-Length of the data in bytes. 1211 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 1212 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 1213 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 1214 "etag": "A String", # HTTP 1.1 Entity tag for the object. 1215 "metadata": { # User-provided metadata, in key/value pairs. 1216 "a_key": "A String", # An individual metadata entry. 1217 }, 1218 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 1219 "contentType": "A String", # Content-Type of the object data. 1220 "contentDisposition": "A String", # Content-Disposition of the object data. 1221 "contentLanguage": "A String", # Content-Language of the object data. 1222 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 1223 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 1224 "name": "A String", # The name of this object. Required if not specified by URL parameter. 1225 "bucket": "A String", # The bucket containing this object. 1226 "contentEncoding": "A String", # Content-Encoding of the object data. 1227 "storageClass": "A String", # Storage class of the object. 1228 "selfLink": "A String", # The link to this object. 1229 } 1230 1231 ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. 1232 generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default). 1233 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 1234 ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. 1235 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value. 1236 projection: string, Set of properties to return. Defaults to full. 1237 Allowed values 1238 full - Include all properties. 1239 noAcl - Omit the acl property. 1240 1241 Returns: 1242 An object of the form: 1243 1244 { # An object. 1245 "generation": "A String", # The content generation of this object. Used for object versioning. 1246 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 1247 "mediaLink": "A String", # Media download link. 1248 "owner": { # The owner of the object. This will always be the uploader of the object. 1249 "entityId": "A String", # The ID for the entity. 1250 "entity": "A String", # The entity, in the form user-userId. 1251 }, 1252 "cacheControl": "A String", # Cache-Control directive for the object data. 1253 "acl": [ # Access controls on the object. 1254 { # An access-control entry. 1255 "domain": "A String", # The domain associated with the entity, if any. 1256 "generation": "A String", # The content generation of the object. 1257 "object": "A String", # The name of the object. 1258 "bucket": "A String", # The name of the bucket. 1259 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1260 "entity": "A String", # The entity holding the permission, in one of the following forms: 1261 # - user-userId 1262 # - user-email 1263 # - group-groupId 1264 # - group-email 1265 # - domain-domain 1266 # - allUsers 1267 # - allAuthenticatedUsers Examples: 1268 # - The user liz (a] example.com would be user-liz (a] example.com. 1269 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 1270 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1271 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1272 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 1273 "id": "A String", # The ID of the access-control entry. 1274 "entityId": "A String", # The ID for the entity, if any. 1275 "email": "A String", # The email address associated with the entity, if any. 1276 "selfLink": "A String", # The link to this access-control entry. 1277 }, 1278 ], 1279 "id": "A String", # The ID of the object. 1280 "size": "A String", # Content-Length of the data in bytes. 1281 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 1282 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 1283 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 1284 "etag": "A String", # HTTP 1.1 Entity tag for the object. 1285 "metadata": { # User-provided metadata, in key/value pairs. 1286 "a_key": "A String", # An individual metadata entry. 1287 }, 1288 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 1289 "contentType": "A String", # Content-Type of the object data. 1290 "contentDisposition": "A String", # Content-Disposition of the object data. 1291 "contentLanguage": "A String", # Content-Language of the object data. 1292 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 1293 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 1294 "name": "A String", # The name of this object. Required if not specified by URL parameter. 1295 "bucket": "A String", # The bucket containing this object. 1296 "contentEncoding": "A String", # Content-Encoding of the object data. 1297 "storageClass": "A String", # Storage class of the object. 1298 "selfLink": "A String", # The link to this object. 1299 }</pre> 1300 </div> 1301 1302 <div class="method"> 1303 <code class="details" id="update_media">update_media(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</code> 1304 <pre>Updates a data blob's associated metadata. 1305 1306 Args: 1307 bucket: string, Name of the bucket in which the object resides. (required) 1308 object: string, Name of the object. (required) 1309 body: object, The request body. (required) 1310 The object takes the form of: 1311 1312 { # An object. 1313 "generation": "A String", # The content generation of this object. Used for object versioning. 1314 "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32. 1315 "mediaLink": "A String", # Media download link. 1316 "owner": { # The owner of the object. This will always be the uploader of the object. 1317 "entityId": "A String", # The ID for the entity. 1318 "entity": "A String", # The entity, in the form user-userId. 1319 }, 1320 "cacheControl": "A String", # Cache-Control directive for the object data. 1321 "acl": [ # Access controls on the object. 1322 { # An access-control entry. 1323 "domain": "A String", # The domain associated with the entity, if any. 1324 "generation": "A String", # The content generation of the object. 1325 "object": "A String", # The name of the object. 1326 "bucket": "A String", # The name of the bucket. 1327 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 1328 "entity": "A String", # The entity holding the permission, in one of the following forms: 1329 # - user-userId 1330 # - user-email 1331 # - group-groupId 1332 # - group-email 1333 # - domain-domain 1334 # - allUsers 1335 # - allAuthenticatedUsers Examples: 1336 # - The user liz (a] example.com would be user-liz (a] example.com. 1337 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 1338 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 1339 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 1340 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 1341 "id": "A String", # The ID of the access-control entry. 1342 "entityId": "A String", # The ID for the entity, if any. 1343 "email": "A String", # The email address associated with the entity, if any. 1344 "selfLink": "A String", # The link to this access-control entry. 1345 }, 1346 ], 1347 "id": "A String", # The ID of the object. 1348 "size": "A String", # Content-Length of the data in bytes. 1349 "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. 1350 "md5Hash": "A String", # MD5 hash of the data; encoded using base64. 1351 "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64. 1352 "etag": "A String", # HTTP 1.1 Entity tag for the object. 1353 "metadata": { # User-provided metadata, in key/value pairs. 1354 "a_key": "A String", # An individual metadata entry. 1355 }, 1356 "updated": "A String", # Modification time of the object metadata in RFC 3339 format. 1357 "contentType": "A String", # Content-Type of the object data. 1358 "contentDisposition": "A String", # Content-Disposition of the object data. 1359 "contentLanguage": "A String", # Content-Language of the object data. 1360 "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation. 1361 "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. 1362 "name": "A String", # The name of this object. Required if not specified by URL parameter. 1363 "bucket": "A String", # The bucket containing this object. 1364 "contentEncoding": "A String", # Content-Encoding of the object data. 1365 "storageClass": "A String", # Storage class of the object. 1366 "selfLink": "A String", # The link to this object. 1367 } 1368 1369 ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value. 1370 generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default). 1371 ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value. 1372 ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. 1373 ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value. 1374 projection: string, Set of properties to return. Defaults to full. 1375 Allowed values 1376 full - Include all properties. 1377 noAcl - Omit the acl property. 1378 1379 Returns: 1380 The media object as a string. 1381 1382 </pre> 1383 </div> 1384 1385 <div class="method"> 1386 <code class="details" id="watchAll">watchAll(bucket, body, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)</code> 1387 <pre>Watch for changes on all objects in a bucket. 1388 1389 Args: 1390 bucket: string, Name of the bucket in which to look for objects. (required) 1391 body: object, The request body. (required) 1392 The object takes the form of: 1393 1394 { # An notification channel used to watch for resource changes. 1395 "resourceUri": "A String", # A version-specific identifier for the watched resource. 1396 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 1397 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 1398 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 1399 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 1400 "params": { # Additional parameters controlling delivery channel behavior. Optional. 1401 "a_key": "A String", # Declares a new parameter by name. 1402 }, 1403 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 1404 "address": "A String", # The address where notifications are delivered for this channel. 1405 "type": "A String", # The type of delivery mechanism used for this channel. 1406 "id": "A String", # A UUID or similar unique string that identifies this channel. 1407 } 1408 1409 projection: string, Set of properties to return. Defaults to noAcl. 1410 Allowed values 1411 full - Include all properties. 1412 noAcl - Omit the acl property. 1413 versions: boolean, If true, lists all versions of a file as distinct results. 1414 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. 1415 maxResults: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. 1416 pageToken: string, A previously-returned page token representing part of the larger set of results to view. 1417 prefix: string, Filter results to objects whose names begin with this prefix. 1418 1419 Returns: 1420 An object of the form: 1421 1422 { # An notification channel used to watch for resource changes. 1423 "resourceUri": "A String", # A version-specific identifier for the watched resource. 1424 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 1425 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 1426 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 1427 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 1428 "params": { # Additional parameters controlling delivery channel behavior. Optional. 1429 "a_key": "A String", # Declares a new parameter by name. 1430 }, 1431 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 1432 "address": "A String", # The address where notifications are delivered for this channel. 1433 "type": "A String", # The type of delivery mechanism used for this channel. 1434 "id": "A String", # A UUID or similar unique string that identifies this channel. 1435 }</pre> 1436 </div> 1437 1438 </body></html>
