Class DescribeJobResult
- All Implemented Interfaces:
Serializable
,Cloneable
Describes an Amazon Glacier job.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The job type.For an ArchiveRetrieval job, this is the archive ID requested for download.The SHA256 tree hash of the entire archive for an archive retrieval.For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.The job status.The UTC time that the archive retrieval request completed.The UTC date when the job was created.Parameters used for range inventory retrieval.For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.The job description you provided when you initiated the job.getJobId()
An opaque string that identifies an Amazon Glacier job.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 an ArchiveRetrieval job, it is the checksum of the archive.An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.A friendly message that describes the job status.The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.int
hashCode()
The job status.void
setAction
(ActionCode action) The job type.void
The job type.void
setArchiveId
(String archiveId) For an ArchiveRetrieval job, this is the archive ID requested for download.void
setArchiveSHA256TreeHash
(String archiveSHA256TreeHash) The SHA256 tree hash of the entire archive for an archive retrieval.void
setArchiveSizeInBytes
(Long archiveSizeInBytes) For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.void
setCompleted
(Boolean completed) The job status.void
setCompletionDate
(String completionDate) The UTC time that the archive retrieval request completed.void
setCreationDate
(String creationDate) The UTC date when the job was created.void
setInventoryRetrievalParameters
(InventoryRetrievalJobDescription inventoryRetrievalParameters) Parameters used for range inventory retrieval.void
setInventorySizeInBytes
(Long inventorySizeInBytes) For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.void
setJobDescription
(String jobDescription) The job description you provided when you initiated the job.void
An opaque string that identifies an Amazon Glacier job.void
setRetrievalByteRange
(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.void
setSHA256TreeHash
(String sHA256TreeHash) For an ArchiveRetrieval job, it is the checksum of the archive.void
setSNSTopic
(String sNSTopic) An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.void
setStatusCode
(StatusCode statusCode) The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.void
setStatusCode
(String statusCode) The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.void
setStatusMessage
(String statusMessage) A friendly message that describes the job status.void
setVaultARN
(String vaultARN) The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.toString()
Returns a string representation of this object; useful for testing and debugging.withAction
(ActionCode action) The job type.withAction
(String action) The job type.withArchiveId
(String archiveId) For an ArchiveRetrieval job, this is the archive ID requested for download.withArchiveSHA256TreeHash
(String archiveSHA256TreeHash) The SHA256 tree hash of the entire archive for an archive retrieval.withArchiveSizeInBytes
(Long archiveSizeInBytes) For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.withCompleted
(Boolean completed) The job status.withCompletionDate
(String completionDate) The UTC time that the archive retrieval request completed.withCreationDate
(String creationDate) The UTC date when the job was created.withInventoryRetrievalParameters
(InventoryRetrievalJobDescription inventoryRetrievalParameters) Parameters used for range inventory retrieval.withInventorySizeInBytes
(Long inventorySizeInBytes) For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.withJobDescription
(String jobDescription) The job description you provided when you initiated the job.An opaque string that identifies an Amazon Glacier job.withRetrievalByteRange
(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.withSHA256TreeHash
(String sHA256TreeHash) For an ArchiveRetrieval job, it is the checksum of the archive.withSNSTopic
(String sNSTopic) An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.withStatusCode
(StatusCode statusCode) The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.withStatusCode
(String statusCode) The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.withStatusMessage
(String statusMessage) A friendly message that describes the job status.withVaultARN
(String vaultARN) The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
-
Constructor Details
-
DescribeJobResult
public DescribeJobResult()
-
-
Method Details
-
setJobId
An opaque string that identifies an Amazon Glacier job.
- Parameters:
jobId
- An opaque string that identifies an Amazon Glacier job.
-
getJobId
An opaque string that identifies an Amazon Glacier job.
- Returns:
- An opaque string that identifies an Amazon Glacier job.
-
withJobId
An opaque string that identifies an Amazon Glacier job.
- Parameters:
jobId
- An opaque string that identifies an Amazon Glacier job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setJobDescription
The job description you provided when you initiated the job.
- Parameters:
jobDescription
- The job description you provided when you initiated the job.
-
getJobDescription
The job description you provided when you initiated the job.
- Returns:
- The job description you provided when you initiated the job.
-
withJobDescription
The job description you provided when you initiated the job.
- Parameters:
jobDescription
- The job description you provided when you initiated the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAction
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
- Parameters:
action
- The job type. It is either ArchiveRetrieval or InventoryRetrieval.- See Also:
-
getAction
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
- Returns:
- The job type. It is either ArchiveRetrieval or InventoryRetrieval.
- See Also:
-
withAction
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
- Parameters:
action
- The job type. It is either ArchiveRetrieval or InventoryRetrieval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAction
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
- Parameters:
action
- The job type. It is either ArchiveRetrieval or InventoryRetrieval.- See Also:
-
withAction
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
- Parameters:
action
- The job type. It is either ArchiveRetrieval or InventoryRetrieval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setArchiveId
For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
- Parameters:
archiveId
- For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
-
getArchiveId
For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
- Returns:
- For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
-
withArchiveId
For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
- Parameters:
archiveId
- For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVaultARN
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
- Parameters:
vaultARN
- The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
-
getVaultARN
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
- Returns:
- The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
-
withVaultARN
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
- Parameters:
vaultARN
- The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreationDate
The UTC date when the job was created. 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. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".
-
getCreationDate
The UTC date when the job was created. 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. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".
-
withCreationDate
The UTC date when the job was created. 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. 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.
-
setCompleted
The job status. When a job is completed, you get the job's output.
- Parameters:
completed
- The job status. When a job is completed, you get the job's output.
-
getCompleted
The job status. When a job is completed, you get the job's output.
- Returns:
- The job status. When a job is completed, you get the job's output.
-
withCompleted
The job status. When a job is completed, you get the job's output.
- Parameters:
completed
- The job status. When a job is completed, you get the job's output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isCompleted
The job status. When a job is completed, you get the job's output.
- Returns:
- The job status. When a job is completed, you get the job's output.
-
setStatusCode
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
- Parameters:
statusCode
- The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.- See Also:
-
getStatusCode
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
- Returns:
- The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
- See Also:
-
withStatusCode
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
- Parameters:
statusCode
- The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStatusCode
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
- Parameters:
statusCode
- The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.- See Also:
-
withStatusCode
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
- Parameters:
statusCode
- The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStatusMessage
A friendly message that describes the job status.
- Parameters:
statusMessage
- A friendly message that describes the job status.
-
getStatusMessage
A friendly message that describes the job status.
- Returns:
- A friendly message that describes the job status.
-
withStatusMessage
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.
-
setArchiveSizeInBytes
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.
- Parameters:
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.
-
getArchiveSizeInBytes
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.
- Returns:
- 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.
-
withArchiveSizeInBytes
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInventorySizeInBytes
For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
- Parameters:
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.
-
getInventorySizeInBytes
For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
- Returns:
- For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
-
withInventorySizeInBytes
For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSNSTopic
An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
- Parameters:
sNSTopic
- An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
-
getSNSTopic
An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
- Returns:
- An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
-
withSNSTopic
An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
- Parameters:
sNSTopic
- An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCompletionDate
The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
- Parameters:
completionDate
- The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
-
getCompletionDate
The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
- Returns:
- The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
-
withCompletionDate
The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
- Parameters:
completionDate
- The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSHA256TreeHash
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.
- Parameters:
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.
-
-
-
getSHA256TreeHash
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.
- Returns:
- 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.
-
-
-
withSHA256TreeHash
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setArchiveSHA256TreeHash
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
- Parameters:
archiveSHA256TreeHash
- The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
-
getArchiveSHA256TreeHash
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
- Returns:
- The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
-
withArchiveSHA256TreeHash
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
- Parameters:
archiveSHA256TreeHash
- The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRetrievalByteRange
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.
- 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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
-
getRetrievalByteRange
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.
- 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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
-
withRetrievalByteRange
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.
- 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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInventoryRetrievalParameters
public void setInventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters) Parameters used for range inventory retrieval.
- Parameters:
inventoryRetrievalParameters
- Parameters used for range inventory retrieval.
-
getInventoryRetrievalParameters
Parameters used for range inventory retrieval.
- Returns:
- Parameters used for range inventory retrieval.
-
withInventoryRetrievalParameters
public DescribeJobResult withInventoryRetrievalParameters(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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-