Class DescribeJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeJobResponse.Builder,
DescribeJobResponse>
Contains the description of an Amazon S3 Glacier job.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ActionCode
action()
The job type.final String
The job type.final String
The archive ID requested for a select job or archive retrieval.final String
The SHA256 tree hash of the entire archive for an archive retrieval.final Long
For an archive retrieval job, this value is the size in bytes of the archive being requested for download.static DescribeJobResponse.Builder
builder()
final Boolean
The job status.final String
The UTC time that the job request completed.final String
The UTC date when the job was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
Parameters used for range inventory retrieval.final Long
For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.final String
The job description provided when initiating the job.final String
jobId()
An opaque string that identifies an Amazon S3 Glacier job.final String
Contains the job output location.final OutputLocation
Contains the location where the data from the select job is stored.final String
The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.final SelectParameters
Contains the parameters used for a select.static Class
<? extends DescribeJobResponse.Builder> final String
For an archive retrieval job, this value is the checksum of the archive.final String
snsTopic()
An Amazon SNS topic that receives notification.final StatusCode
The status code can beInProgress
,Succeeded
, orFailed
, and indicates the status of the job.final String
The status code can beInProgress
,Succeeded
, orFailed
, and indicates the status of the job.final String
A friendly message that describes the job status.final String
tier()
The tier to use for a select or an archive retrieval.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
vaultARN()
The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.Methods inherited from class software.amazon.awssdk.services.glacier.model.GlacierResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobId
An opaque string that identifies an Amazon S3 Glacier job.
- Returns:
- An opaque string that identifies an Amazon S3 Glacier job.
-
jobDescription
The job description provided when initiating the job.
- Returns:
- The job description provided when initiating the job.
-
action
The job type. This value is either
ArchiveRetrieval
,InventoryRetrieval
, orSelect
.If the service returns an enum value that is not available in the current SDK version,
action
will returnActionCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The job type. This value is either
ArchiveRetrieval
,InventoryRetrieval
, orSelect
. - See Also:
-
actionAsString
The job type. This value is either
ArchiveRetrieval
,InventoryRetrieval
, orSelect
.If the service returns an enum value that is not available in the current SDK version,
action
will returnActionCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The job type. This value is either
ArchiveRetrieval
,InventoryRetrieval
, orSelect
. - See Also:
-
archiveId
The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
- Returns:
- The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
-
vaultARN
The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
- Returns:
- The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
-
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:
- 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"
.
-
completed
The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
- Returns:
- The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
-
statusCode
The status code can be
InProgress
,Succeeded
, orFailed
, 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 returnStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The status code can be
InProgress
,Succeeded
, orFailed
, and indicates the status of the job. - See Also:
-
statusCodeAsString
The status code can be
InProgress
,Succeeded
, orFailed
, 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 returnStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The status code can be
InProgress
,Succeeded
, orFailed
, and indicates the status of the job. - See Also:
-
statusMessage
A friendly message that describes the job status.
- Returns:
- A friendly message that describes the job status.
-
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:
- 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.
-
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:
- 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.
-
snsTopic
An Amazon SNS topic that receives notification.
- Returns:
- An Amazon SNS topic that receives notification.
-
completionDate
The UTC time that the job request completed. While the job is in progress, the value is null.
- Returns:
- The UTC time that the job request completed. While the job is in progress, the value is null.
-
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:
- 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
-
-
-
archiveSHA256TreeHash
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
- Returns:
- The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select 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. 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:
- 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.
-
tier
The tier to use for a select or an archive retrieval. Valid values are
Expedited
,Standard
, orBulk
.Standard
is the default.- Returns:
- The tier to use for a select or an archive retrieval. Valid values are
Expedited
,Standard
, orBulk
.Standard
is the default.
-
inventoryRetrievalParameters
Parameters used for range inventory retrieval.
- Returns:
- Parameters used for range inventory retrieval.
-
jobOutputPath
Contains the job output location.
- Returns:
- Contains the job output location.
-
selectParameters
Contains the parameters used for a select.
- Returns:
- Contains the parameters used for a select.
-
outputLocation
Contains the location where the data from the select job is stored.
- Returns:
- Contains the location where the data from the select job is stored.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeJobResponse.Builder,
DescribeJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-