Describes an Amazon Glacier job.
Declaration Syntax| C# |
public class DescribeJobResult
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | DescribeJobResult()()()() | Initializes a new instance of the DescribeJobResult class |
 | Action |
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
Constraints: |
| ArchiveId |
For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
|
| ArchiveSHA256TreeHash |
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
|
| 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.
|
| Completed |
The job status. When a job is completed, you get the job's output.
|
| CompletionDate |
The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
|
| 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".
|
| Equals(Object) | (Inherited from Object.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| InventoryRetrievalParameters |
Parameters used for range inventory retrieval.
|
| 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.
|
| JobDescription |
The job description you provided when you initiated the job.
|
| JobId |
An opaque string that identifies an Amazon Glacier job.
|
| 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.
|
| 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:
|
| SNSTopic |
An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
|
| StatusCode |
The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
Constraints: |
| StatusMessage |
A friendly message that describes the job status.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| VaultARN |
The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
|
| WithAction(String) | Obsolete.
Sets the Action property
|
| WithArchiveId(String) | Obsolete.
Sets the ArchiveId property
|
| WithArchiveSHA256TreeHash(String) | Obsolete.
Sets the ArchiveSHA256TreeHash property
|
| WithArchiveSizeInBytes(Int64) | Obsolete.
Sets the ArchiveSizeInBytes property
|
| WithCompleted(Boolean) | Obsolete.
Sets the Completed property
|
| WithCompletionDate(DateTime) | Obsolete.
Sets the CompletionDate property
|
| WithCreationDate(DateTime) | Obsolete.
Sets the CreationDate property
|
| WithInventoryRetrievalParameters(InventoryRetrievalJobDescription) | Obsolete.
Sets the InventoryRetrievalParameters property
|
| WithInventorySizeInBytes(Int64) | Obsolete.
Sets the InventorySizeInBytes property
|
| WithJobDescription(String) | Obsolete.
Sets the JobDescription property
|
| WithJobId(String) | Obsolete.
Sets the JobId property
|
| WithRetrievalByteRange(String) | Obsolete.
Sets the RetrievalByteRange property
|
| WithSHA256TreeHash(String) | Obsolete.
Sets the SHA256TreeHash property
|
| WithSNSTopic(String) | Obsolete.
Sets the SNSTopic property
|
| WithStatusCode(String) | Obsolete.
Sets the StatusCode property
|
| WithStatusMessage(String) | Obsolete.
Sets the StatusMessage property
|
| WithVaultARN(String) | Obsolete.
Sets the VaultARN property
|
Inheritance Hierarchy| Object | |
 | DescribeJobResult |