GlacierJobDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glacier.model.GlacierJobDescription

All Implemented Interfaces:

Serializable
```
public class GlacierJobDescription
extends Object
implements Serializable
```
Describes an Amazon Glacier job.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

GlacierJobDescription()

Constructors
Constructor and Description
`GlacierJobDescription()`

Method Summary

Methods
Modifier and Type	Method and Description
`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`	`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`	`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.
`GlacierJobDescription`	`withAction(ActionCode action)` The job type.
`GlacierJobDescription`	`withAction(String action)` The job type.
`GlacierJobDescription`	`withArchiveId(String archiveId)` For an ArchiveRetrieval job, this is the archive ID requested for download.
`GlacierJobDescription`	`withArchiveSHA256TreeHash(String archiveSHA256TreeHash)` The SHA256 tree hash of the entire archive for an archive retrieval.
`GlacierJobDescription`	`withArchiveSizeInBytes(Long archiveSizeInBytes)` For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
`GlacierJobDescription`	`withCompleted(Boolean completed)` The job status.
`GlacierJobDescription`	`withCompletionDate(String completionDate)` The UTC time that the archive retrieval request completed.
`GlacierJobDescription`	`withCreationDate(String creationDate)` The UTC date when the job was created.
`GlacierJobDescription`	`withInventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters)` Parameters used for range inventory retrieval.
`GlacierJobDescription`	`withInventorySizeInBytes(Long inventorySizeInBytes)` For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
`GlacierJobDescription`	`withJobDescription(String jobDescription)` The job description you provided when you initiated the job.
`GlacierJobDescription`	`withJobId(String jobId)` An opaque string that identifies an Amazon Glacier job.
`GlacierJobDescription`	`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.
`GlacierJobDescription`	`withSHA256TreeHash(String sHA256TreeHash)` For an ArchiveRetrieval job, it is the checksum of the archive.
`GlacierJobDescription`	`withSNSTopic(String sNSTopic)` An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
`GlacierJobDescription`	`withStatusCode(StatusCode statusCode)` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
`GlacierJobDescription`	`withStatusCode(String statusCode)` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
`GlacierJobDescription`	`withStatusMessage(String statusMessage)` A friendly message that describes the job status.
`GlacierJobDescription`	`withVaultARN(String vaultARN)` The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

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

- Constructor Detail
  - GlacierJobDescription
```
public GlacierJobDescription()
```
- Method Detail
  - getJobId
```
public String getJobId()
```
    An opaque string that identifies an Amazon Glacier job.
    
    Returns:
    An opaque string that identifies an Amazon Glacier job.
  - 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.
  - withJobId
```
public GlacierJobDescription withJobId(String jobId)
```
    An opaque string that identifies an Amazon Glacier job.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    jobId - An opaque string that identifies an Amazon Glacier job.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withJobDescription
```
public GlacierJobDescription withJobDescription(String jobDescription)
```
    The job description you provided when you initiated the job.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    jobDescription - The job description you provided when you initiated the job.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAction
```
public String getAction()
```
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    Constraints:
    Allowed Values: ArchiveRetrieval, InventoryRetrieval
    
    Returns:
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    See Also:
    ActionCode
  - setAction
```
public void setAction(String action)
```
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    Constraints:
    Allowed Values: ArchiveRetrieval, InventoryRetrieval
    
    Parameters:
    action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    See Also:
    ActionCode
  - withAction
```
public GlacierJobDescription withAction(String action)
```
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ArchiveRetrieval, InventoryRetrieval
    
    Parameters:
    action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    
    Returns:
    A reference to this updated 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.
    Constraints:
    Allowed Values: ArchiveRetrieval, InventoryRetrieval
    
    Parameters:
    action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    See Also:
    ActionCode
  - withAction
```
public GlacierJobDescription withAction(ActionCode action)
```
    The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ArchiveRetrieval, InventoryRetrieval
    
    Parameters:
    action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    ActionCode
  - 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.
  - 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.
  - withArchiveId
```
public GlacierJobDescription withArchiveId(String archiveId)
```
    For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    archiveId - For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withVaultARN
```
public GlacierJobDescription withVaultARN(String vaultARN)
```
    The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    vaultARN - The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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".
  - 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".
  - withCreationDate
```
public GlacierJobDescription 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".
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated 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.
  - 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.
  - withCompleted
```
public GlacierJobDescription withCompleted(Boolean completed)
```
    The job status. When a job is completed, you get the job's output.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    completed - The job status. When a job is completed, you get the job's output.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - getStatusCode
```
public String getStatusCode()
```
    The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    Constraints:
    Allowed Values: InProgress, Succeeded, Failed
    
    Returns:
    The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    See Also:
    StatusCode
  - setStatusCode
```
public void setStatusCode(String statusCode)
```
    The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    Constraints:
    Allowed Values: InProgress, Succeeded, Failed
    
    Parameters:
    statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    See Also:
    StatusCode
  - withStatusCode
```
public GlacierJobDescription withStatusCode(String statusCode)
```
    The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: InProgress, Succeeded, Failed
    
    Parameters:
    statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    
    Returns:
    A reference to this updated 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.
    Constraints:
    Allowed Values: InProgress, Succeeded, Failed
    
    Parameters:
    statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    See Also:
    StatusCode
  - withStatusCode
```
public GlacierJobDescription withStatusCode(StatusCode statusCode)
```
    The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: InProgress, Succeeded, Failed
    
    Parameters:
    statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    StatusCode
  - getStatusMessage
```
public String getStatusMessage()
```
    A friendly message that describes the job status.
    
    Returns:
    A friendly message that describes the job status.
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A friendly message that describes the job status.
    
    Parameters:
    statusMessage - A friendly message that describes the job status.
  - withStatusMessage
```
public GlacierJobDescription withStatusMessage(String statusMessage)
```
    A friendly message that describes the job status.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    statusMessage - A friendly message that describes the job status.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withArchiveSizeInBytes
```
public GlacierJobDescription 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withInventorySizeInBytes
```
public GlacierJobDescription 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withSNSTopic
```
public GlacierJobDescription withSNSTopic(String sNSTopic)
```
    An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    sNSTopic - An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withCompletionDate
```
public GlacierJobDescription withCompletionDate(String completionDate)
```
    The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    completionDate - The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withSHA256TreeHash
```
public GlacierJobDescription 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.
    Returns a reference to this object so that method calls can be chained together.
    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:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withArchiveSHA256TreeHash
```
public GlacierJobDescription withArchiveSHA256TreeHash(String archiveSHA256TreeHash)
```
    The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withRetrievalByteRange
```
public GlacierJobDescription 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getInventoryRetrievalParameters
```
public InventoryRetrievalJobDescription getInventoryRetrievalParameters()
```
    Parameters used for range inventory retrieval.
    
    Returns:
    Parameters used for range inventory retrieval.
  - setInventoryRetrievalParameters
```
public void setInventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters)
```
    Parameters used for range inventory retrieval.
    
    Parameters:
    inventoryRetrievalParameters - Parameters used for range inventory retrieval.
  - withInventoryRetrievalParameters
```
public GlacierJobDescription withInventoryRetrievalParameters(InventoryRetrievalJobDescription inventoryRetrievalParameters)
```
    Parameters used for range inventory retrieval.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    inventoryRetrievalParameters - Parameters used for range inventory retrieval.
    
    Returns:
    A reference to this updated 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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class GlacierJobDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlacierJobDescription

Method Detail

getJobId

setJobId

withJobId

getJobDescription

setJobDescription

withJobDescription

getAction

setAction

withAction

setAction

withAction

getArchiveId

setArchiveId

withArchiveId

getVaultARN

setVaultARN

withVaultARN

getCreationDate

setCreationDate

withCreationDate

isCompleted

setCompleted

withCompleted

getCompleted

getStatusCode

setStatusCode

withStatusCode

setStatusCode

withStatusCode

getStatusMessage

setStatusMessage

withStatusMessage

getArchiveSizeInBytes

setArchiveSizeInBytes

withArchiveSizeInBytes

getInventorySizeInBytes

setInventorySizeInBytes

withInventorySizeInBytes

getSNSTopic

setSNSTopic

withSNSTopic

getCompletionDate

setCompletionDate

withCompletionDate

getSHA256TreeHash

setSHA256TreeHash

withSHA256TreeHash

getArchiveSHA256TreeHash

setArchiveSHA256TreeHash

withArchiveSHA256TreeHash

getRetrievalByteRange

setRetrievalByteRange

withRetrievalByteRange

getInventoryRetrievalParameters

setInventoryRetrievalParameters

withInventoryRetrievalParameters

toString

hashCode

equals