Package software.amazon.awssdk.crt.s3
Class ResumeToken
- java.lang.Object
-
- software.amazon.awssdk.crt.s3.ResumeToken
-
public class ResumeToken extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classResumeToken.PutResumeTokenBuilder
-
Constructor Summary
Constructors Constructor Description ResumeToken(ResumeToken.PutResumeTokenBuilder builder)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description longgetContinuesDownloadedBytes()Number of bytes downloaded continuously from the start of the range, with no gaps.StringgetEtag()ETag of the S3 object being downloaded, captured from the first response.longgetFileLastModifiedEpochNs()Last-modified time of the local receive file (nanoseconds since the Unix epoch), captured after the file handle was closed during the pause.longgetNumPartsCompleted()longgetObjectRangeEnd()Absolute byte offset in the object where the download's range ends (inclusive).longgetObjectRangeStart()Absolute byte offset in the object where the download's range starts.longgetObjectSize()Total size of the S3 object being downloaded, regardless of any Range header on the request (for a ranged download this is larger than the range being fetched).longgetPartSize()StringgetS3ObjectLastModified()Last-Modified of the S3 object being downloaded, in HTTP-date format (RFC 9110 5.6.7, "Wed, 09 Oct 2024 22:28:00 GMT"), captured from the first response.longgetTotalDownloadedBytes()Total number of bytes downloaded before the pause.longgetTotalNumParts()S3MetaRequestOptions.MetaRequestTypegetType()StringgetUploadId()StringgetVersionId()Version ID of the S3 object being downloaded.
-
-
-
Constructor Detail
-
ResumeToken
public ResumeToken(ResumeToken.PutResumeTokenBuilder builder)
-
-
Method Detail
-
getType
public S3MetaRequestOptions.MetaRequestType getType()
- Returns:
- type of resume token
-
getPartSize
public long getPartSize()
- Returns:
- part size
-
getTotalNumParts
public long getTotalNumParts()
- Returns:
- total number of parts
-
getNumPartsCompleted
public long getNumPartsCompleted()
- Returns:
- number of parts completed
-
getUploadId
public String getUploadId()
- Returns:
- upload Id
-
getEtag
public String getEtag()
ETag of the S3 object being downloaded, captured from the first response. May be null/empty if the download was paused before the first response arrived.- Returns:
- etag of the object
-
getVersionId
public String getVersionId()
Version ID of the S3 object being downloaded. Optional: null/empty when the bucket is unversioned or the version id was not captured.- Returns:
- version id of the object
-
getS3ObjectLastModified
public String getS3ObjectLastModified()
Last-Modified of the S3 object being downloaded, in HTTP-date format (RFC 9110 5.6.7, "Wed, 09 Oct 2024 22:28:00 GMT"), captured from the first response. The exact string in the response header. Optional: null/empty if the value was not captured before the pause.- Returns:
- Last-Modified of the object as an HTTP-date string
-
getObjectSize
public long getObjectSize()
Total size of the S3 object being downloaded, regardless of any Range header on the request (for a ranged download this is larger than the range being fetched). 0 if the download was paused before the object size was discovered.- Returns:
- total object size in bytes
-
getObjectRangeStart
public long getObjectRangeStart()
Absolute byte offset in the object where the download's range starts. 0 for a download without a Range header.- Returns:
- range start offset in bytes
-
getObjectRangeEnd
public long getObjectRangeEnd()
Absolute byte offset in the object where the download's range ends (inclusive). For a download without a Range header this is object size - 1. 0 if the download was paused before the object size was discovered.- Returns:
- range end offset in bytes (inclusive)
-
getContinuesDownloadedBytes
public long getContinuesDownloadedBytes()
Number of bytes downloaded continuously from the start of the range, with no gaps. Everything before this offset (relative to the object range start) has been downloaded.- Returns:
- continuously downloaded bytes
-
getTotalDownloadedBytes
public long getTotalDownloadedBytes()
Total number of bytes downloaded before the pause. May be greater thangetContinuesDownloadedBytes()when parts completed out of order, leaving gaps. Equals it when delivery was strictly in order.- Returns:
- total downloaded bytes
-
getFileLastModifiedEpochNs
public long getFileLastModifiedEpochNs()
Last-modified time of the local receive file (nanoseconds since the Unix epoch), captured after the file handle was closed during the pause. Only set when the download was writing to a file; 0 for downloads that deliver via body callback or when the timestamp could not be queried.- Returns:
- local receive file last-modified time in epoch nanoseconds
-
-