Interface FileDownload

All Superinterfaces:
ObjectTransfer, Transfer
All Known Implementing Classes:
CrtFileDownload, DefaultFileDownload
@SdkPublicApi @ThreadSafe public interface FileDownload extends ObjectTransfer
A download transfer of a single object from S3.

  • Method Details

    • 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.

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

      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.