@Generated(value="software.amazon.awssdk:codegen") public final class DescribeJobResponse extends GlacierResponse implements ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>
Contains the description of an Amazon S3 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()
The archive ID requested for a select job or archive retrieval.
|
String |
archiveSHA256TreeHash()
The SHA256 tree hash of the entire archive for an archive retrieval.
|
Long |
archiveSizeInBytes()
For an archive retrieval job, this value 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 job request completed.
|
String |
creationDate()
The UTC date when the job was created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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 inventory retrieval job, this value is the size in bytes of the inventory requested for download.
|
String |
jobDescription()
The job description provided when initiating the job.
|
String |
jobId()
An opaque string that identifies an Amazon S3 Glacier job.
|
String |
jobOutputPath()
Contains the job output location.
|
OutputLocation |
outputLocation()
Contains the location where the data from the select job is stored.
|
String |
retrievalByteRange()
The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.
|
List<SdkField<?>> |
sdkFields() |
SelectParameters |
selectParameters()
Contains the parameters used for a select.
|
static Class<? extends DescribeJobResponse.Builder> |
serializableBuilderClass() |
String |
sha256TreeHash()
For an archive retrieval job, this value is the checksum of the archive.
|
String |
snsTopic()
An 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 tier to use for a select or an 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()
Returns a string representation of this object.
|
String |
vaultARN()
The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
|
responseMetadatasdkHttpResponsecopypublic final String jobId()
An opaque string that identifies an Amazon S3 Glacier job.
public final String jobDescription()
The job description provided when initiating the job.
public final ActionCode action()
The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
Select.
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().
ArchiveRetrieval, InventoryRetrieval, or
Select.ActionCodepublic final String actionAsString()
The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
Select.
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().
ArchiveRetrieval, InventoryRetrieval, or
Select.ActionCodepublic final String archiveId()
The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
public final String vaultARN()
The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
public final String 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".
"2012-03-20T17:03:43.221Z".public final Boolean completed()
The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
public final 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().
InProgress, Succeeded, or Failed, and
indicates the status of the job.StatusCodepublic final 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().
InProgress, Succeeded, or Failed, and
indicates the status of the job.StatusCodepublic final String statusMessage()
A friendly message that describes the job status.
public final Long 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.
public final Long 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.
public final String snsTopic()
An Amazon SNS topic that receives notification.
public final String completionDate()
The UTC time that the job request completed. While the job is in progress, the value is null.
public final String 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
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
public final String archiveSHA256TreeHash()
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
public final 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. 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.
public final String tier()
The tier to use for a select or an archive retrieval. Valid values are Expedited,
Standard, or Bulk. Standard is the default.
Expedited,
Standard, or Bulk. Standard is the default.public final InventoryRetrievalJobDescription inventoryRetrievalParameters()
Parameters used for range inventory retrieval.
public final String jobOutputPath()
Contains the job output location.
public final SelectParameters selectParameters()
Contains the parameters used for a select.
public final OutputLocation outputLocation()
Contains the location where the data from the select job is stored.
public DescribeJobResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DescribeJobResponse.Builder,DescribeJobResponse>toBuilder in class AwsResponsepublic static DescribeJobResponse.Builder builder()
public static Class<? extends DescribeJobResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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 SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.