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.setTarget(BlobInfo, Storage.BlobTargetOption...) or Storage.CopyRequest.Builder.setTarget(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, getResult() can be used to automatically complete the copy and return information on the newly created blob.

See Also:

Rewrite

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

getResult

public Blob getResult()

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

getBlobSize

public long getBlobSize()

Returns the size of the blob being copied.

isDone

public boolean isDone()

Returns true if blob copy has finished, false otherwise.

getTotalBytesCopied

public long getTotalBytesCopied()

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()

Description copied from interface: Restorable

Captures the state of this object.

Specified by:

capture in interface Restorable<CopyWriter>

Returns:

a RestorableState instance that contains the state for this object and can restore it afterwards.