com.google.cloud.storage

Class CopyWriter

java.lang.Object

com.google.cloud.storage.CopyWriter

All Implemented Interfaces:

Restorable<CopyWriter>

public class CopyWriter
extends Object
implements Restorable<CopyWriter>

Google Storage blob copy writer. A CopyWriter object allows to copy both blob's data and information. To override source blob's information supply a BlobInfo to the CopyRequest using either Storage.CopyRequest.Builder.target(BlobInfo, Storage.BlobTargetOption...) or Storage.CopyRequest.Builder.target(BlobInfo, Iterable).

This class holds the result of a copy request. If source and destination blobs share the same location and storage class the copy is completed in one RPC call otherwise one or more copyChunk() calls are necessary to complete the copy. In addition, result() can be used to automatically complete the copy and return information on the newly created blob.

See Also:

Rewrite

Method Summary

Methods

Modifier and Type	Method and Description
long	blobSize() Returns the size of the blob being copied.
RestorableState<CopyWriter>	capture()
void	copyChunk() Copies the next chunk of the blob.
boolean	isDone() Returns true if blob copy has finished, false otherwise.
Blob	result() Returns the updated information for the written blob.
long	totalBytesCopied() Returns the number of bytes copied.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

result

public Blob result()

Returns the updated information for the written blob. Calling this method when isDone() is false will block until all pending chunks are copied.

This method has the same effect of doing:

 while (!copyWriter.isDone()) {
    copyWriter.copyChunk();
 }
 

Throws:

StorageException - upon failure

blobSize

public long blobSize()

Returns the size of the blob being copied.

isDone

public boolean isDone()

Returns true if blob copy has finished, false otherwise.

totalBytesCopied

public long totalBytesCopied()

Returns the number of bytes copied.

copyChunk

public void copyChunk()

Copies the next chunk of the blob. An RPC is issued only if copy has not finished yet (isDone() returns false).

Throws:

StorageException - upon failure

capture

public RestorableState<CopyWriter> capture()

Specified by:

capture in interface Restorable<CopyWriter>