ResumableFileUpload (AWS Java SDK :: S3 :: Transfer Manager 2.20.103 API)

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

All Implemented Interfaces:

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

S3TransferManager.uploadFile(UploadFileRequest), S3TransferManager.resumeUploadFile(ResumableFileUpload)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ResumableFileUpload.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ResumableFileUpload.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ResumableFileUpload.Builder`	`builder()`
`boolean`	`equals(Object o)`
`Instant`	`fileLastModified()` Last modified time of the file since last pause
`long`	`fileLength()` File length since last pause
`static ResumableFileUpload`	`fromBytes(SdkBytes bytes)` Deserializes bytes with JSON data into a `ResumableFileUpload`.
`static ResumableFileUpload`	`fromFile(Path path)` Deserializes data at the given path into a `ResumableFileUpload`.
`static ResumableFileUpload`	`fromString(String contents)` Deserializes a string with JSON data into a `ResumableFileUpload`.
`int`	`hashCode()`
`Optional<String>`	`multipartUploadId()` The multipart upload ID, or `Optional.empty()` if unknown
`OptionalLong`	`partSizeInBytes()` Return the part size in bytes or `OptionalLong.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.
`ResumableFileUpload.Builder`	`toBuilder()`
`String`	`toString()`
`OptionalLong`	`totalParts()` Return the total number of parts associated with this transfer or `OptionalLong.empty()` if unknown
`OptionalLong`	`transferredParts()` Return the total number of parts completed with this transfer or `OptionalLong.empty()` if unknown
`UploadFileRequest`	`uploadFileRequest()`

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 ResumableFileUpload.Builder builder()
```
  - uploadFileRequest
```
public UploadFileRequest uploadFileRequest()
```
    Returns:
    
    the UploadFileRequest to resume
  - fileLastModified
```
public Instant fileLastModified()
```
    Last modified time of the file since last pause
  - fileLength
```
public long fileLength()
```
    File length since last pause
  - partSizeInBytes
```
public OptionalLong partSizeInBytes()
```
    Return the part size in bytes or OptionalLong.empty() if unknown
  - totalParts
```
public OptionalLong totalParts()
```
    Return the total number of parts associated with this transfer or OptionalLong.empty() if unknown
  - multipartUploadId
```
public Optional<String> multipartUploadId()
```
    The multipart upload ID, or Optional.empty() if unknown
    
    Returns:
    
    the optional total size of the transfer.
  - transferredParts
```
public OptionalLong transferredParts()
```
    Return the total number of parts completed with this transfer or OptionalLong.empty() if unknown
  - serializeToFile
```
public void serializeToFile(Path path)
```
    Description copied from interface: ResumableTransfer
    
    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)
```
    Description copied from interface: ResumableTransfer
    
    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()
```
    Description copied from interface: ResumableTransfer
    
    Returns the serialized JSON data representing this object as a string.
    
    Specified by:
    
    serializeToString in interface ResumableTransfer
  - serializeToBytes
```
public SdkBytes serializeToBytes()
```
    Description copied from interface: ResumableTransfer
    
    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()
```
    Description copied from interface: ResumableTransfer
    
    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 ResumableFileUpload fromFile(Path path)
```
    Deserializes data at the given path into a ResumableFileUpload.
    
    Parameters:
    
    path - The Path to the file with serialized data
    
    Returns:
    
    the deserialized ResumableFileUpload
  - fromBytes
```
public static ResumableFileUpload fromBytes(SdkBytes bytes)
```
    Deserializes bytes with JSON data into a ResumableFileUpload.
    
    Parameters:
    
    bytes - the serialized data
    
    Returns:
    
    the deserialized ResumableFileUpload
  - fromString
```
public static ResumableFileUpload fromString(String contents)
```
    Deserializes a string with JSON data into a ResumableFileUpload.
    
    Parameters:
    
    contents - the serialized data
    
    Returns:
    
    the deserialized ResumableFileUpload
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toBuilder
```
public ResumableFileUpload.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ResumableFileUpload.Builder,ResumableFileUpload>

Class ResumableFileUpload

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

uploadFileRequest

fileLastModified

fileLength

partSizeInBytes

totalParts

multipartUploadId

transferredParts

serializeToFile

serializeToOutputStream

serializeToString

serializeToBytes

serializeToInputStream

fromFile

fromBytes

fromString

toString

toBuilder