public static interface DescribeJobResponse.Builder extends GlacierResponse.Builder, CopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>
Modifier and Type | Method and Description |
---|---|
DescribeJobResponse.Builder |
action(ActionCode action)
The job type.
|
DescribeJobResponse.Builder |
action(String action)
The job type.
|
DescribeJobResponse.Builder |
archiveId(String archiveId)
For an ArchiveRetrieval job, this is the archive ID requested for download.
|
DescribeJobResponse.Builder |
archiveSHA256TreeHash(String archiveSHA256TreeHash)
The SHA256 tree hash of the entire archive for an archive retrieval.
|
DescribeJobResponse.Builder |
archiveSizeInBytes(Long archiveSizeInBytes)
For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
|
DescribeJobResponse.Builder |
completed(Boolean completed)
The job status.
|
DescribeJobResponse.Builder |
completionDate(String completionDate)
The UTC time that the archive retrieval request completed.
|
DescribeJobResponse.Builder |
creationDate(String creationDate)
The UTC date when the job was created.
|
default DescribeJobResponse.Builder |
inventoryRetrievalParameters(Consumer<InventoryRetrievalJobDescription.Builder> inventoryRetrievalParameters)
Parameters used for range inventory retrieval.
|
DescribeJobResponse.Builder |
inventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters)
Parameters used for range inventory retrieval.
|
DescribeJobResponse.Builder |
inventorySizeInBytes(Long inventorySizeInBytes)
For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
|
DescribeJobResponse.Builder |
jobDescription(String jobDescription)
The job description you provided when you initiated the job.
|
DescribeJobResponse.Builder |
jobId(String jobId)
An opaque string that identifies an Amazon Glacier job.
|
DescribeJobResponse.Builder |
retrievalByteRange(String retrievalByteRange)
The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue"
If no range was specified in the archive retrieval, then the whole archive is retrieved and
StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1.
|
DescribeJobResponse.Builder |
sha256TreeHash(String sha256TreeHash)
For an ArchiveRetrieval job, it is the checksum of the archive.
|
DescribeJobResponse.Builder |
snsTopic(String snsTopic)
An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
|
DescribeJobResponse.Builder |
statusCode(StatusCode statusCode)
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
|
DescribeJobResponse.Builder |
statusCode(String statusCode)
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
|
DescribeJobResponse.Builder |
statusMessage(String statusMessage)
A friendly message that describes the job status.
|
DescribeJobResponse.Builder |
tier(String tier)
The retrieval option to use for the archive retrieval.
|
DescribeJobResponse.Builder |
vaultARN(String vaultARN)
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
|
build
copy
apply, build
DescribeJobResponse.Builder jobId(String jobId)
An opaque string that identifies an Amazon Glacier job.
jobId
- An opaque string that identifies an Amazon Glacier job.DescribeJobResponse.Builder jobDescription(String jobDescription)
The job description you provided when you initiated the job.
jobDescription
- The job description you provided when you initiated the job.DescribeJobResponse.Builder action(String action)
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
action
- The job type. It is either ArchiveRetrieval or InventoryRetrieval.ActionCode
,
ActionCode
DescribeJobResponse.Builder action(ActionCode action)
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
action
- The job type. It is either ArchiveRetrieval or InventoryRetrieval.ActionCode
,
ActionCode
DescribeJobResponse.Builder archiveId(String archiveId)
For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
archiveId
- For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is
null.DescribeJobResponse.Builder vaultARN(String vaultARN)
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
vaultARN
- The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.DescribeJobResponse.Builder creationDate(String creationDate)
The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".
creationDate
- The UTC date when the job was created. A string representation of ISO 8601 date format, for example,
"2012-03-20T17:03:43.221Z".DescribeJobResponse.Builder completed(Boolean completed)
The job status. When a job is completed, you get the job's output.
completed
- The job status. When a job is completed, you get the job's output.DescribeJobResponse.Builder statusCode(String statusCode)
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
statusCode
- The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.StatusCode
,
StatusCode
DescribeJobResponse.Builder statusCode(StatusCode statusCode)
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
statusCode
- The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.StatusCode
,
StatusCode
DescribeJobResponse.Builder statusMessage(String statusMessage)
A friendly message that describes the job status.
statusMessage
- A friendly message that describes the job status.DescribeJobResponse.Builder archiveSizeInBytes(Long archiveSizeInBytes)
For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.
archiveSizeInBytes
- For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
For the InventoryRetrieval job, the value is null.DescribeJobResponse.Builder inventorySizeInBytes(Long inventorySizeInBytes)
For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
inventorySizeInBytes
- For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For
the ArchiveRetrieval job, the value is null.DescribeJobResponse.Builder snsTopic(String snsTopic)
An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
snsTopic
- An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.DescribeJobResponse.Builder completionDate(String completionDate)
The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
completionDate
- The UTC time that the archive retrieval request completed. While the job is in progress, the value
will be null.DescribeJobResponse.Builder sha256TreeHash(String sha256TreeHash)
For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
sha256TreeHash
- For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
DescribeJobResponse.Builder archiveSHA256TreeHash(String archiveSHA256TreeHash)
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
archiveSHA256TreeHash
- The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs,
this field is null.DescribeJobResponse.Builder retrievalByteRange(String retrievalByteRange)
The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
retrievalByteRange
- The retrieved byte range for archive retrieval jobs in the form
"StartByteValue-EndByteValue" If no range was specified in the archive retrieval, then
the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the
size of the archive minus 1. For inventory retrieval jobs this field is null.DescribeJobResponse.Builder tier(String tier)
The retrieval option to use for the archive retrieval. Valid values are Expedited
,
Standard
, or Bulk
. Standard
is the default.
tier
- The retrieval option to use for the archive retrieval. Valid values are Expedited
,
Standard
, or Bulk
. Standard
is the default.DescribeJobResponse.Builder inventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters)
Parameters used for range inventory retrieval.
inventoryRetrievalParameters
- Parameters used for range inventory retrieval.default DescribeJobResponse.Builder inventoryRetrievalParameters(Consumer<InventoryRetrievalJobDescription.Builder> inventoryRetrievalParameters)
Parameters used for range inventory retrieval.
This is a convenience that creates an instance of theInventoryRetrievalJobDescription.Builder
avoiding the need to create one manually via InventoryRetrievalJobDescription.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to
inventoryRetrievalParameters(InventoryRetrievalJobDescription)
.inventoryRetrievalParameters
- a consumer that will call methods on InventoryRetrievalJobDescription.Builder
inventoryRetrievalParameters(InventoryRetrievalJobDescription)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.