com.ibm.cloud.objectstorage.services.s3.transfer

Interface Copy

All Superinterfaces:

Transfer

All Known Implementing Classes:

CopyImpl

public interface Copy
extends Transfer

Represents an asynchronous copy request from one Amazon S3 location another.

See TransferManager for more information about creating transfers.

Please note that when copying data between s3 buckets there is no progress updates whilst data is in transit. This means that the TransferProgress.getBytesTransferred() will not be accurate until the copy is complete.

See Also:

TransferManager.copy(String, String, String, String), TransferManager.copy(com.ibm.cloud.objectstorage.services.s3.model.CopyObjectRequest)

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.services.s3.transfer.Transfer

Transfer.TransferState

Method Summary

Modifier and Type	Method and Description
CopyResult	waitForCopyResult() Waits for the copy request to complete and returns the result of this request.

Methods inherited from interface com.ibm.cloud.objectstorage.services.s3.transfer.Transfer

addProgressListener, addProgressListener, getDescription, getProgress, getState, isDone, removeProgressListener, removeProgressListener, waitForCompletion, waitForException

Method Detail

waitForCopyResult

CopyResult waitForCopyResult()
                      throws AmazonClientException,
                             AmazonServiceException,
                             InterruptedException

Waits for the copy request to complete and returns the result of this request. Be prepared to handle errors when calling this method. Any errors that occurred during the asynchronous transfer will be re-thrown through this method.

Returns:

The result of this transfer.

Throws:

AmazonClientException - If any errors were encountered in the client while making the request or handling the response.

AmazonServiceException - If any errors occurred in Amazon S3 while processing the request.

InterruptedException - If this thread is interrupted while waiting for the upload to complete.