@Generated(value="software.amazon.awssdk:codegen") public final class DescribeJobResponse extends GlacierResponse implements ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>
Describes an Amazon Glacier job.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeJobResponse.Builder |
Modifier and Type | Method and Description |
---|---|
ActionCode |
action()
The job type.
|
String |
actionAsString()
The job type.
|
String |
archiveId()
For an ArchiveRetrieval job, this is the archive ID requested for download.
|
String |
archiveSHA256TreeHash()
The SHA256 tree hash of the entire archive for an archive retrieval.
|
Long |
archiveSizeInBytes()
For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
|
static DescribeJobResponse.Builder |
builder() |
Boolean |
completed()
The job status.
|
String |
completionDate()
The UTC time that the archive retrieval request completed.
|
String |
creationDate()
The UTC date when the job was created.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
InventoryRetrievalJobDescription |
inventoryRetrievalParameters()
Parameters used for range inventory retrieval.
|
Long |
inventorySizeInBytes()
For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
|
String |
jobDescription()
The job description you provided when you initiated the job.
|
String |
jobId()
An opaque string that identifies an Amazon Glacier job.
|
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.
|
static Class<? extends DescribeJobResponse.Builder> |
serializableBuilderClass() |
String |
sha256TreeHash()
For an ArchiveRetrieval job, it is the checksum of the archive.
|
String |
snsTopic()
An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
|
StatusCode |
statusCode()
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
|
String |
statusCodeAsString()
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
|
String |
statusMessage()
A friendly message that describes the job status.
|
String |
tier()
The retrieval option to use for the archive retrieval.
|
DescribeJobResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
vaultARN()
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
|
sdkHttpResponse
copy
public String jobId()
An opaque string that identifies an Amazon Glacier job.
public String jobDescription()
The job description you provided when you initiated the job.
public ActionCode action()
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
If the service returns an enum value that is not available in the current SDK version, action
will
return ActionCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
actionAsString()
.
ActionCode
public String actionAsString()
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
If the service returns an enum value that is not available in the current SDK version, action
will
return ActionCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
actionAsString()
.
ActionCode
public String archiveId()
For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
public String vaultARN()
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
public 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".
public Boolean completed()
The job status. When a job is completed, you get the job's output.
public StatusCode statusCode()
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
If the service returns an enum value that is not available in the current SDK version, statusCode
will
return StatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusCodeAsString()
.
StatusCode
public String statusCodeAsString()
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
If the service returns an enum value that is not available in the current SDK version, statusCode
will
return StatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusCodeAsString()
.
StatusCode
public String statusMessage()
A friendly message that describes the job status.
public 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.
public 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.
public String snsTopic()
An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
public String completionDate()
The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
public 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.
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.
public String archiveSHA256TreeHash()
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
public 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.
public String tier()
The retrieval option to use for the archive retrieval. Valid values are Expedited
,
Standard
, or Bulk
. Standard
is the default.
Expedited
,
Standard
, or Bulk
. Standard
is the default.public InventoryRetrievalJobDescription inventoryRetrievalParameters()
Parameters used for range inventory retrieval.
public DescribeJobResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>
toBuilder
in class AwsResponse
public static DescribeJobResponse.Builder builder()
public static Class<? extends DescribeJobResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.