Class ObjectRewriter (2.20.0)

Version 2.20.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Complete long running object rewrite operations.

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.

Constructors

ObjectRewriter(std::shared_ptr< internal::StorageConnection >, internal::RewriteObjectRequest)

Parameters
Name	Description
connection	std::shared_ptr< internal::StorageConnection >
request	internal::RewriteObjectRequest

Functions

Iterate()

Perform one iteration in the rewrite.

Returns
Type	Description
StatusOr< RewriteProgress >	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.

Note: This operation blocks until the copy is finished. For very large objects that could take substantial time. Applications may need to persist the rewrite operation. Some applications may want to wrap this call with std::async, and run the copy on a separate thread.

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.

Note: This operation blocks until the copy is finished. For very large objects that could take substantial time. Applications may need to persist the rewrite operation. Some applications may want to wrap this call with std::async, and run the copy on a separate thread.

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.

Note: For rewrites that have not started the token is an empty string. For rewrites that have completed the token is also an empty string. The application should preserve other information (such as the RewriteProgress) to avoid repeating a rewrite.

Returns
Type	Description
std::string const &