Class DefaultTransferProgressSnapshot

java.lang.Object

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

All Implemented Interfaces:

TransferProgressSnapshot, ToCopyableBuilder<DefaultTransferProgressSnapshot.Builder,DefaultTransferProgressSnapshot>

@SdkInternalApi
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	Description
static final class	DefaultTransferProgressSnapshot.Builder

Method Summary

Modifier and Type	Method	Description
static DefaultTransferProgressSnapshot.Builder	builder()
boolean	equals(Object o)
int	hashCode()
OptionalDouble	ratioTransferred()	The ratio of the TransferProgressSnapshot.totalBytes() that has been transferred so far, or Optional.empty() if unknown.
OptionalLong	remainingBytes()	The total number of bytes that are remaining to be transferred, or Optional.empty() if unknown.
Optional<SdkResponse>	sdkResponse()	The SDK response, or Optional.empty() if unknown.
DefaultTransferProgressSnapshot.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
OptionalLong	totalBytes()	The total size of the transfer, in bytes, or Optional.empty() if unknown.
long	transferredBytes()	The total number of bytes that have been transferred so far.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

builder

public static DefaultTransferProgressSnapshot.Builder builder()

toBuilder

public DefaultTransferProgressSnapshot.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultTransferProgressSnapshot.Builder,DefaultTransferProgressSnapshot>

Returns:

a builder for type T

transferredBytes

public long transferredBytes()

Description copied from interface: TransferProgressSnapshot

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

Specified by:

transferredBytes in interface TransferProgressSnapshot

totalBytes

public OptionalLong totalBytes()

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:

totalBytes in interface TransferProgressSnapshot

sdkResponse

public Optional<SdkResponse> sdkResponse()

Description copied from interface: TransferProgressSnapshot

The SDK response, or Optional.empty() if unknown.

In the case of Download, the response is GetObjectResponse, and the response is known before it starts streaming. In the case of Upload, the response is PutObjectResponse, and the response is not known until streaming finishes.

Specified by:

sdkResponse in interface TransferProgressSnapshot

ratioTransferred

public OptionalDouble ratioTransferred()

Description copied from interface: TransferProgressSnapshot

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

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

Specified by:

ratioTransferred in interface TransferProgressSnapshot

See Also:

• TransferProgressSnapshot.totalBytes()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

remainingBytes

public OptionalLong remainingBytes()

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.totalBytes() being known in order to return non-empty.

Specified by:

remainingBytes in interface TransferProgressSnapshot

See Also:

• TransferProgressSnapshot.totalBytes()

toString

public String toString()

Overrides:

toString in class Object