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 `ObjectRewriter` class facilitates the completion of long-running object rewrite operations, such as copying objects across locations or changing encryption keys."],["The `Iterate()` function performs a single step in the rewrite process, returning the `RewriteProgress` after the iteration, while also giving the option to use the `Result()` method to examine the metadata once the rewrite completes."],["`Result()` and `ResultWithProgressCallback(Functor)` both complete the rewrite operation, but the latter allows for a custom callback function to track progress."],["The `token()` function allows applications to save and resume partially completed rewrites using `Client::CopyObjectRestart`, requiring the preservation of other relevant request details, and also not having a token if the rewrite has not started or if it is complete."],["There are multiple versions of the `ObjectRewriter` class, ranging from version 2.11.0 up to 2.37.0-rc (latest), allowing for multiple versions of the application to reference different versions of the class."]]],[]]
