Class CrtFileDownload

java.lang.Object

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

All Implemented Interfaces:

FileDownload, ObjectTransfer, Transfer

@SdkInternalApi
public final class CrtFileDownload
extends Object
implements FileDownload

A FileDownload for a download whose response body is written to the destination file by CRT rather than by an AsyncResponseTransformer.

Because the response body never passes through the SDK, the response headers are not surfaced until the transfer finishes, so the ETag and last-modified time needed to resume the download cannot be read from the progress snapshot the way DefaultFileDownload reads them. They are instead taken from the ResumeToken that CRT hands back when the meta request is paused.

Constructor Summary

Constructors

Constructor	Description
CrtFileDownload(CompletableFuture<CompletedFileDownload> completionFuture, TransferProgress progress, S3MetaRequestPauseObservable observable, Supplier<DownloadFileRequest> requestSupplier, ResumableFileDownload resumedDownload)

Method Summary

Modifier and Type	Method	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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CrtFileDownload

public CrtFileDownload(CompletableFuture<CompletedFileDownload> completionFuture,
 TransferProgress progress,
 S3MetaRequestPauseObservable observable,
 Supplier<DownloadFileRequest> requestSupplier,
 ResumableFileDownload resumedDownload)

Method Details

progress

public TransferProgress progress()

Description copied from interface: ObjectTransfer

The stateful TransferProgress associated with this transfer.

Specified by:

progress in interface ObjectTransfer

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.

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.

Pause may block the caller for a short time until in-progress requests are canceled and cleaned up to ensure a consistent state.

Specified by:

pause in interface FileDownload

Returns:

A ResumableFileDownload that can be used to resume the download.

toString

public String toString()

Overrides:

toString in class Object