GlacierJobDescription class

Contains the description of an Amazon S3 Glacier job.

Constructors

GlacierJobDescription({ActionCode? action, String? archiveId, String? archiveSHA256TreeHash, int? archiveSizeInBytes, bool? completed, String? completionDate, String? creationDate, InventoryRetrievalJobDescription? inventoryRetrievalParameters, int? inventorySizeInBytes, String? jobDescription, String? jobId, String? jobOutputPath, OutputLocation? outputLocation, String? retrievalByteRange, String? sHA256TreeHash, String? sNSTopic, SelectParameters? selectParameters, StatusCode? statusCode, String? statusMessage, String? tier, String? vaultARN})

GlacierJobDescription.fromJson(Map<String, dynamic> json)

factory

Properties

action → ActionCode?

The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

final

archiveId → String?

The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

final

archiveSHA256TreeHash → String?

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

final

archiveSizeInBytes → int?

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.

final

completed → bool?

The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

final

completionDate → String?

The UTC time that the job request completed. While the job is in progress, the value is null.

final

creationDate → String?

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

final

hashCode → int

The hash code for this object.

no setter, inherited

inventoryRetrievalParameters → InventoryRetrievalJobDescription?

Parameters used for range inventory retrieval.

final

inventorySizeInBytes → int?

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.

final

jobDescription → String?

The job description provided when initiating the job.

final

jobId → String?

An opaque string that identifies an Amazon S3 Glacier job.

final

jobOutputPath → String?

Contains the job output location.

final

outputLocation → OutputLocation?

Contains the location where the data from the select job is stored.

final

retrievalByteRange → String?

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectParameters → SelectParameters?

Contains the parameters used for a select.

final

sHA256TreeHash → String?

For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

final

sNSTopic → String?

An Amazon SNS topic that receives notification.

final

statusCode → StatusCode?

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

final

statusMessage → String?

A friendly message that describes the job status.

final

tier → String?

The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

final

vaultARN → String?

The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited