DescribeJobResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.glacier.model.DescribeJobResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeJobResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Describes an Amazon Glacier job.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeJobResult()

Constructors
Constructor and Description
`DescribeJobResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeJobResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The job type.
`String`	`getArchiveId()` For an ArchiveRetrieval job, this is the archive ID requested for download.
`String`	`getArchiveSHA256TreeHash()` The SHA256 tree hash of the entire archive for an archive retrieval.
`Long`	`getArchiveSizeInBytes()` For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
`Boolean`	`getCompleted()` The job status.
`String`	`getCompletionDate()` The UTC time that the archive retrieval request completed.
`String`	`getCreationDate()` The UTC date when the job was created.
`InventoryRetrievalJobDescription`	`getInventoryRetrievalParameters()` Parameters used for range inventory retrieval.
`Long`	`getInventorySizeInBytes()` For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
`String`	`getJobDescription()` The job description you provided when you initiated the job.
`String`	`getJobId()` An opaque string that identifies an Amazon Glacier job.
`String`	`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.
`String`	`getSHA256TreeHash()` For an ArchiveRetrieval job, it is the checksum of the archive.
`String`	`getSNSTopic()` An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
`String`	`getStatusCode()` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
`String`	`getStatusMessage()` A friendly message that describes the job status.
`String`	`getTier()` The retrieval option to use for the archive retrieval.
`String`	`getVaultARN()` The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
`int`	`hashCode()`
`Boolean`	`isCompleted()` The job status.
`void`	`setAction(ActionCode action)` The job type.
`void`	`setAction(String action)` 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`	`setJobId(String jobId)` 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`	`setTier(String tier)` The retrieval option to use for the archive retrieval.
`void`	`setVaultARN(String vaultARN)` The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeJobResult`	`withAction(ActionCode action)` The job type.
`DescribeJobResult`	`withAction(String action)` The job type.
`DescribeJobResult`	`withArchiveId(String archiveId)` For an ArchiveRetrieval job, this is the archive ID requested for download.
`DescribeJobResult`	`withArchiveSHA256TreeHash(String archiveSHA256TreeHash)` The SHA256 tree hash of the entire archive for an archive retrieval.
`DescribeJobResult`	`withArchiveSizeInBytes(Long archiveSizeInBytes)` For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
`DescribeJobResult`	`withCompleted(Boolean completed)` The job status.
`DescribeJobResult`	`withCompletionDate(String completionDate)` The UTC time that the archive retrieval request completed.
`DescribeJobResult`	`withCreationDate(String creationDate)` The UTC date when the job was created.
`DescribeJobResult`	`withInventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters)` Parameters used for range inventory retrieval.
`DescribeJobResult`	`withInventorySizeInBytes(Long inventorySizeInBytes)` For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
`DescribeJobResult`	`withJobDescription(String jobDescription)` The job description you provided when you initiated the job.
`DescribeJobResult`	`withJobId(String jobId)` An opaque string that identifies an Amazon Glacier job.
`DescribeJobResult`	`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.
`DescribeJobResult`	`withSHA256TreeHash(String sHA256TreeHash)` For an ArchiveRetrieval job, it is the checksum of the archive.
`DescribeJobResult`	`withSNSTopic(String sNSTopic)` An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
`DescribeJobResult`	`withStatusCode(StatusCode statusCode)` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
`DescribeJobResult`	`withStatusCode(String statusCode)` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
`DescribeJobResult`	`withStatusMessage(String statusMessage)` A friendly message that describes the job status.
`DescribeJobResult`	`withTier(String tier)` The retrieval option to use for the archive retrieval.
`DescribeJobResult`	`withVaultARN(String vaultARN)` The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeJobResult
```
public DescribeJobResult()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    An opaque string that identifies an Amazon Glacier job.
    
    Parameters:
    
    jobId - An opaque string that identifies an Amazon Glacier job.
  - getJobId
```
public String getJobId()
```
    An opaque string that identifies an Amazon Glacier job.
    
    Returns:
    
    An opaque string that identifies an Amazon Glacier job.
  - withJobId
```
public DescribeJobResult withJobId(String jobId)
```
    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
```
public void setJobDescription(String jobDescription)
```
    The job description you provided when you initiated the job.
    
    Parameters:
    
    jobDescription - The job description you provided when you initiated the job.
  - getJobDescription
```
public String getJobDescription()
```
    The job description you provided when you initiated the job.
    
    Returns:
    
    The job description you provided when you initiated the job.
  - withJobDescription
```
public DescribeJobResult withJobDescription(String jobDescription)
```
    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
```
public void setAction(String action)
```
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    
    Parameters:
    
    action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    
    See Also:
    
    ActionCode
  - getAction
```
public String getAction()
```
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    
    Returns:
    
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    
    See Also:
    
    ActionCode
  - withAction
```
public DescribeJobResult withAction(String action)
```
    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:
    
    ActionCode
  - setAction
```
public void setAction(ActionCode action)
```
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    
    Parameters:
    
    action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    
    See Also:
    
    ActionCode
  - withAction
```
public DescribeJobResult withAction(ActionCode action)
```
    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:
    
    ActionCode
  - setArchiveId
```
public void setArchiveId(String archiveId)
```
    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
```
public String 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
```
public DescribeJobResult withArchiveId(String archiveId)
```
    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
```
public void setVaultARN(String vaultARN)
```
    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
```
public String 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
```
public DescribeJobResult withVaultARN(String vaultARN)
```
    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
```
public void setCreationDate(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".
    
    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
```
public String 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
```
public DescribeJobResult withCreationDate(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".
    
    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
```
public void setCompleted(Boolean completed)
```
    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
```
public Boolean 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
```
public DescribeJobResult withCompleted(Boolean completed)
```
    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
```
public Boolean 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
```
public void setStatusCode(String statusCode)
```
    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:
    
    StatusCode
  - getStatusCode
```
public String 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:
    
    StatusCode
  - withStatusCode
```
public DescribeJobResult withStatusCode(String statusCode)
```
    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:
    
    StatusCode
  - setStatusCode
```
public void setStatusCode(StatusCode statusCode)
```
    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:
    
    StatusCode
  - withStatusCode
```
public DescribeJobResult withStatusCode(StatusCode statusCode)
```
    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:
    
    StatusCode
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A friendly message that describes the job status.
    
    Parameters:
    
    statusMessage - A friendly message that describes the job status.
  - getStatusMessage
```
public String getStatusMessage()
```
    A friendly message that describes the job status.
    
    Returns:
    
    A friendly message that describes the job status.
  - withStatusMessage
```
public DescribeJobResult withStatusMessage(String 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.
  - setArchiveSizeInBytes
```
public void setArchiveSizeInBytes(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.
    
    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
```
public Long 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
```
public DescribeJobResult withArchiveSizeInBytes(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.
    
    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
```
public void setInventorySizeInBytes(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.
    
    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
```
public Long 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
```
public DescribeJobResult withInventorySizeInBytes(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.
    
    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
```
public void setSNSTopic(String sNSTopic)
```
    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
```
public String 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
```
public DescribeJobResult withSNSTopic(String sNSTopic)
```
    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
```
public void setCompletionDate(String completionDate)
```
    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
```
public String 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
```
public DescribeJobResult withCompletionDate(String completionDate)
```
    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
```
public void setSHA256TreeHash(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.
    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
```
public String 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
```
public DescribeJobResult withSHA256TreeHash(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.
    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
```
public void setArchiveSHA256TreeHash(String archiveSHA256TreeHash)
```
    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
```
public String 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
```
public DescribeJobResult withArchiveSHA256TreeHash(String archiveSHA256TreeHash)
```
    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
```
public 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. 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
```
public String 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
```
public DescribeJobResult 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. 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.
  - setTier
```
public void setTier(String tier)
```
    The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
    
    Parameters:
    
    tier - The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
  - getTier
```
public String getTier()
```
    The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
    
    Returns:
    
    The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
  - withTier
```
public DescribeJobResult withTier(String tier)
```
    The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
    
    Parameters:
    
    tier - The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
    
    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
```
public InventoryRetrievalJobDescription 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
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeJobResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeJobResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeJobResult

Method Detail

setJobId

getJobId

withJobId

setJobDescription

getJobDescription

withJobDescription

setAction

getAction

withAction

setAction

withAction

setArchiveId

getArchiveId

withArchiveId

setVaultARN

getVaultARN

withVaultARN

setCreationDate

getCreationDate

withCreationDate

setCompleted

getCompleted

withCompleted

isCompleted

setStatusCode

getStatusCode

withStatusCode

setStatusCode

withStatusCode

setStatusMessage

getStatusMessage

withStatusMessage

setArchiveSizeInBytes

getArchiveSizeInBytes

withArchiveSizeInBytes

setInventorySizeInBytes

getInventorySizeInBytes

withInventorySizeInBytes

setSNSTopic

getSNSTopic

withSNSTopic

setCompletionDate

getCompletionDate

withCompletionDate

setSHA256TreeHash

getSHA256TreeHash

withSHA256TreeHash

setArchiveSHA256TreeHash

getArchiveSHA256TreeHash

withArchiveSHA256TreeHash

setRetrievalByteRange

getRetrievalByteRange

withRetrievalByteRange

setTier

getTier

withTier

setInventoryRetrievalParameters

getInventoryRetrievalParameters

withInventoryRetrievalParameters

toString

equals

hashCode

clone