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

Contains the description of an Amazon S3 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()` The archive ID requested for a select job or archive retrieval.
`String`	`getArchiveSHA256TreeHash()` The SHA256 tree hash of the entire archive for an archive retrieval.
`Long`	`getArchiveSizeInBytes()` For an archive retrieval job, this value is the size in bytes of the archive being requested for download.
`Boolean`	`getCompleted()` The job status.
`String`	`getCompletionDate()` The UTC time that the job request completed.
`String`	`getCreationDate()` The UTC date when the job was created.
`InventoryRetrievalJobDescription`	`getInventoryRetrievalParameters()` Parameters used for range inventory retrieval.
`Long`	`getInventorySizeInBytes()` For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.
`String`	`getJobDescription()` The job description provided when initiating the job.
`String`	`getJobId()` An opaque string that identifies an Amazon S3 Glacier job.
`String`	`getJobOutputPath()` Contains the job output location.
`OutputLocation`	`getOutputLocation()` Contains the location where the data from the select job is stored.
`String`	`getRetrievalByteRange()` The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.
`SelectParameters`	`getSelectParameters()` Contains the parameters used for a select.
`String`	`getSHA256TreeHash()` For an archive retrieval job, this value is the checksum of the archive.
`String`	`getSNSTopic()` An 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 tier to use for a select or an archive retrieval.
`String`	`getVaultARN()` The Amazon Resource Name (ARN) of the vault from which an 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)` The archive ID requested for a select job or archive retrieval.
`void`	`setArchiveSHA256TreeHash(String archiveSHA256TreeHash)` The SHA256 tree hash of the entire archive for an archive retrieval.
`void`	`setArchiveSizeInBytes(Long archiveSizeInBytes)` For an archive retrieval job, this value 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 job 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 inventory retrieval job, this value is the size in bytes of the inventory requested for download.
`void`	`setJobDescription(String jobDescription)` The job description provided when initiating the job.
`void`	`setJobId(String jobId)` An opaque string that identifies an Amazon S3 Glacier job.
`void`	`setJobOutputPath(String jobOutputPath)` Contains the job output location.
`void`	`setOutputLocation(OutputLocation outputLocation)` Contains the location where the data from the select job is stored.
`void`	`setRetrievalByteRange(String retrievalByteRange)` The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.
`void`	`setSelectParameters(SelectParameters selectParameters)` Contains the parameters used for a select.
`void`	`setSHA256TreeHash(String sHA256TreeHash)` For an archive retrieval job, this value is the checksum of the archive.
`void`	`setSNSTopic(String sNSTopic)` An 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 tier to use for a select or an archive retrieval.
`void`	`setVaultARN(String vaultARN)` The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
`String`	`toString()` Returns a string representation of this object.
`DescribeJobResult`	`withAction(ActionCode action)` The job type.
`DescribeJobResult`	`withAction(String action)` The job type.
`DescribeJobResult`	`withArchiveId(String archiveId)` The archive ID requested for a select job or archive retrieval.
`DescribeJobResult`	`withArchiveSHA256TreeHash(String archiveSHA256TreeHash)` The SHA256 tree hash of the entire archive for an archive retrieval.
`DescribeJobResult`	`withArchiveSizeInBytes(Long archiveSizeInBytes)` For an archive retrieval job, this value 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 job 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 inventory retrieval job, this value is the size in bytes of the inventory requested for download.
`DescribeJobResult`	`withJobDescription(String jobDescription)` The job description provided when initiating the job.
`DescribeJobResult`	`withJobId(String jobId)` An opaque string that identifies an Amazon S3 Glacier job.
`DescribeJobResult`	`withJobOutputPath(String jobOutputPath)` Contains the job output location.
`DescribeJobResult`	`withOutputLocation(OutputLocation outputLocation)` Contains the location where the data from the select job is stored.
`DescribeJobResult`	`withRetrievalByteRange(String retrievalByteRange)` The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.
`DescribeJobResult`	`withSelectParameters(SelectParameters selectParameters)` Contains the parameters used for a select.
`DescribeJobResult`	`withSHA256TreeHash(String sHA256TreeHash)` For an archive retrieval job, this value is the checksum of the archive.
`DescribeJobResult`	`withSNSTopic(String sNSTopic)` An 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 tier to use for a select or an archive retrieval.
`DescribeJobResult`	`withVaultARN(String vaultARN)` The Amazon Resource Name (ARN) of the vault from which an 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 S3 Glacier job.
    
    Parameters:
    
    jobId - An opaque string that identifies an Amazon S3 Glacier job.
  - getJobId
```
public String getJobId()
```
    An opaque string that identifies an Amazon S3 Glacier job.
    
    Returns:
    
    An opaque string that identifies an Amazon S3 Glacier job.
  - withJobId
```
public DescribeJobResult withJobId(String jobId)
```
    An opaque string that identifies an Amazon S3 Glacier job.
    
    Parameters:
    
    jobId - An opaque string that identifies an Amazon S3 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 provided when initiating the job.
    
    Parameters:
    
    jobDescription - The job description provided when initiating the job.
  - getJobDescription
```
public String getJobDescription()
```
    The job description provided when initiating the job.
    
    Returns:
    
    The job description provided when initiating the job.
  - withJobDescription
```
public DescribeJobResult withJobDescription(String jobDescription)
```
    The job description provided when initiating the job.
    
    Parameters:
    
    jobDescription - The job description provided when initiating 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. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    Parameters:
    
    action - The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    See Also:
    
    ActionCode
  - getAction
```
public String getAction()
```
    The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    Returns:
    
    The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    See Also:
    
    ActionCode
  - withAction
```
public DescribeJobResult withAction(String action)
```
    The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    Parameters:
    
    action - The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    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. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    Parameters:
    
    action - The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    See Also:
    
    ActionCode
  - withAction
```
public DescribeJobResult withAction(ActionCode action)
```
    The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    Parameters:
    
    action - The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionCode
  - setArchiveId
```
public void setArchiveId(String archiveId)
```
    The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
    
    Parameters:
    
    archiveId - The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
  - getArchiveId
```
public String getArchiveId()
```
    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.
  - withArchiveId
```
public DescribeJobResult withArchiveId(String archiveId)
```
    The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
    
    Parameters:
    
    archiveId - The archive ID requested for a select job or archive retrieval. 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 an archive retrieval was requested.
    
    Parameters:
    
    vaultARN - The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
  - getVaultARN
```
public String getVaultARN()
```
    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.
  - withVaultARN
```
public DescribeJobResult withVaultARN(String vaultARN)
```
    The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
    
    Parameters:
    
    vaultARN - The Amazon Resource Name (ARN) of the vault from which an 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. This value is 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. This value is 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. 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".
  - withCreationDate
```
public DescribeJobResult withCreationDate(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".
    
    Parameters:
    
    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:
    
    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 using Get Job Output (GET output).
    
    Parameters:
    
    completed - The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
  - getCompleted
```
public Boolean getCompleted()
```
    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).
  - withCompleted
```
public DescribeJobResult withCompleted(Boolean completed)
```
    The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
    
    Parameters:
    
    completed - The job status. When a job is completed, you get the job's output using Get Job Output (GET 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 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).
  - 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 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.
    
    Parameters:
    
    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.
  - getArchiveSizeInBytes
```
public Long getArchiveSizeInBytes()
```
    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.
  - withArchiveSizeInBytes
```
public DescribeJobResult withArchiveSizeInBytes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInventorySizeInBytes
```
public void setInventorySizeInBytes(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.
    
    Parameters:
    
    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.
  - getInventorySizeInBytes
```
public Long getInventorySizeInBytes()
```
    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.
  - withInventorySizeInBytes
```
public DescribeJobResult withInventorySizeInBytes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSNSTopic
```
public void setSNSTopic(String sNSTopic)
```
    An Amazon SNS topic that receives notification.
    
    Parameters:
    
    sNSTopic - An Amazon SNS topic that receives notification.
  - getSNSTopic
```
public String getSNSTopic()
```
    An Amazon SNS topic that receives notification.
    
    Returns:
    
    An Amazon SNS topic that receives notification.
  - withSNSTopic
```
public DescribeJobResult withSNSTopic(String sNSTopic)
```
    An Amazon SNS topic that receives notification.
    
    Parameters:
    
    sNSTopic - An 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 job request completed. While the job is in progress, the value is null.
    
    Parameters:
    
    completionDate - The UTC time that the job request completed. While the job is in progress, the value is null.
  - getCompletionDate
```
public String getCompletionDate()
```
    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.
  - withCompletionDate
```
public DescribeJobResult withCompletionDate(String completionDate)
```
    The UTC time that the job request completed. While the job is in progress, the value is null.
    
    Parameters:
    
    completionDate - The UTC time that the job request completed. While the job is in progress, the value is null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSHA256TreeHash
```
public void setSHA256TreeHash(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
    Parameters:
    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
  - getSHA256TreeHash
```
public String getSHA256TreeHash()
```
    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
  - withSHA256TreeHash
```
public DescribeJobResult withSHA256TreeHash(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
    Parameters:
    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:
    
    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 or select jobs, this field is null.
    
    Parameters:
    
    archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
  - getArchiveSHA256TreeHash
```
public String getArchiveSHA256TreeHash()
```
    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.
  - withArchiveSHA256TreeHash
```
public DescribeJobResult withArchiveSHA256TreeHash(String archiveSHA256TreeHash)
```
    The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
    
    Parameters:
    
    archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select 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. 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.
    
    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. 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.
  - 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. 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.
  - 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. 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.
    
    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. 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTier
```
public void setTier(String tier)
```
    The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
    
    Parameters:
    
    tier - The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
  - getTier
```
public String getTier()
```
    The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
    
    Returns:
    
    The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
  - withTier
```
public DescribeJobResult withTier(String tier)
```
    The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.
    
    Parameters:
    
    tier - The tier to use for a select or an 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.
  - setJobOutputPath
```
public void setJobOutputPath(String jobOutputPath)
```
    Contains the job output location.
    
    Parameters:
    
    jobOutputPath - Contains the job output location.
  - getJobOutputPath
```
public String getJobOutputPath()
```
    Contains the job output location.
    
    Returns:
    
    Contains the job output location.
  - withJobOutputPath
```
public DescribeJobResult withJobOutputPath(String jobOutputPath)
```
    Contains the job output location.
    
    Parameters:
    
    jobOutputPath - Contains the job output location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSelectParameters
```
public void setSelectParameters(SelectParameters selectParameters)
```
    Contains the parameters used for a select.
    
    Parameters:
    
    selectParameters - Contains the parameters used for a select.
  - getSelectParameters
```
public SelectParameters getSelectParameters()
```
    Contains the parameters used for a select.
    
    Returns:
    
    Contains the parameters used for a select.
  - withSelectParameters
```
public DescribeJobResult withSelectParameters(SelectParameters selectParameters)
```
    Contains the parameters used for a select.
    
    Parameters:
    
    selectParameters - Contains the parameters used for a select.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputLocation
```
public void setOutputLocation(OutputLocation outputLocation)
```
    Contains the location where the data from the select job is stored.
    
    Parameters:
    
    outputLocation - Contains the location where the data from the select job is stored.
  - getOutputLocation
```
public OutputLocation getOutputLocation()
```
    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.
  - withOutputLocation
```
public DescribeJobResult withOutputLocation(OutputLocation outputLocation)
```
    Contains the location where the data from the select job is stored.
    
    Parameters:
    
    outputLocation - Contains the location where the data from the select job is stored.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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

AWS SDK for Java 1.x API Reference - 1.12.778

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

setJobOutputPath

getJobOutputPath

withJobOutputPath

setSelectParameters

getSelectParameters

withSelectParameters

setOutputLocation

getOutputLocation

withOutputLocation

toString

equals

hashCode