com.ibm.cos.v2.transfer.s3.model

Interface FileDownload

All Superinterfaces:

ObjectTransfer, Transfer

All Known Implementing Classes:

DefaultFileDownload

@ThreadSafe
public interface FileDownload
extends ObjectTransfer

A download transfer of a single object from S3.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<CompletedFileDownload>	completionFuture()
ResumableFileDownload	pause() Pause the current download operation and returns the information that can be used to resume the download at a later time.

Methods inherited from interface com.ibm.cos.v2.transfer.s3.model.ObjectTransfer

progress

Method Detail

pause

ResumableFileDownload pause()

Pause the current download operation and returns the information that can be used to resume the download at a later time.

The information object is serializable for persistent storage until it should be resumed. See ResumableFileDownload for supported formats.

Returns:

A ResumableFileDownload that can be used to resume the download.

completionFuture

CompletableFuture<CompletedFileDownload> completionFuture()

Specified by:

completionFuture in interface Transfer

Returns:

The future that will be completed when this transfer is complete.