Rewrites a source object to a destination object. Optionally overrides metadata.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/devstorage.full_control
  • https://www.googleapis.com/auth/devstorage.read_write

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: storage1 --scope <scope> objects rewrite ...

Required Scalar Arguments

  • <source-bucket> (string)
    • Name of the bucket in which to find the source object.
  • <source-object> (string)
    • Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  • <destination-bucket> (string)
    • Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
  • <destination-object> (string)
    • 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.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Object:
  bucket: string
  cache-control: string
  component-count: integer
  content-disposition: string
  content-encoding: string
  content-language: string
  content-type: string
  crc32c: string
  custom-time: string
  customer-encryption:
    encryption-algorithm: string
    key-sha256: string
  etag: string
  event-based-hold: boolean
  generation: string
  hard-delete-time: string
  id: string
  kind: string
  kms-key-name: string
  md5-hash: string
  media-link: string
  metadata: { string: string }
  metageneration: string
  name: string
  owner:
    entity: string
    entity-id: string
  retention:
    mode: string
    retain-until-time: string
  retention-expiration-time: string
  self-link: string
  size: string
  soft-delete-time: string
  storage-class: string
  temporary-hold: boolean
  time-created: string
  time-deleted: string
  time-storage-class-updated: string
  updated: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . bucket=sed
    • The name of the bucket containing this object.
  • cache-control=no
    • 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.
  • component-count=36
    • Number of underlying components that make up this object. Components are accumulated by compose operations.
  • content-disposition=sea
    • Content-Disposition of the object data.
  • content-encoding=clita
    • Content-Encoding of the object data.
  • content-language=consetetur
    • Content-Language of the object data.
  • content-type=dolores
    • Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
  • crc32c=sit
    • 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.
  • custom-time=sea
    • A timestamp in RFC 3339 format specified by the user for an object.
  • customer-encryption encryption-algorithm=sanctus
    • The encryption algorithm.

  • key-sha256=kasd

    • SHA256 hash value of the encryption key.

  • .. etag=eirmod

    • HTTP 1.1 Entity tag for the object.
  • event-based-hold=true
    • 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.
  • generation=magna
    • The content generation of this object. Used for object versioning.
  • hard-delete-time=rebum.
    • This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
  • id=amet
    • The ID of the object, including the bucket name, object name, and generation number.
  • kind=sea
    • The kind of item this is. For objects, this is always storage#object.
  • kms-key-name=sadipscing
    • Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
  • md5-hash=dolore
    • MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
  • media-link=amet
    • Media download link.
  • metadata=key=invidunt
    • User-provided metadata, in key/value pairs.
    • the value will be associated with the given key
  • metageneration=invidunt
    • 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.
  • name=dolores
    • The name of the object. Required if not specified by URL parameter.
  • owner entity=diam
    • The entity, in the form user-userId.

  • entity-id=sanctus

    • The ID for the entity.

  • ..retention mode=sed

    • The bucket's object retention mode, can only be Unlocked or Locked.

  • retain-until-time=eos

    • A time in RFC 3339 format until which object retention protects this object.

  • .. retention-expiration-time=sit

    • 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).
  • self-link=et
    • The link to this object.
  • size=ea
    • Content-Length of the data in bytes.
  • soft-delete-time=dolor
    • The time at which the object became soft-deleted in RFC 3339 format.
  • storage-class=sadipscing
    • Storage class of the object.
  • temporary-hold=false
    • 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.
  • time-created=at
    • The creation time of the object in RFC 3339 format.
  • time-deleted=at
    • The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
  • time-storage-class-updated=kasd
    • The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
  • updated=magna
    • 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.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p destination-kms-key-name=string

    • 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.

  • -p destination-predefined-acl=string

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

  • -p if-generation-match=string

    • 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.

  • -p if-generation-not-match=string

    • 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.

  • -p if-metageneration-match=string

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

  • -p if-metageneration-not-match=string

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

  • -p if-source-generation-match=string

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

  • -p if-source-generation-not-match=string

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

  • -p if-source-metageneration-match=string

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

  • -p if-source-metageneration-not-match=string

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

  • -p max-bytes-rewritten-per-call=string

    • 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.

  • -p projection=string

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

  • -p rewrite-token=string

    • 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.

  • -p source-generation=string

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

  • -p user-project=string

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

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • 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.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

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

  • -p upload-type=string

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

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.