The Client::RewriteObject() operation allows applications to copy objects across location boundaries, and to rewrite objects with different encryption keys. In some circumstances it may take multiple calls to the service to complete a rewrite, this class encapsulates the state of a partial copy.
The progress after the iteration. If the rewrite has completed the application can use Result() to examine the metadata for the newly created object.
CurrentProgress() const
The current progress on the rewrite operation.
Returns
Type
Description
StatusOr< RewriteProgress >
Result()
Iterate until the operation completes using a callback to report progress.
Returns
Type
Description
StatusOr< ObjectMetadata >
the object metadata once the copy completes.
ResultWithProgressCallback(Functor)
Iterate until the operation completes using a callback to report progress.
Parameters
Name
Description
cb
Functor
the callback object.
typename Functor
the type of the callback object. It must satisfy: std:is_invocable<Functor,StatusOr<RewriteProgress>>:: value == true.
std::enable_if_t<>< functor,="">
Returns
Type
Description
StatusOr< ObjectMetadata >
the object metadata once the copy completes.
token() const
The current rewrite token.
Applications can save the token of partially completed rewrites, and restart those operations using Client::CopyObjectRestart, even if the application has terminated. It is up to the application to preserve all the other information for the request, including source and destination buckets, encryption keys, and any preconditions affecting the request.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-22 UTC."],[[["The webpage details the `ObjectRewriter` class, which manages long-running object rewrite operations in Google Cloud Storage, including copying objects across locations and changing encryption keys."],["The `ObjectRewriter` supports iterative progress, allowing for partial copy operations that can be checked with the `Iterate()` and `CurrentProgress()` methods."],["The `Result()` function will complete the copy and give back the resulting `ObjectMetadata` when successful, while blocking the current thread until completion, which could be significant for larger objects."],["A callback mechanism, `ResultWithProgressCallback(Functor)`, is available to report progress on the rewrite operation, and users can save and restart partial operations using the `token() const` function."],["The page lists all previous versions from 2.11.0 all the way up to the latest version (2.37.0-rc) as links to the respective page for each specific version, and the current page focuses on version 2.31.0."]]],[]]
