Interface DescribeJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeJobResponse.Builder,
,DescribeJobResponse> GlacierResponse.Builder
,SdkBuilder<DescribeJobResponse.Builder,
,DescribeJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeJobResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe job type.action
(ActionCode action) The job type.The archive ID requested for a select job or archive retrieval.archiveSHA256TreeHash
(String archiveSHA256TreeHash) The SHA256 tree hash of the entire archive for an archive retrieval.archiveSizeInBytes
(Long archiveSizeInBytes) For an archive retrieval job, this value is the size in bytes of the archive being requested for download.The job status.completionDate
(String completionDate) The UTC time that the job request completed.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.inventoryRetrievalParameters
(InventoryRetrievalJobDescription inventoryRetrievalParameters) Parameters used for range inventory retrieval.inventorySizeInBytes
(Long inventorySizeInBytes) For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.jobDescription
(String jobDescription) The job description provided when initiating the job.An opaque string that identifies an Amazon S3 Glacier job.jobOutputPath
(String jobOutputPath) Contains the job output location.default DescribeJobResponse.Builder
outputLocation
(Consumer<OutputLocation.Builder> outputLocation) Contains the location where the data from the select job is stored.outputLocation
(OutputLocation outputLocation) Contains the location where the data from the select job is stored.retrievalByteRange
(String retrievalByteRange) The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.default DescribeJobResponse.Builder
selectParameters
(Consumer<SelectParameters.Builder> selectParameters) Contains the parameters used for a select.selectParameters
(SelectParameters selectParameters) Contains the parameters used for a select.sha256TreeHash
(String sha256TreeHash) For an archive retrieval job, this value is the checksum of the archive.An Amazon SNS topic that receives notification.statusCode
(String statusCode) The status code can beInProgress
,Succeeded
, orFailed
, and indicates the status of the job.statusCode
(StatusCode statusCode) The status code can beInProgress
,Succeeded
, orFailed
, and indicates the status of the job.statusMessage
(String statusMessage) A friendly message that describes the job status.The tier to use for a select or an archive retrieval.The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.glacier.model.GlacierResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
jobId
An opaque string that identifies an Amazon S3 Glacier job.
- Parameters:
jobId
- An opaque string that identifies an Amazon S3 Glacier job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobDescription
The job description provided when initiating the job.
- Parameters:
jobDescription
- The job description provided when initiating the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
action
The job type. This value is either
ArchiveRetrieval
,InventoryRetrieval
, orSelect
.- Parameters:
action
- The job type. This value is eitherArchiveRetrieval
,InventoryRetrieval
, orSelect
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
action
The job type. This value is either
ArchiveRetrieval
,InventoryRetrieval
, orSelect
.- Parameters:
action
- The job type. This value is eitherArchiveRetrieval
,InventoryRetrieval
, orSelect
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
archiveId
The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
- Parameters:
archiveId
- The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vaultARN
The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
- Parameters:
vaultARN
- The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationDate
The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example
"2012-03-20T17:03:43.221Z"
.- Parameters:
creationDate
- The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example"2012-03-20T17:03:43.221Z"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
completed
The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
- Parameters:
completed
- The job status. When a job is completed, you get the job's output using Get Job Output (GET output).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusCode
The status code can be
InProgress
,Succeeded
, orFailed
, and indicates the status of the job.- Parameters:
statusCode
- The status code can beInProgress
,Succeeded
, orFailed
, and indicates the status of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusCode
The status code can be
InProgress
,Succeeded
, orFailed
, and indicates the status of the job.- Parameters:
statusCode
- The status code can beInProgress
,Succeeded
, orFailed
, and indicates the status of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusMessage
A friendly message that describes the job status.
- Parameters:
statusMessage
- A friendly message that describes the job status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
archiveSizeInBytes
For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.
- Parameters:
archiveSizeInBytes
- For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inventorySizeInBytes
For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.
- Parameters:
inventorySizeInBytes
- For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopic
An Amazon SNS topic that receives notification.
- Parameters:
snsTopic
- An Amazon SNS topic that receives notification.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
completionDate
The UTC time that the job request completed. While the job is in progress, the value is null.
- Parameters:
completionDate
- The UTC time that the job request completed. While the job is in progress, the value is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sha256TreeHash
For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.
The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.
If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null for the following:
-
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, when the job status is
InProgress
-
Inventory jobs
-
Select jobs
- Parameters:
sha256TreeHash
- For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.
If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null for the following:
-
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, when the job status is
InProgress
-
Inventory jobs
-
Select jobs
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
archiveSHA256TreeHash
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
- Parameters:
archiveSHA256TreeHash
- The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.
- Parameters:
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. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tier
The tier to use for a select or an archive retrieval. Valid values are
Expedited
,Standard
, orBulk
.Standard
is the default.- Parameters:
tier
- The tier to use for a select or an archive retrieval. Valid values areExpedited
,Standard
, orBulk
.Standard
is the default.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inventoryRetrievalParameters
DescribeJobResponse.Builder inventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters) Parameters used for range inventory retrieval.
- Parameters:
inventoryRetrievalParameters
- Parameters used for range inventory retrieval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inventoryRetrievalParameters
default DescribeJobResponse.Builder inventoryRetrievalParameters(Consumer<InventoryRetrievalJobDescription.Builder> inventoryRetrievalParameters) Parameters used for range inventory retrieval.
This is a convenience method that creates an instance of theInventoryRetrievalJobDescription.Builder
avoiding the need to create one manually viaInventoryRetrievalJobDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinventoryRetrievalParameters(InventoryRetrievalJobDescription)
.- Parameters:
inventoryRetrievalParameters
- a consumer that will call methods onInventoryRetrievalJobDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jobOutputPath
Contains the job output location.
- Parameters:
jobOutputPath
- Contains the job output location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
selectParameters
Contains the parameters used for a select.
- Parameters:
selectParameters
- Contains the parameters used for a select.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
selectParameters
default DescribeJobResponse.Builder selectParameters(Consumer<SelectParameters.Builder> selectParameters) Contains the parameters used for a select.
This is a convenience method that creates an instance of theSelectParameters.Builder
avoiding the need to create one manually viaSelectParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toselectParameters(SelectParameters)
.- Parameters:
selectParameters
- a consumer that will call methods onSelectParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputLocation
Contains the location where the data from the select job is stored.
- Parameters:
outputLocation
- Contains the location where the data from the select job is stored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputLocation
Contains the location where the data from the select job is stored.
This is a convenience method that creates an instance of theOutputLocation.Builder
avoiding the need to create one manually viaOutputLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputLocation(OutputLocation)
.- Parameters:
outputLocation
- a consumer that will call methods onOutputLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-