Lines Matching full:object
79 <p class="firstline">Concatenates a list of existing objects into a new object in the same bucket.<…
82 <p class="firstline">Copies a source object to a destination object. Optionally overrides metadata.…
84 …<code><a href="#delete">delete(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetag…
85 <p class="firstline">Deletes an object and its metadata. Deletions are permanent if versioning is n…
87 …<code><a href="#get">get(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerat…
88 <p class="firstline">Retrieves an object or its metadata.</p>
90 …<code><a href="#getIamPolicy">getIamPolicy(bucket, object, generation=None, userProject=None, prov…
91 <p class="firstline">Returns an IAM policy for the specified object.</p>
93 …<code><a href="#get_media">get_media(bucket, object, ifGenerationNotMatch=None, generation=None, i…
94 <p class="firstline">Retrieves an object or its metadata.</p>
97 <p class="firstline">Stores a new object and metadata.</p>
105 …<code><a href="#patch">patch(bucket, object, body, projection=None, generation=None, predefinedAcl…
106 <p class="firstline">Patches an object's metadata.</p>
109 <p class="firstline">Rewrites a source object to a destination object. Optionally overrides metadat…
111 …<code><a href="#setIamPolicy">setIamPolicy(bucket, object, body, generation=None, userProject=None…
112 <p class="firstline">Updates an IAM policy for the specified object.</p>
114 …<code><a href="#testIamPermissions">testIamPermissions(bucket, object, permissions, generation=Non…
115 <p class="firstline">Tests a set of permissions on the given object to see which, if any, are held …
117 …<code><a href="#update">update(bucket, object, body, projection=None, generation=None, predefinedA…
118 <p class="firstline">Updates an object's metadata.</p>
125 <pre>Concatenates a list of existing objects into a new object in the same bucket.
128 …tring, Name of the bucket containing the source objects. The destination object is stored in this …
129 …destinationObject: string, Name of the new object. For information about how to URL encode object …
130 body: object, The request body. (required)
131 The object takes the form of:
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 a…
139 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
140 "owner": { # The owner of the object. This will always be the uploader of the object.
144 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
145 "acl": [ # Access controls on the object.
148 … "generation": "A String", # The content generation of the object, if applied to an object.
149 "object": "A String", # The name of the object, if applied to an object.
151 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
176 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
178 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
179 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
182 "etag": "A String", # HTTP 1.1 Entity tag for the object.
183 …object is under temporary hold. While this flag is set to true, the object is protected against de…
187 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
188 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
189 "contentLanguage": "A String", # Content-Language of the object data.
190 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
194 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
195 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
196 …", # A server-determined value that specifies the earliest time that the object's retention period…
197 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
198 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
199 "name": "A String", # The name of the object. Required if not specified by URL parameter.
200 "bucket": "A String", # The name of the bucket containing this object.
201 "contentEncoding": "A String", # Content-Encoding of the object data.
202 "selfLink": "A String", # The link to this object.
203 "contentDisposition": "A String", # Content-Disposition of the object data.
204 "storageClass": "A String", # Storage class of the object.
206 "sourceObjects": [ # The list of source objects that will be concatenated into a single object.
208 "generation": "A String", # The generation of this object to use as the source.
209 … "name": "A String", # The source object's name. All source objects must reside in the same bucket.
211 … String", # Only perform the composition if the generation of the source object that would be used…
217 … the object's current generation matches the given value. Setting to 0 makes the operation succeed…
218 …ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current met…
220 …tinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
222 … authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
223 … bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
224 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
225 private - Object owner gets OWNER access.
226 …projectPrivate - Object owner gets OWNER access, and project team members get access according to …
227 publicRead - Object owner gets OWNER access, and allUsers get READER access.
228 …ngs/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadat…
232 An object of the form:
234 { # An object.
235 "generation": "A String", # The content generation of this object. Used for object versioning.
236 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
238 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
239 "owner": { # The owner of the object. This will always be the uploader of the object.
243 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
244 "acl": [ # Access controls on the object.
247 "generation": "A String", # The content generation of the object, if applied to an object.
248 "object": "A String", # The name of the object, if applied to an object.
250 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
275 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
277 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
278 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
281 "etag": "A String", # HTTP 1.1 Entity tag for the object.
282 …object is under temporary hold. While this flag is set to true, the object is protected against de…
286 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
287 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
288 "contentLanguage": "A String", # Content-Language of the object data.
289 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
293 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
294 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
295 …", # A server-determined value that specifies the earliest time that the object's retention period…
296 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
297 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
298 "name": "A String", # The name of the object. Required if not specified by URL parameter.
299 "bucket": "A String", # The name of the bucket containing this object.
300 "contentEncoding": "A String", # Content-Encoding of the object data.
301 "selfLink": "A String", # The link to this object.
302 "contentDisposition": "A String", # Content-Disposition of the object data.
303 "storageClass": "A String", # Storage class of the object.
309 <pre>Copies a source object to a destination object. Optionally overrides metadata.
312 sourceBucket: string, Name of the bucket in which to find the source object. (required)
313 …sourceObject: string, Name of the source object. For information about how to URL encode object na…
314 … to store the new object. Overrides the provided object metadata's bucket value, if any.For inform…
315 …Object: string, Name of the new object. Required when the object metadata is not otherwise provide…
316 body: object, The request body. (required)
317 The object takes the form of:
319 { # An object.
320 "generation": "A String", # The content generation of this object. Used for object versioning.
321 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
323 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
324 "owner": { # The owner of the object. This will always be the uploader of the object.
328 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
329 "acl": [ # Access controls on the object.
332 "generation": "A String", # The content generation of the object, if applied to an object.
333 "object": "A String", # The name of the object, if applied to an object.
335 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
360 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
362 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
363 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
366 "etag": "A String", # HTTP 1.1 Entity tag for the object.
367 …object is under temporary hold. While this flag is set to true, the object is protected against de…
371 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
372 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
373 "contentLanguage": "A String", # Content-Language of the object data.
374 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
378 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
379 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
380 …", # A server-determined value that specifies the earliest time that the object's retention period…
381 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
382 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
383 "name": "A String", # The name of the object. Required if not specified by URL parameter.
384 "bucket": "A String", # The name of the bucket containing this object.
385 "contentEncoding": "A String", # Content-Encoding of the object data.
386 "selfLink": "A String", # The link to this object.
387 "contentDisposition": "A String", # Content-Disposition of the object data.
388 "storageClass": "A String", # Storage class of the object.
391 …projection: string, Set of properties to return. Defaults to noAcl, unless the object resource spe…
395 …sourceGeneration: string, If present, selects a specific revision of the source object (as opposed…
396 …ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's…
397 …nNotMatch: string, Makes the operation conditional on whether the source object's current metagene…
398 …tion object's current generation matches the given value. Setting to 0 makes the operation succeed…
400 …object's current generation does not match the given value. If no live object exists, the precondi…
401 …ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's…
403 …tinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
405 … authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
406 … bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
407 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
408 private - Object owner gets OWNER access.
409 …projectPrivate - Object owner gets OWNER access, and project team members get access according to …
410 publicRead - Object owner gets OWNER access, and allUsers get READER access.
411 …ifSourceGenerationMatch: string, Makes the operation conditional on whether the source object's cu…
412 …ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source object'…
413 …atch: string, Makes the operation conditional on whether the destination object's current metagene…
416 An object of the form:
418 { # An object.
419 "generation": "A String", # The content generation of this object. Used for object versioning.
420 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
422 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
423 "owner": { # The owner of the object. This will always be the uploader of the object.
427 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
428 "acl": [ # Access controls on the object.
431 "generation": "A String", # The content generation of the object, if applied to an object.
432 "object": "A String", # The name of the object, if applied to an object.
434 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
459 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
461 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
462 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
465 "etag": "A String", # HTTP 1.1 Entity tag for the object.
466 …object is under temporary hold. While this flag is set to true, the object is protected against de…
470 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
471 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
472 "contentLanguage": "A String", # Content-Language of the object data.
473 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
477 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
478 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
479 …", # A server-determined value that specifies the earliest time that the object's retention period…
480 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
481 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
482 "name": "A String", # The name of the object. Required if not specified by URL parameter.
483 "bucket": "A String", # The name of the bucket containing this object.
484 "contentEncoding": "A String", # Content-Encoding of the object data.
485 "selfLink": "A String", # The link to this object.
486 "contentDisposition": "A String", # Content-Disposition of the object data.
487 "storageClass": "A String", # Storage class of the object.
492 …<code class="details" id="delete">delete(bucket, object, ifGenerationNotMatch=None, generation=Non…
493 …<pre>Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for …
496 bucket: string, Name of the bucket in which the object resides. (required)
497 …object: string, Name of the object. For information about how to URL encode object names to be pat…
498 …object's current generation does not match the given value. If no live object exists, the precondi…
499 …generation: string, If present, permanently deletes a specific revision of this object (as opposed…
500 …ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current met…
502 … the object's current generation matches the given value. Setting to 0 makes the operation succeed…
504 …ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current …
509 …<code class="details" id="get">get(bucket, object, ifGenerationNotMatch=None, generation=None, ifM…
510 <pre>Retrieves an object or its metadata.
513 bucket: string, Name of the bucket in which the object resides. (required)
514 …object: string, Name of the object. For information about how to URL encode object names to be pat…
515 …object's current generation does not match the given value. If no live object exists, the precondi…
516 …generation: string, If present, selects a specific revision of this object (as opposed to the late…
517 …ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current met…
519 … the object's current generation matches the given value. Setting to 0 makes the operation succeed…
521 …ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current …
528 An object of the form:
530 { # An object.
531 "generation": "A String", # The content generation of this object. Used for object versioning.
532 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
534 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
535 "owner": { # The owner of the object. This will always be the uploader of the object.
539 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
540 "acl": [ # Access controls on the object.
543 "generation": "A String", # The content generation of the object, if applied to an object.
544 "object": "A String", # The name of the object, if applied to an object.
546 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
571 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
573 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
574 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
577 "etag": "A String", # HTTP 1.1 Entity tag for the object.
578 …object is under temporary hold. While this flag is set to true, the object is protected against de…
582 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
583 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
584 "contentLanguage": "A String", # Content-Language of the object data.
585 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
589 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
590 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
591 …", # A server-determined value that specifies the earliest time that the object's retention period…
592 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
593 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
594 "name": "A String", # The name of the object. Required if not specified by URL parameter.
595 "bucket": "A String", # The name of the bucket containing this object.
596 "contentEncoding": "A String", # Content-Encoding of the object data.
597 "selfLink": "A String", # The link to this object.
598 "contentDisposition": "A String", # Content-Disposition of the object data.
599 "storageClass": "A String", # Storage class of the object.
604 …<code class="details" id="getIamPolicy">getIamPolicy(bucket, object, generation=None, userProject=…
605 <pre>Returns an IAM policy for the specified object.
608 bucket: string, Name of the bucket in which the object resides. (required)
609 …object: string, Name of the object. For information about how to URL encode object names to be pat…
610 …generation: string, If present, selects a specific revision of this object (as opposed to the late…
615 An object of the form:
617 { # A bucket/object IAM policy.
618 …ets/bucket/objects/object for objects. A specific generation may be specified by appending #genera…
627 …only access to objects without listing. Equivalent to an ACL entry on an object with the READER ro…
628 …ss to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER rol…
629 …# - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to a…
630 …# - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletio…
631 …orage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/d…
658 …<code class="details" id="get_media">get_media(bucket, object, ifGenerationNotMatch=None, generati…
659 <pre>Retrieves an object or its metadata.
662 bucket: string, Name of the bucket in which the object resides. (required)
663 …object: string, Name of the object. For information about how to URL encode object names to be pat…
664 …object's current generation does not match the given value. If no live object exists, the precondi…
665 …generation: string, If present, selects a specific revision of this object (as opposed to the late…
666 …ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current met…
668 … the object's current generation matches the given value. Setting to 0 makes the operation succeed…
670 …ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current …
677 The media object as a string.
684 <pre>Stores a new object and metadata.
687 …ket: string, Name of the bucket in which to store the new object. Overrides the provided object me…
688 body: object, The request body.
689 The object takes the form of:
691 { # An object.
692 "generation": "A String", # The content generation of this object. Used for object versioning.
693 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
695 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
696 "owner": { # The owner of the object. This will always be the uploader of the object.
700 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
701 "acl": [ # Access controls on the object.
704 "generation": "A String", # The content generation of the object, if applied to an object.
705 "object": "A String", # The name of the object, if applied to an object.
707 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
732 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
734 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
735 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
738 "etag": "A String", # HTTP 1.1 Entity tag for the object.
739 …object is under temporary hold. While this flag is set to true, the object is protected against de…
743 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
744 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
745 "contentLanguage": "A String", # Content-Language of the object data.
746 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
750 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
751 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
752 …", # A server-determined value that specifies the earliest time that the object's retention period…
753 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
754 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
755 "name": "A String", # The name of the object. Required if not specified by URL parameter.
756 "bucket": "A String", # The name of the bucket containing this object.
757 "contentEncoding": "A String", # Content-Encoding of the object data.
758 "selfLink": "A String", # The link to this object.
759 "contentDisposition": "A String", # Content-Disposition of the object data.
760 "storageClass": "A String", # Storage class of the object.
763 …projection: string, Set of properties to return. Defaults to noAcl, unless the object resource spe…
767 …ngs/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadat…
768 …media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
769 predefinedAcl: string, Apply a predefined set of access controls to this object.
771 … authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
772 … bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
773 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
774 private - Object owner gets OWNER access.
775 …projectPrivate - Object owner gets OWNER access, and project team members get access according to …
776 publicRead - Object owner gets OWNER access, and allUsers get READER access.
777 … the object's current generation matches the given value. Setting to 0 makes the operation succeed…
779 …object's current generation does not match the given value. If no live object exists, the precondi…
780 …object. Required when the object metadata is not otherwise provided. Overrides the object metadata…
781 …ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current met…
783 …object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata…
784 …mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
785 …ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current …
788 An object of the form:
790 { # An object.
791 "generation": "A String", # The content generation of this object. Used for object versioning.
792 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
794 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
795 "owner": { # The owner of the object. This will always be the uploader of the object.
799 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
800 "acl": [ # Access controls on the object.
803 "generation": "A String", # The content generation of the object, if applied to an object.
804 "object": "A String", # The name of the object, if applied to an object.
806 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
831 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
833 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
834 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
837 "etag": "A String", # HTTP 1.1 Entity tag for the object.
838 …object is under temporary hold. While this flag is set to true, the object is protected against de…
842 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
843 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
844 "contentLanguage": "A String", # Content-Language of the object data.
845 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
849 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
850 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
851 …", # A server-determined value that specifies the earliest time that the object's retention period…
852 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
853 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
854 "name": "A String", # The name of the object. Required if not specified by URL parameter.
855 "bucket": "A String", # The name of the bucket containing this object.
856 "contentEncoding": "A String", # Content-Encoding of the object data.
857 "selfLink": "A String", # The link to this object.
858 "contentDisposition": "A String", # Content-Disposition of the object data.
859 "storageClass": "A String", # Storage class of the object.
873 … If true, lists all versions of an object as distinct results. The default is false. For more info…
883 An object of the form:
888 { # An object.
889 … "generation": "A String", # The content generation of this object. Used for object versioning.
890 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
892 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
893 "owner": { # The owner of the object. This will always be the uploader of the object.
897 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
898 "acl": [ # Access controls on the object.
901 … "generation": "A String", # The content generation of the object, if applied to an object.
902 "object": "A String", # The name of the object, if applied to an object.
904 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
929 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
931 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
932 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
935 "etag": "A String", # HTTP 1.1 Entity tag for the object.
936 …object is under temporary hold. While this flag is set to true, the object is protected against de…
940 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
941 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
942 "contentLanguage": "A String", # Content-Language of the object data.
943 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
947 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
948 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
949 …", # A server-determined value that specifies the earliest time that the object's retention period…
950 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
951 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
952 "name": "A String", # The name of the object. Required if not specified by URL parameter.
953 "bucket": "A String", # The name of the bucket containing this object.
954 "contentEncoding": "A String", # Content-Encoding of the object data.
955 "selfLink": "A String", # The link to this object.
956 "contentDisposition": "A String", # Content-Disposition of the object data.
957 "storageClass": "A String", # Storage class of the object.
976 A request object that you can call 'execute()' on to request the next
982 …<code class="details" id="patch">patch(bucket, object, body, projection=None, generation=None, pre…
983 <pre>Patches an object's metadata.
986 bucket: string, Name of the bucket in which the object resides. (required)
987 …object: string, Name of the object. For information about how to URL encode object names to be pat…
988 body: object, The request body. (required)
989 The object takes the form of:
991 { # An object.
992 "generation": "A String", # The content generation of this object. Used for object versioning.
993 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
995 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
996 "owner": { # The owner of the object. This will always be the uploader of the object.
1000 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
1001 "acl": [ # Access controls on the object.
1004 "generation": "A String", # The content generation of the object, if applied to an object.
1005 "object": "A String", # The name of the object, if applied to an object.
1007 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
1032 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
1034 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
1035 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
1038 "etag": "A String", # HTTP 1.1 Entity tag for the object.
1039 …object is under temporary hold. While this flag is set to true, the object is protected against de…
1043 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
1044 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
1045 "contentLanguage": "A String", # Content-Language of the object data.
1046 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
1050 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
1051 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
1052 …", # A server-determined value that specifies the earliest time that the object's retention period…
1053 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
1054 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
1055 "name": "A String", # The name of the object. Required if not specified by URL parameter.
1056 "bucket": "A String", # The name of the bucket containing this object.
1057 "contentEncoding": "A String", # Content-Encoding of the object data.
1058 "selfLink": "A String", # The link to this object.
1059 "contentDisposition": "A String", # Content-Disposition of the object data.
1060 "storageClass": "A String", # Storage class of the object.
1067 …generation: string, If present, selects a specific revision of this object (as opposed to the late…
1068 predefinedAcl: string, Apply a predefined set of access controls to this object.
1070 … authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
1071 … bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
1072 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
1073 private - Object owner gets OWNER access.
1074 …projectPrivate - Object owner gets OWNER access, and project team members get access according to …
1075 publicRead - Object owner gets OWNER access, and allUsers get READER access.
1076 … the object's current generation matches the given value. Setting to 0 makes the operation succeed…
1078 …object's current generation does not match the given value. If no live object exists, the precondi…
1079 …ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current met…
1081 …ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current …
1084 An object of the form:
1086 { # An object.
1087 "generation": "A String", # The content generation of this object. Used for object versioning.
1088 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
1090 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
1091 "owner": { # The owner of the object. This will always be the uploader of the object.
1095 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
1096 "acl": [ # Access controls on the object.
1099 "generation": "A String", # The content generation of the object, if applied to an object.
1100 "object": "A String", # The name of the object, if applied to an object.
1102 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
1127 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
1129 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
1130 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
1133 "etag": "A String", # HTTP 1.1 Entity tag for the object.
1134 …object is under temporary hold. While this flag is set to true, the object is protected against de…
1138 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
1139 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
1140 "contentLanguage": "A String", # Content-Language of the object data.
1141 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
1145 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
1146 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
1147 …", # A server-determined value that specifies the earliest time that the object's retention period…
1148 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
1149 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
1150 "name": "A String", # The name of the object. Required if not specified by URL parameter.
1151 "bucket": "A String", # The name of the bucket containing this object.
1152 "contentEncoding": "A String", # Content-Encoding of the object data.
1153 "selfLink": "A String", # The link to this object.
1154 "contentDisposition": "A String", # Content-Disposition of the object data.
1155 "storageClass": "A String", # Storage class of the object.
1161 <pre>Rewrites a source object to a destination object. Optionally overrides metadata.
1164 sourceBucket: string, Name of the bucket in which to find the source object. (required)
1165 …sourceObject: string, Name of the source object. For information about how to URL encode object na…
1166 …ket: string, Name of the bucket in which to store the new object. Overrides the provided object me…
1167 …object. Required when the object metadata is not otherwise provided. Overrides the object metadata…
1168 body: object, The request body. (required)
1169 The object takes the form of:
1171 { # An object.
1172 "generation": "A String", # The content generation of this object. Used for object versioning.
1173 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
1175 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
1176 "owner": { # The owner of the object. This will always be the uploader of the object.
1180 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
1181 "acl": [ # Access controls on the object.
1184 "generation": "A String", # The content generation of the object, if applied to an object.
1185 "object": "A String", # The name of the object, if applied to an object.
1187 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
1212 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
1214 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
1215 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
1218 "etag": "A String", # HTTP 1.1 Entity tag for the object.
1219 …object is under temporary hold. While this flag is set to true, the object is protected against de…
1223 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
1224 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
1225 "contentLanguage": "A String", # Content-Language of the object data.
1226 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
1230 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
1231 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
1232 …", # A server-determined value that specifies the earliest time that the object's retention period…
1233 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
1234 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
1235 "name": "A String", # The name of the object. Required if not specified by URL parameter.
1236 "bucket": "A String", # The name of the bucket containing this object.
1237 "contentEncoding": "A String", # Content-Encoding of the object data.
1238 "selfLink": "A String", # The link to this object.
1239 "contentDisposition": "A String", # Content-Disposition of the object data.
1240 "storageClass": "A String", # Storage class of the object.
1243 …projection: string, Set of properties to return. Defaults to noAcl, unless the object resource spe…
1247 …sourceGeneration: string, If present, selects a specific revision of the source object (as opposed…
1249 …ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's…
1250 … the object's current generation matches the given value. Setting to 0 makes the operation succeed…
1251 …nNotMatch: string, Makes the operation conditional on whether the source object's current metagene…
1252 …ngs/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadat…
1255 …object's current generation does not match the given value. If no live object exists, the precondi…
1256 …ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's…
1258 …tinationPredefinedAcl: string, Apply a predefined set of access controls to the destination object.
1260 … authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
1261 … bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
1262 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
1263 private - Object owner gets OWNER access.
1264 …projectPrivate - Object owner gets OWNER access, and project team members get access according to …
1265 publicRead - Object owner gets OWNER access, and allUsers get READER access.
1266 …ifSourceGenerationMatch: string, Makes the operation conditional on whether the source object's cu…
1267 …ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source object'…
1268 …atch: string, Makes the operation conditional on whether the destination object's current metagene…
1271 An object of the form:
1274 …"objectSize": "A String", # The total size of the object being copied in bytes. This property is a…
1276 …"resource": { # An object. # A resource containing the metadata for the copied-to object. This pro…
1277 … "generation": "A String", # The content generation of this object. Used for object versioning.
1278 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
1280 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
1281 "owner": { # The owner of the object. This will always be the uploader of the object.
1285 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
1286 "acl": [ # Access controls on the object.
1289 … "generation": "A String", # The content generation of the object, if applied to an object.
1290 "object": "A String", # The name of the object, if applied to an object.
1292 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
1317 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
1319 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
1320 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
1323 "etag": "A String", # HTTP 1.1 Entity tag for the object.
1324 …object is under temporary hold. While this flag is set to true, the object is protected against de…
1328 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
1329 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
1330 "contentLanguage": "A String", # Content-Language of the object data.
1331 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
1335 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
1336 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
1337 …", # A server-determined value that specifies the earliest time that the object's retention period…
1338 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
1339 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
1340 "name": "A String", # The name of the object. Required if not specified by URL parameter.
1341 "bucket": "A String", # The name of the bucket containing this object.
1342 "contentEncoding": "A String", # Content-Encoding of the object data.
1343 "selfLink": "A String", # The link to this object.
1344 "contentDisposition": "A String", # Content-Disposition of the object data.
1345 "storageClass": "A String", # Storage class of the object.
1354 …<code class="details" id="setIamPolicy">setIamPolicy(bucket, object, body, generation=None, userPr…
1355 <pre>Updates an IAM policy for the specified object.
1358 bucket: string, Name of the bucket in which the object resides. (required)
1359 …object: string, Name of the object. For information about how to URL encode object names to be pat…
1360 body: object, The request body. (required)
1361 The object takes the form of:
1363 { # A bucket/object IAM policy.
1364 …ets/bucket/objects/object for objects. A specific generation may be specified by appending #genera…
1373 …only access to objects without listing. Equivalent to an ACL entry on an object with the READER ro…
1374 …ss to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER rol…
1375 …# - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to a…
1376 …# - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletio…
1377 …orage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/d…
1402 …generation: string, If present, selects a specific revision of this object (as opposed to the late…
1407 An object of the form:
1409 { # A bucket/object IAM policy.
1410 …ets/bucket/objects/object for objects. A specific generation may be specified by appending #genera…
1419 …only access to objects without listing. Equivalent to an ACL entry on an object with the READER ro…
1420 …ss to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER rol…
1421 …# - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to a…
1422 …# - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletio…
1423 …orage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/d…
1450 …<code class="details" id="testIamPermissions">testIamPermissions(bucket, object, permissions, gene…
1451 <pre>Tests a set of permissions on the given object to see which, if any, are held by the caller.
1454 bucket: string, Name of the bucket in which the object resides. (required)
1455 …object: string, Name of the object. For information about how to URL encode object names to be pat…
1457 …generation: string, If present, selects a specific revision of this object (as opposed to the late…
1462 An object of the form:
1474 # - storage.objects.delete — Delete object.
1475 # - storage.objects.get — Read object data and metadata.
1476 # - storage.objects.getIamPolicy — Read object IAM policy.
1477 # - storage.objects.create — Create object.
1479 # - storage.objects.setIamPolicy — Update object IAM policy.
1480 # - storage.objects.update — Update object metadata.
1487 …<code class="details" id="update">update(bucket, object, body, projection=None, generation=None, p…
1488 <pre>Updates an object's metadata.
1491 bucket: string, Name of the bucket in which the object resides. (required)
1492 …object: string, Name of the object. For information about how to URL encode object names to be pat…
1493 body: object, The request body. (required)
1494 The object takes the form of:
1496 { # An object.
1497 "generation": "A String", # The content generation of this object. Used for object versioning.
1498 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
1500 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
1501 "owner": { # The owner of the object. This will always be the uploader of the object.
1505 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
1506 "acl": [ # Access controls on the object.
1509 "generation": "A String", # The content generation of the object, if applied to an object.
1510 "object": "A String", # The name of the object, if applied to an object.
1512 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
1537 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
1539 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
1540 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
1543 "etag": "A String", # HTTP 1.1 Entity tag for the object.
1544 …object is under temporary hold. While this flag is set to true, the object is protected against de…
1548 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
1549 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
1550 "contentLanguage": "A String", # Content-Language of the object data.
1551 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
1555 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
1556 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
1557 …", # A server-determined value that specifies the earliest time that the object's retention period…
1558 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
1559 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
1560 "name": "A String", # The name of the object. Required if not specified by URL parameter.
1561 "bucket": "A String", # The name of the bucket containing this object.
1562 "contentEncoding": "A String", # Content-Encoding of the object data.
1563 "selfLink": "A String", # The link to this object.
1564 "contentDisposition": "A String", # Content-Disposition of the object data.
1565 "storageClass": "A String", # Storage class of the object.
1572 …generation: string, If present, selects a specific revision of this object (as opposed to the late…
1573 predefinedAcl: string, Apply a predefined set of access controls to this object.
1575 … authenticatedRead - Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
1576 … bucketOwnerFullControl - Object owner gets OWNER access, and project team owners get OWNER access.
1577 bucketOwnerRead - Object owner gets OWNER access, and project team owners get READER access.
1578 private - Object owner gets OWNER access.
1579 …projectPrivate - Object owner gets OWNER access, and project team members get access according to …
1580 publicRead - Object owner gets OWNER access, and allUsers get READER access.
1581 … the object's current generation matches the given value. Setting to 0 makes the operation succeed…
1583 …object's current generation does not match the given value. If no live object exists, the precondi…
1584 …ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current met…
1586 …ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current …
1589 An object of the form:
1591 { # An object.
1592 "generation": "A String", # The content generation of this object. Used for object versioning.
1593 …"componentCount": 42, # Number of underlying components that make up this object. Components are a…
1595 …"kmsKeyName": "A String", # Cloud KMS Key used to encrypt this object, if the object is encrypted …
1596 "owner": { # The owner of the object. This will always be the uploader of the object.
1600 …eControl": "A String", # Cache-Control directive for the object data. If omitted, and the object i…
1601 "acl": [ # Access controls on the object.
1604 "generation": "A String", # The content generation of the object, if applied to an object.
1605 "object": "A String", # The name of the object, if applied to an object.
1607 …"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entri…
1632 …"id": "A String", # The ID of the object, including the bucket name, object name, and generation n…
1634 …ring", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this …
1635 "timeCreated": "A String", # The creation time of the object in RFC 3339 format.
1638 "etag": "A String", # HTTP 1.1 Entity tag for the object.
1639 …object is under temporary hold. While this flag is set to true, the object is protected against de…
1643 "updated": "A String", # The modification time of the object metadata in RFC 3339 format.
1644 …"contentType": "A String", # Content-Type of the object data. If an object is stored without a Con…
1645 "contentLanguage": "A String", # Content-Language of the object data.
1646 …"customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted…
1650 …object at this generation. Used for preconditions and for detecting changes in metadata. A metagen…
1651 …ssUpdated": "A String", # The time at which the object's storage class was last changed. When the …
1652 …", # A server-determined value that specifies the earliest time that the object's retention period…
1653 …object is under event-based hold. Event-based hold is a way to retain objects until an event occur…
1654 … "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
1655 "name": "A String", # The name of the object. Required if not specified by URL parameter.
1656 "bucket": "A String", # The name of the bucket containing this object.
1657 "contentEncoding": "A String", # Content-Encoding of the object data.
1658 "selfLink": "A String", # The link to this object.
1659 "contentDisposition": "A String", # Content-Disposition of the object data.
1660 "storageClass": "A String", # Storage class of the object.
1670 body: object, The request body. (required)
1671 The object takes the form of:
1696 … If true, lists all versions of an object as distinct results. The default is false. For more info…
1702 An object of the form: