software.amazon.awssdk.transfer.s3.internal.progress

Class DefaultTransferProgressSnapshot

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.progress.DefaultTransferProgressSnapshot

All Implemented Interfaces:

TransferProgressSnapshot, ToCopyableBuilder<DefaultTransferProgressSnapshot.Builder,DefaultTransferProgressSnapshot>

public final class DefaultTransferProgressSnapshot
extends Object
implements ToCopyableBuilder<DefaultTransferProgressSnapshot.Builder,DefaultTransferProgressSnapshot>, TransferProgressSnapshot

An SDK-internal implementation of TransferProgressSnapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultTransferProgressSnapshot.Builder

Method Summary

Modifier and Type	Method and Description
static DefaultTransferProgressSnapshot.Builder	builder()
Optional<Long>	bytesRemaining() The total number of bytes that are remaining to be transferred, or Optional.empty() if unknown.
long	bytesTransferred() The total number of bytes that have been transferred so far.
Optional<Double>	ratioTransferred() The ratio of the TransferProgressSnapshot.transferSizeInBytes() that has been transferred so far, or Optional.empty() if unknown.
DefaultTransferProgressSnapshot.Builder	toBuilder()
String	toString()
Optional<Long>	transferSizeInBytes() The total size of the transfer, in bytes, or Optional.empty() if unknown.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

builder

public static DefaultTransferProgressSnapshot.Builder builder()

toBuilder

public DefaultTransferProgressSnapshot.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultTransferProgressSnapshot.Builder,DefaultTransferProgressSnapshot>

bytesTransferred

public long bytesTransferred()

Description copied from interface: TransferProgressSnapshot

The total number of bytes that have been transferred so far.

Specified by:

bytesTransferred in interface TransferProgressSnapshot

transferSizeInBytes

public Optional<Long> transferSizeInBytes()

Description copied from interface: TransferProgressSnapshot

The total size of the transfer, in bytes, or Optional.empty() if unknown.

In the case of file-based FileUploads, transfer sizes are known up front and immediately available. In the case of Downloads, the transfer size is not known until S3TransferManager receives a GetObjectResponse from Amazon S3.

Specified by:

transferSizeInBytes in interface TransferProgressSnapshot

ratioTransferred

public Optional<Double> ratioTransferred()

Description copied from interface: TransferProgressSnapshot

The ratio of the TransferProgressSnapshot.transferSizeInBytes() that has been transferred so far, or Optional.empty() if unknown. This method depends on the TransferProgressSnapshot.transferSizeInBytes() being known in order to return non-empty.

Ratio is computed as TransferProgressSnapshot.bytesTransferred() / TransferProgressSnapshot.transferSizeInBytes(), where a transfer that is half-complete would return 0.5.

Specified by:

ratioTransferred in interface TransferProgressSnapshot

See Also:

TransferProgressSnapshot.transferSizeInBytes()

bytesRemaining

public Optional<Long> bytesRemaining()

Description copied from interface: TransferProgressSnapshot

The total number of bytes that are remaining to be transferred, or Optional.empty() if unknown. This method depends on the TransferProgressSnapshot.transferSizeInBytes() being known in order to return non-empty.

Specified by:

bytesRemaining in interface TransferProgressSnapshot

See Also:

TransferProgressSnapshot.transferSizeInBytes()

toString

public String toString()

Overrides:

toString in class Object