java.lang.Object
- software.amazon.awssdk.transfer.s3.model.ResumableFileDownload

All Implemented Interfaces:

ResumableTransfer, ToCopyableBuilder<ResumableFileDownload.Builder,ResumableFileDownload>
```
public final class ResumableFileDownload
extends Object
implements ResumableTransfer, ToCopyableBuilder<ResumableFileDownload.Builder,ResumableFileDownload>
```
An opaque token that holds the state and can be used to resume a paused download operation.
Serialization: When serializing this token, the following structures will not be preserved/persisted:
- TransferRequestOverrideConfiguration
- AwsRequestOverrideConfiguration (from GetObjectRequest)
See Also:

S3TransferManager.downloadFile(DownloadFileRequest)

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ResumableFileDownload.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ResumableFileDownload.Builder`	`builder()`
`long`	`bytesTransferred()`	Retrieve the number of bytes that have been transferred.
`List<Integer>`	`completedParts()`	The lists of parts that were successfully completed and saved to the file.
`DownloadFileRequest`	`downloadFileRequest()`
`boolean`	`equals(Object o)`
`Instant`	`fileLastModified()`	Last modified time of the file since last pause
`static ResumableFileDownload`	`fromBytes(SdkBytes bytes)`	Deserialize bytes with JSON data into a `ResumableFileDownload`.
`static ResumableFileDownload`	`fromFile(Path path)`	Deserialize data at the given path into a `ResumableFileDownload`.
`static ResumableFileDownload`	`fromString(String contents)`	Deserialize a string with JSON data into a `ResumableFileDownload`.
`int`	`hashCode()`
`Optional<String>`	`s3ObjectEtag()`	Etag of the S3 object since last pause, or `Optional.empty()` if unknown
`Optional<Instant>`	`s3ObjectLastModified()`	Last modified time of the S3 object since last pause, or `Optional.empty()` if unknown
`SdkBytes`	`serializeToBytes()`	Returns the serialized JSON data representing this object as an `SdkBytes` object.
`void`	`serializeToFile(Path path)`	Persists this download object to a file in Base64-encoded JSON format.
`InputStream`	`serializeToInputStream()`	Returns the serialized JSON data representing this object as an `InputStream`.
`void`	`serializeToOutputStream(OutputStream outputStream)`	Writes the serialized JSON data representing this object to an output stream.
`String`	`serializeToString()`	Returns the serialized JSON data representing this object as a string.
`ResumableFileDownload.Builder`	`toBuilder()`
`String`	`toString()`
`OptionalLong`	`totalSizeInBytes()`	The total size of the transfer in bytes or `OptionalLong.empty()` if unknown

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - builder
```
public static ResumableFileDownload.Builder builder()
```
  - downloadFileRequest
```
public DownloadFileRequest downloadFileRequest()
```
    Returns:
    
    the DownloadFileRequest to resume
  - bytesTransferred
```
public long bytesTransferred()
```
    Retrieve the number of bytes that have been transferred.
    
    Returns:
    
    the number of bytes
  - s3ObjectLastModified
```
public Optional<Instant> s3ObjectLastModified()
```
    Last modified time of the S3 object since last pause, or Optional.empty() if unknown
  - s3ObjectEtag
```
public Optional<String> s3ObjectEtag()
```
    Etag of the S3 object since last pause, or Optional.empty() if unknown
  - fileLastModified
```
public Instant fileLastModified()
```
    Last modified time of the file since last pause
  - totalSizeInBytes
```
public OptionalLong totalSizeInBytes()
```
    The total size of the transfer in bytes or OptionalLong.empty() if unknown
    
    Returns:
    
    the optional total size of the transfer.
  - completedParts
```
public List<Integer> completedParts()
```
    The lists of parts that were successfully completed and saved to the file. Non-empty only for multipart downloads.
    
    Returns:
    
    part numbers of a multipart download that were completed saved to file.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - serializeToFile
```
public void serializeToFile(Path path)
```
    Persists this download object to a file in Base64-encoded JSON format.
    
    Specified by:
    
    serializeToFile in interface ResumableTransfer
    
    Parameters:
    
    path - The path to the file to which you want to write the serialized download object.
  - serializeToOutputStream
```
public void serializeToOutputStream(OutputStream outputStream)
```
    Writes the serialized JSON data representing this object to an output stream. Note that the OutputStream is not closed or flushed after writing.
    
    Specified by:
    
    serializeToOutputStream in interface ResumableTransfer
    
    Parameters:
    
    outputStream - The output stream to write the serialized object to.
  - serializeToString
```
public String serializeToString()
```
    Returns the serialized JSON data representing this object as a string.
    
    Specified by:
    
    serializeToString in interface ResumableTransfer
  - serializeToBytes
```
public SdkBytes serializeToBytes()
```
    Returns the serialized JSON data representing this object as an SdkBytes object.
    
    Specified by:
    
    serializeToBytes in interface ResumableTransfer
    
    Returns:
    
    the serialized JSON as SdkBytes
  - serializeToInputStream
```
public InputStream serializeToInputStream()
```
    Returns the serialized JSON data representing this object as an InputStream.
    
    Specified by:
    
    serializeToInputStream in interface ResumableTransfer
    
    Returns:
    
    the serialized JSON input stream
  - fromFile
```
public static ResumableFileDownload fromFile(Path path)
```
    Deserialize data at the given path into a ResumableFileDownload.
    
    Parameters:
    
    path - The Path to the file with serialized data
    
    Returns:
    
    the deserialized ResumableFileDownload
  - fromBytes
```
public static ResumableFileDownload fromBytes(SdkBytes bytes)
```
    Deserialize bytes with JSON data into a ResumableFileDownload.
    
    Parameters:
    
    bytes - the serialized data
    
    Returns:
    
    the deserialized ResumableFileDownload
  - fromString
```
public static ResumableFileDownload fromString(String contents)
```
    Deserialize a string with JSON data into a ResumableFileDownload.
    
    Parameters:
    
    contents - the serialized data
    
    Returns:
    
    the deserialized ResumableFileDownload
  - toBuilder
```
public ResumableFileDownload.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ResumableFileDownload.Builder,ResumableFileDownload>

Class ResumableFileDownload

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

equals

hashCode

builder

downloadFileRequest

bytesTransferred

s3ObjectLastModified

s3ObjectEtag

fileLastModified

totalSizeInBytes

completedParts

toString

serializeToFile

serializeToOutputStream

serializeToString

serializeToBytes

serializeToInputStream

fromFile

fromBytes

fromString

toBuilder