Storage.objects.rewrite

Name of the bucket in which to find the source object.

Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.

Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Data format for the response.

One ofjson

Selector specifying which fields to include in a partial response.

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

OAuth 2.0 token for the current user.

Returns response with indentations and line breaks.

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Upload protocol for media (e.g. "media", "multipart", "resumable").

Deprecated. Please use quotaUser instead.

Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.

Apply a predefined set of access controls to the destination object.

One ofauthenticatedReadbucketOwnerFullControlbucketOwnerReadprivateprojectPrivatepublicRead

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

Makes the operation conditional on whether the destination object's current metageneration matches the given value.

Makes the operation conditional on whether the destination object's current metageneration does not match the given value.

Makes the operation conditional on whether the source object's current generation matches the given value.

Makes the operation conditional on whether the source object's current generation does not match the given value.

Makes the operation conditional on whether the source object's current metageneration matches the given value.

Makes the operation conditional on whether the source object's current metageneration does not match the given value.

The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.

Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

One offullnoAcl

Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.

If present, selects a specific revision of the source object (as opposed to the latest version, the default).

The project to be billed for this request. Required for Requester Pays buckets.

Access controls on the object.

The name of the bucket.

The domain associated with the entity, if any.

The email address associated with the entity, if any.

The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

The ID for the entity, if any.

HTTP 1.1 Entity tag for the access-control entry.

The content generation of the object, if applied to an object.

The ID of the access-control entry.

The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

Default "storage#objectAccessControl"

The name of the object, if applied to an object.

The project team associated with the entity, if any.

The access permission for the entity.

The link to this access-control entry.

The name of the bucket containing this object.

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.

Number of underlying components that make up this object. Components are accumulated by compose operations.

Content-Disposition of the object data.

Content-Encoding of the object data.

Content-Language of the object data.

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.

A timestamp in RFC 3339 format specified by the user for an object.

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

The encryption algorithm.

SHA256 hash value of the encryption key.

HTTP 1.1 Entity tag for the object.

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.

The content generation of this object. Used for object versioning.

The ID of the object, including the bucket name, object name, and generation number.

The kind of item this is. For objects, this is always storage#object.

Default "storage#object"

Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

Media download link.

User-provided metadata, in key/value pairs.

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.

The name of the object. Required if not specified by URL parameter.

The owner of the object. This will always be the uploader of the object.

The entity, in the form user-userId.

The ID for the entity.

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

The link to this object.

Content-Length of the data in bytes.

Storage class of the object.

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.

The creation time of the object in RFC 3339 format.

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.

The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.

true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response.

The kind of item this is.

Default "storage#rewriteResponse"

The total size of the object being copied in bytes. This property is always present in the response.

An object.

Access controls on the object.

The name of the bucket containing this object.

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.

Number of underlying components that make up this object. Components are accumulated by compose operations.

Content-Disposition of the object data.

Content-Encoding of the object data.

Content-Language of the object data.

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.

A timestamp in RFC 3339 format specified by the user for an object.

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

HTTP 1.1 Entity tag for the object.

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.

The content generation of this object. Used for object versioning.

The ID of the object, including the bucket name, object name, and generation number.

The kind of item this is. For objects, this is always storage#object.

Default "storage#object"

Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

Media download link.

User-provided metadata, in key/value pairs.

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.

The name of the object. Required if not specified by URL parameter.

The owner of the object. This will always be the uploader of the object.

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).

The link to this object.

Content-Length of the data in bytes.

Storage class of the object.

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.

The creation time of the object in RFC 3339 format.

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.

The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.

A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy.

The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.