com.amazonaws.services.glacier.model
Class DescribeJobResult

java.lang.Object
  com.amazonaws.services.glacier.model.DescribeJobResult

All Implemented Interfaces:

Serializable

public class DescribeJobResult
extends Object
implements Serializable

Describes an Amazon Glacier job.

See Also:

Serialized Form

Constructor Summary

DescribeJobResult()

Method Summary

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() Returns the value of the ArchiveSHA256TreeHash property for this object.
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.
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() Returns the value of the RetrievalByteRange property for this object.
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) Sets the value of the ArchiveSHA256TreeHash property for this object.
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	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) Sets the value of the RetrievalByteRange property for this object.
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.
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) Sets the value of the ArchiveSHA256TreeHash property for this object.
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	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) Sets the value of the RetrievalByteRange property for this object.
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	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

DescribeJobResult

public DescribeJobResult()

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 DescribeJobResult 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 DescribeJobResult 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 DescribeJobResult 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 DescribeJobResult 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 DescribeJobResult 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 DescribeJobResult 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 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".

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 DescribeJobResult 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 DescribeJobResult 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 DescribeJobResult 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 DescribeJobResult 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 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.

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 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.

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 DescribeJobResult 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 DescribeJobResult 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.

Returns:

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

setSHA256TreeHash

public void setSHA256TreeHash(String sHA256TreeHash)

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

Parameters:

sHA256TreeHash - For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

withSHA256TreeHash

public DescribeJobResult withSHA256TreeHash(String sHA256TreeHash)

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getArchiveSHA256TreeHash

public String getArchiveSHA256TreeHash()

Returns the value of the ArchiveSHA256TreeHash property for this object.

Returns:

The value of the ArchiveSHA256TreeHash property for this object.

setArchiveSHA256TreeHash

public void setArchiveSHA256TreeHash(String archiveSHA256TreeHash)

Sets the value of the ArchiveSHA256TreeHash property for this object.

Parameters:

archiveSHA256TreeHash - The new value for the ArchiveSHA256TreeHash property for this object.

withArchiveSHA256TreeHash

public DescribeJobResult withArchiveSHA256TreeHash(String archiveSHA256TreeHash)

Sets the value of the ArchiveSHA256TreeHash property for this object.

Returns a reference to this object so that method calls can be chained together.

Parameters:

archiveSHA256TreeHash - The new value for the ArchiveSHA256TreeHash property for this object.

Returns:

A reference to this updated object so that method calls can be chained together.

getRetrievalByteRange

public String getRetrievalByteRange()

Returns the value of the RetrievalByteRange property for this object.

Returns:

The value of the RetrievalByteRange property for this object.

setRetrievalByteRange

public void setRetrievalByteRange(String retrievalByteRange)

Sets the value of the RetrievalByteRange property for this object.

Parameters:

retrievalByteRange - The new value for the RetrievalByteRange property for this object.

withRetrievalByteRange

public DescribeJobResult withRetrievalByteRange(String retrievalByteRange)

Sets the value of the RetrievalByteRange property for this object.

Returns a reference to this object so that method calls can be chained together.

Parameters:

retrievalByteRange - The new value for the RetrievalByteRange property for this object.

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