Interface TransferProgress
-
- All Known Implementing Classes:
DefaultTransferProgress
,ResumeTransferProgress
@Mutable @ThreadSafe public interface TransferProgress
TransferProgress
is a stateful representation of the progress of a transfer initiated byS3TransferManager
.TransferProgress
offers the ability to take asnapshot()
of the current progress, represented by an immutableTransferProgressSnapshot
, which contains helpful progress-related methods likeTransferProgressSnapshot.transferredBytes()
andTransferProgressSnapshot.ratioTransferred()
.TransferProgress
is attached toObjectTransfer
objects, namelyUpload
,Download
, andCopy
.Where possible, it is typically recommended to avoid directly querying
TransferProgress
and to instead leverage theTransferListener
interface to receive event-driven updates of the latestTransferProgressSnapshot
. See theTransferListener
documentation for usage instructions. However, if desired,TransferProgress
can be used for poll-like checking of the current progress. E.g.,Upload upload = tm.upload(...); while (!upload.completionFuture().isDone()) { upload.progress().snapshot().ratioTransferred().ifPresent(System.out::println); Thread.sleep(1000); }
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TransferProgressSnapshot
snapshot()
Takes a snapshot of the current progress, represented by an immutableTransferProgressSnapshot
.
-
-
-
Method Detail
-
snapshot
TransferProgressSnapshot snapshot()
Takes a snapshot of the current progress, represented by an immutableTransferProgressSnapshot
.
-
-