com.qcloud.cos.transfer

接口 Upload

所有超级接口:

Transfer

所有已知实现类:

UploadImpl

public interface Upload
extends Transfer

Represents an asynchronous upload to Qcloud COS.

See TransferManager for more information about creating transfers.

另请参阅:

TransferManager.upload(String, String, java.io.File), TransferManager.upload(com.qcloud.cos.model.PutObjectRequest)

嵌套类概要

从接口继承的嵌套类/接口 com.qcloud.cos.transfer.Transfer

Transfer.TransferState

方法概要

限定符和类型	方法和说明
void	abort() Abort the current upload operation.
PersistableUpload	getResumeableMultipartUploadId() if isResumeableMultipartUploadAfterFailed is true, we can call getResumeableMultipartUploadId to get upload info. then can resume to upload again..
boolean	isResumeableMultipartUploadAfterFailed() if multipart upload failed, whether we can upload again. if true, you can call getResumeableMultipartUploadId to get upload info. then can resume to upload again..
PersistableUpload	pause() Pause the current upload operation and returns the information that can be used to resume the upload.
PauseResult<PersistableUpload>	tryPause(boolean forceCancelTransfers) Tries to pause the current upload operation and returns the information that can be used to resume the upload.
UploadResult	waitForUploadResult() Waits for this upload to complete and returns the result of this upload.

从接口继承的方法 com.qcloud.cos.transfer.Transfer

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

方法详细资料

waitForUploadResult

UploadResult waitForUploadResult()
                          throws CosClientException,
                                 CosServiceException,
                                 InterruptedException

Waits for this upload to complete and returns the result of this upload. This is a blocking call. Be prepared to handle errors when calling this method. Any errors that occurred during the asynchronous transfer will be re-thrown through this method.

返回:

The result of this transfer.

抛出:

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

CosServiceException - If any errors occurred in Qcloud COS while processing the request.

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

pause

PersistableUpload pause()
                 throws PauseException

Pause the current upload operation and returns the information that can be used to resume the upload. Upload cannot be paused in the following cases.

• The data source is an input stream.
• Client side encryption is used.
• Server Side Encryption with customer provided key is used.
• Size of the file being uploaded is less than the TransferManagerConfiguration.getMultipartUploadThreshold().

In such cases, aborts the uploads and a PauseFailure exception is thrown

返回:

An opaque token that holds some private state and can be used to resume a paused download operation.

抛出:

PauseException - If failed to pause the operation.

tryPause

PauseResult<PersistableUpload> tryPause(boolean forceCancelTransfers)

Tries to pause the current upload operation and returns the information that can be used to resume the upload. Upload cannot be paused in the following cases.

• The data source is an input stream.
• Client side encryption is used.
• Server Side Encryption with customer provided key is used.
• Size of the file being uploaded is less than the TransferManagerConfiguration.getMultipartUploadThreshold().

In such cases, aborts the uploads if forceCancelTransfers is set else No action is taken.

参数:

forceCancelTransfers - a boolean to forcefully abort the existing uploads if pause cannot be done.

返回:

a result of pause operation.

abort

void abort()

Abort the current upload operation.

isResumeableMultipartUploadAfterFailed

boolean isResumeableMultipartUploadAfterFailed()

if multipart upload failed, whether we can upload again. if true, you can call getResumeableMultipartUploadId to get upload info. then can resume to upload again..

getResumeableMultipartUploadId

PersistableUpload getResumeableMultipartUploadId()

if isResumeableMultipartUploadAfterFailed is true, we can call getResumeableMultipartUploadId to get upload info. then can resume to upload again..

返回:

the PersistableUpload info if you can upload again, otherwise return null;