software.amazon.awssdk.transfer.s3.internal.model

Class DefaultFileDownload

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.model.DefaultFileDownload

All Implemented Interfaces:

FileDownload, ObjectTransfer, Transfer

public final class DefaultFileDownload
extends Object
implements FileDownload

Constructor Summary

Constructors

Constructor and Description
DefaultFileDownload(CompletableFuture<CompletedFileDownload> completedFileDownloadFuture, TransferProgress progress, Supplier<DownloadFileRequest> requestSupplier, ResumableFileDownload resumedDownload)

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.
TransferProgress	progress() The stateful TransferProgress associated with this transfer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFileDownload

public DefaultFileDownload(CompletableFuture<CompletedFileDownload> completedFileDownloadFuture,
                           TransferProgress progress,
                           Supplier<DownloadFileRequest> requestSupplier,
                           ResumableFileDownload resumedDownload)

Method Detail

progress

public TransferProgress progress()

Description copied from interface: ObjectTransfer

The stateful TransferProgress associated with this transfer.

Specified by:

progress in interface ObjectTransfer

pause

public ResumableFileDownload pause()

Description copied from interface: FileDownload

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.

Specified by:

pause in interface FileDownload

Returns:

A ResumableFileDownload that can be used to resume the download.

completionFuture

public CompletableFuture<CompletedFileDownload> completionFuture()

Specified by:

completionFuture in interface FileDownload

Specified by:

completionFuture in interface Transfer

Returns:

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

toString

public String toString()

Overrides:

toString in class Object