AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Glacier::Model::GlacierJobDescription Class Reference

#include <GlacierJobDescription.h>

Public Member Functions

 GlacierJobDescription ()
 
 GlacierJobDescription (Aws::Utils::Json::JsonView jsonValue)
 
GlacierJobDescriptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
GlacierJobDescriptionWithJobId (const Aws::String &value)
 
GlacierJobDescriptionWithJobId (Aws::String &&value)
 
GlacierJobDescriptionWithJobId (const char *value)
 
const Aws::StringGetJobDescription () const
 
bool JobDescriptionHasBeenSet () const
 
void SetJobDescription (const Aws::String &value)
 
void SetJobDescription (Aws::String &&value)
 
void SetJobDescription (const char *value)
 
GlacierJobDescriptionWithJobDescription (const Aws::String &value)
 
GlacierJobDescriptionWithJobDescription (Aws::String &&value)
 
GlacierJobDescriptionWithJobDescription (const char *value)
 
const ActionCodeGetAction () const
 
bool ActionHasBeenSet () const
 
void SetAction (const ActionCode &value)
 
void SetAction (ActionCode &&value)
 
GlacierJobDescriptionWithAction (const ActionCode &value)
 
GlacierJobDescriptionWithAction (ActionCode &&value)
 
const Aws::StringGetArchiveId () const
 
bool ArchiveIdHasBeenSet () const
 
void SetArchiveId (const Aws::String &value)
 
void SetArchiveId (Aws::String &&value)
 
void SetArchiveId (const char *value)
 
GlacierJobDescriptionWithArchiveId (const Aws::String &value)
 
GlacierJobDescriptionWithArchiveId (Aws::String &&value)
 
GlacierJobDescriptionWithArchiveId (const char *value)
 
const Aws::StringGetVaultARN () const
 
bool VaultARNHasBeenSet () const
 
void SetVaultARN (const Aws::String &value)
 
void SetVaultARN (Aws::String &&value)
 
void SetVaultARN (const char *value)
 
GlacierJobDescriptionWithVaultARN (const Aws::String &value)
 
GlacierJobDescriptionWithVaultARN (Aws::String &&value)
 
GlacierJobDescriptionWithVaultARN (const char *value)
 
const Aws::StringGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::String &value)
 
void SetCreationDate (Aws::String &&value)
 
void SetCreationDate (const char *value)
 
GlacierJobDescriptionWithCreationDate (const Aws::String &value)
 
GlacierJobDescriptionWithCreationDate (Aws::String &&value)
 
GlacierJobDescriptionWithCreationDate (const char *value)
 
bool GetCompleted () const
 
bool CompletedHasBeenSet () const
 
void SetCompleted (bool value)
 
GlacierJobDescriptionWithCompleted (bool value)
 
const StatusCodeGetStatusCode () const
 
bool StatusCodeHasBeenSet () const
 
void SetStatusCode (const StatusCode &value)
 
void SetStatusCode (StatusCode &&value)
 
GlacierJobDescriptionWithStatusCode (const StatusCode &value)
 
GlacierJobDescriptionWithStatusCode (StatusCode &&value)
 
const Aws::StringGetStatusMessage () const
 
bool StatusMessageHasBeenSet () const
 
void SetStatusMessage (const Aws::String &value)
 
void SetStatusMessage (Aws::String &&value)
 
void SetStatusMessage (const char *value)
 
GlacierJobDescriptionWithStatusMessage (const Aws::String &value)
 
GlacierJobDescriptionWithStatusMessage (Aws::String &&value)
 
GlacierJobDescriptionWithStatusMessage (const char *value)
 
long long GetArchiveSizeInBytes () const
 
bool ArchiveSizeInBytesHasBeenSet () const
 
void SetArchiveSizeInBytes (long long value)
 
GlacierJobDescriptionWithArchiveSizeInBytes (long long value)
 
long long GetInventorySizeInBytes () const
 
bool InventorySizeInBytesHasBeenSet () const
 
void SetInventorySizeInBytes (long long value)
 
GlacierJobDescriptionWithInventorySizeInBytes (long long value)
 
const Aws::StringGetSNSTopic () const
 
bool SNSTopicHasBeenSet () const
 
void SetSNSTopic (const Aws::String &value)
 
void SetSNSTopic (Aws::String &&value)
 
void SetSNSTopic (const char *value)
 
GlacierJobDescriptionWithSNSTopic (const Aws::String &value)
 
GlacierJobDescriptionWithSNSTopic (Aws::String &&value)
 
GlacierJobDescriptionWithSNSTopic (const char *value)
 
const Aws::StringGetCompletionDate () const
 
bool CompletionDateHasBeenSet () const
 
void SetCompletionDate (const Aws::String &value)
 
void SetCompletionDate (Aws::String &&value)
 
void SetCompletionDate (const char *value)
 
GlacierJobDescriptionWithCompletionDate (const Aws::String &value)
 
GlacierJobDescriptionWithCompletionDate (Aws::String &&value)
 
GlacierJobDescriptionWithCompletionDate (const char *value)
 
const Aws::StringGetSHA256TreeHash () const
 
bool SHA256TreeHashHasBeenSet () const
 
void SetSHA256TreeHash (const Aws::String &value)
 
void SetSHA256TreeHash (Aws::String &&value)
 
void SetSHA256TreeHash (const char *value)
 
GlacierJobDescriptionWithSHA256TreeHash (const Aws::String &value)
 
GlacierJobDescriptionWithSHA256TreeHash (Aws::String &&value)
 
GlacierJobDescriptionWithSHA256TreeHash (const char *value)
 
const Aws::StringGetArchiveSHA256TreeHash () const
 
bool ArchiveSHA256TreeHashHasBeenSet () const
 
void SetArchiveSHA256TreeHash (const Aws::String &value)
 
void SetArchiveSHA256TreeHash (Aws::String &&value)
 
void SetArchiveSHA256TreeHash (const char *value)
 
GlacierJobDescriptionWithArchiveSHA256TreeHash (const Aws::String &value)
 
GlacierJobDescriptionWithArchiveSHA256TreeHash (Aws::String &&value)
 
GlacierJobDescriptionWithArchiveSHA256TreeHash (const char *value)
 
const Aws::StringGetRetrievalByteRange () const
 
bool RetrievalByteRangeHasBeenSet () const
 
void SetRetrievalByteRange (const Aws::String &value)
 
void SetRetrievalByteRange (Aws::String &&value)
 
void SetRetrievalByteRange (const char *value)
 
GlacierJobDescriptionWithRetrievalByteRange (const Aws::String &value)
 
GlacierJobDescriptionWithRetrievalByteRange (Aws::String &&value)
 
GlacierJobDescriptionWithRetrievalByteRange (const char *value)
 
const Aws::StringGetTier () const
 
bool TierHasBeenSet () const
 
void SetTier (const Aws::String &value)
 
void SetTier (Aws::String &&value)
 
void SetTier (const char *value)
 
GlacierJobDescriptionWithTier (const Aws::String &value)
 
GlacierJobDescriptionWithTier (Aws::String &&value)
 
GlacierJobDescriptionWithTier (const char *value)
 
const InventoryRetrievalJobDescriptionGetInventoryRetrievalParameters () const
 
bool InventoryRetrievalParametersHasBeenSet () const
 
void SetInventoryRetrievalParameters (const InventoryRetrievalJobDescription &value)
 
void SetInventoryRetrievalParameters (InventoryRetrievalJobDescription &&value)
 
GlacierJobDescriptionWithInventoryRetrievalParameters (const InventoryRetrievalJobDescription &value)
 
GlacierJobDescriptionWithInventoryRetrievalParameters (InventoryRetrievalJobDescription &&value)
 
const Aws::StringGetJobOutputPath () const
 
bool JobOutputPathHasBeenSet () const
 
void SetJobOutputPath (const Aws::String &value)
 
void SetJobOutputPath (Aws::String &&value)
 
void SetJobOutputPath (const char *value)
 
GlacierJobDescriptionWithJobOutputPath (const Aws::String &value)
 
GlacierJobDescriptionWithJobOutputPath (Aws::String &&value)
 
GlacierJobDescriptionWithJobOutputPath (const char *value)
 
const SelectParametersGetSelectParameters () const
 
bool SelectParametersHasBeenSet () const
 
void SetSelectParameters (const SelectParameters &value)
 
void SetSelectParameters (SelectParameters &&value)
 
GlacierJobDescriptionWithSelectParameters (const SelectParameters &value)
 
GlacierJobDescriptionWithSelectParameters (SelectParameters &&value)
 
const OutputLocationGetOutputLocation () const
 
bool OutputLocationHasBeenSet () const
 
void SetOutputLocation (const OutputLocation &value)
 
void SetOutputLocation (OutputLocation &&value)
 
GlacierJobDescriptionWithOutputLocation (const OutputLocation &value)
 
GlacierJobDescriptionWithOutputLocation (OutputLocation &&value)
 

Detailed Description

Contains the description of an Amazon S3 Glacier job.

See Also:

AWS API Reference

Definition at line 37 of file GlacierJobDescription.h.

Constructor & Destructor Documentation

◆ GlacierJobDescription() [1/2]

Aws::Glacier::Model::GlacierJobDescription::GlacierJobDescription ( )

◆ GlacierJobDescription() [2/2]

Aws::Glacier::Model::GlacierJobDescription::GlacierJobDescription ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActionHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::ActionHasBeenSet ( ) const
inline

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

Definition at line 138 of file GlacierJobDescription.h.

◆ ArchiveIdHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::ArchiveIdHasBeenSet ( ) const
inline

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

Definition at line 175 of file GlacierJobDescription.h.

◆ ArchiveSHA256TreeHashHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::ArchiveSHA256TreeHashHasBeenSet ( ) const
inline

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

Definition at line 702 of file GlacierJobDescription.h.

◆ ArchiveSizeInBytesHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::ArchiveSizeInBytesHasBeenSet ( ) const
inline

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.

Definition at line 435 of file GlacierJobDescription.h.

◆ CompletedHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::CompletedHasBeenSet ( ) const
inline

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

Definition at line 330 of file GlacierJobDescription.h.

◆ CompletionDateHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::CompletionDateHasBeenSet ( ) const
inline

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

Definition at line 532 of file GlacierJobDescription.h.

◆ CreationDateHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::CreationDateHasBeenSet ( ) const
inline

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

Definition at line 275 of file GlacierJobDescription.h.

◆ GetAction()

const ActionCode& Aws::Glacier::Model::GlacierJobDescription::GetAction ( ) const
inline

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

Definition at line 132 of file GlacierJobDescription.h.

◆ GetArchiveId()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetArchiveId ( ) const
inline

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

Definition at line 169 of file GlacierJobDescription.h.

◆ GetArchiveSHA256TreeHash()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetArchiveSHA256TreeHash ( ) const
inline

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

Definition at line 696 of file GlacierJobDescription.h.

◆ GetArchiveSizeInBytes()

long long Aws::Glacier::Model::GlacierJobDescription::GetArchiveSizeInBytes ( ) const
inline

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.

Definition at line 428 of file GlacierJobDescription.h.

◆ GetCompleted()

bool Aws::Glacier::Model::GlacierJobDescription::GetCompleted ( ) const
inline

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

Definition at line 324 of file GlacierJobDescription.h.

◆ GetCompletionDate()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetCompletionDate ( ) const
inline

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

Definition at line 526 of file GlacierJobDescription.h.

◆ GetCreationDate()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetCreationDate ( ) const
inline

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

Definition at line 268 of file GlacierJobDescription.h.

◆ GetInventoryRetrievalParameters()

const InventoryRetrievalJobDescription& Aws::Glacier::Model::GlacierJobDescription::GetInventoryRetrievalParameters ( ) const
inline

Parameters used for range inventory retrieval.

Definition at line 882 of file GlacierJobDescription.h.

◆ GetInventorySizeInBytes()

long long Aws::Glacier::Model::GlacierJobDescription::GetInventorySizeInBytes ( ) const
inline

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.

Definition at line 457 of file GlacierJobDescription.h.

◆ GetJobDescription()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetJobDescription ( ) const
inline

The job description provided when initiating the job.

Definition at line 90 of file GlacierJobDescription.h.

◆ GetJobId()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetJobId ( ) const
inline

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 49 of file GlacierJobDescription.h.

◆ GetJobOutputPath()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetJobOutputPath ( ) const
inline

Contains the job output location.

Definition at line 913 of file GlacierJobDescription.h.

◆ GetOutputLocation()

const OutputLocation& Aws::Glacier::Model::GlacierJobDescription::GetOutputLocation ( ) const
inline

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

Definition at line 985 of file GlacierJobDescription.h.

◆ GetRetrievalByteRange()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetRetrievalByteRange ( ) const
inline

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.

Definition at line 749 of file GlacierJobDescription.h.

◆ GetSelectParameters()

const SelectParameters& Aws::Glacier::Model::GlacierJobDescription::GetSelectParameters ( ) const
inline

Contains the parameters used for a select.

Definition at line 954 of file GlacierJobDescription.h.

◆ GetSHA256TreeHash()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetSHA256TreeHash ( ) const
inline

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

Definition at line 584 of file GlacierJobDescription.h.

◆ GetSNSTopic()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetSNSTopic ( ) const
inline

An Amazon SNS topic that receives notification.

Definition at line 484 of file GlacierJobDescription.h.

◆ GetStatusCode()

const StatusCode& Aws::Glacier::Model::GlacierJobDescription::GetStatusCode ( ) const
inline

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

Definition at line 349 of file GlacierJobDescription.h.

◆ GetStatusMessage()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetStatusMessage ( ) const
inline

A friendly message that describes the job status.

Definition at line 385 of file GlacierJobDescription.h.

◆ GetTier()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetTier ( ) const
inline

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

Definition at line 827 of file GlacierJobDescription.h.

◆ GetVaultARN()

const Aws::String& Aws::Glacier::Model::GlacierJobDescription::GetVaultARN ( ) const
inline

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

Definition at line 218 of file GlacierJobDescription.h.

◆ InventoryRetrievalParametersHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::InventoryRetrievalParametersHasBeenSet ( ) const
inline

Parameters used for range inventory retrieval.

Definition at line 887 of file GlacierJobDescription.h.

◆ InventorySizeInBytesHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::InventorySizeInBytesHasBeenSet ( ) const
inline

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.

Definition at line 464 of file GlacierJobDescription.h.

◆ JobDescriptionHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::JobDescriptionHasBeenSet ( ) const
inline

The job description provided when initiating the job.

Definition at line 95 of file GlacierJobDescription.h.

◆ JobIdHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::JobIdHasBeenSet ( ) const
inline

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 54 of file GlacierJobDescription.h.

◆ JobOutputPathHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::JobOutputPathHasBeenSet ( ) const
inline

Contains the job output location.

Definition at line 918 of file GlacierJobDescription.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Glacier::Model::GlacierJobDescription::Jsonize ( ) const

◆ operator=()

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputLocationHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::OutputLocationHasBeenSet ( ) const
inline

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

Definition at line 990 of file GlacierJobDescription.h.

◆ RetrievalByteRangeHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::RetrievalByteRangeHasBeenSet ( ) const
inline

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.

Definition at line 759 of file GlacierJobDescription.h.

◆ SelectParametersHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::SelectParametersHasBeenSet ( ) const
inline

Contains the parameters used for a select.

Definition at line 959 of file GlacierJobDescription.h.

◆ SetAction() [1/2]

void Aws::Glacier::Model::GlacierJobDescription::SetAction ( const ActionCode value)
inline

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

Definition at line 144 of file GlacierJobDescription.h.

◆ SetAction() [2/2]

void Aws::Glacier::Model::GlacierJobDescription::SetAction ( ActionCode &&  value)
inline

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

Definition at line 150 of file GlacierJobDescription.h.

◆ SetArchiveId() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetArchiveId ( const Aws::String value)
inline

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

Definition at line 181 of file GlacierJobDescription.h.

◆ SetArchiveId() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetArchiveId ( Aws::String &&  value)
inline

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

Definition at line 187 of file GlacierJobDescription.h.

◆ SetArchiveId() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetArchiveId ( const char *  value)
inline

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

Definition at line 193 of file GlacierJobDescription.h.

◆ SetArchiveSHA256TreeHash() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetArchiveSHA256TreeHash ( const Aws::String value)
inline

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

Definition at line 708 of file GlacierJobDescription.h.

◆ SetArchiveSHA256TreeHash() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetArchiveSHA256TreeHash ( Aws::String &&  value)
inline

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

Definition at line 714 of file GlacierJobDescription.h.

◆ SetArchiveSHA256TreeHash() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetArchiveSHA256TreeHash ( const char *  value)
inline

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

Definition at line 720 of file GlacierJobDescription.h.

◆ SetArchiveSizeInBytes()

void Aws::Glacier::Model::GlacierJobDescription::SetArchiveSizeInBytes ( long long  value)
inline

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.

Definition at line 442 of file GlacierJobDescription.h.

◆ SetCompleted()

void Aws::Glacier::Model::GlacierJobDescription::SetCompleted ( bool  value)
inline

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

Definition at line 336 of file GlacierJobDescription.h.

◆ SetCompletionDate() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetCompletionDate ( const Aws::String value)
inline

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

Definition at line 538 of file GlacierJobDescription.h.

◆ SetCompletionDate() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetCompletionDate ( Aws::String &&  value)
inline

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

Definition at line 544 of file GlacierJobDescription.h.

◆ SetCompletionDate() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetCompletionDate ( const char *  value)
inline

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

Definition at line 550 of file GlacierJobDescription.h.

◆ SetCreationDate() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetCreationDate ( const Aws::String value)
inline

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

Definition at line 282 of file GlacierJobDescription.h.

◆ SetCreationDate() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetCreationDate ( Aws::String &&  value)
inline

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

Definition at line 289 of file GlacierJobDescription.h.

◆ SetCreationDate() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetCreationDate ( const char *  value)
inline

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

Definition at line 296 of file GlacierJobDescription.h.

◆ SetInventoryRetrievalParameters() [1/2]

void Aws::Glacier::Model::GlacierJobDescription::SetInventoryRetrievalParameters ( const InventoryRetrievalJobDescription value)
inline

Parameters used for range inventory retrieval.

Definition at line 892 of file GlacierJobDescription.h.

◆ SetInventoryRetrievalParameters() [2/2]

void Aws::Glacier::Model::GlacierJobDescription::SetInventoryRetrievalParameters ( InventoryRetrievalJobDescription &&  value)
inline

Parameters used for range inventory retrieval.

Definition at line 897 of file GlacierJobDescription.h.

◆ SetInventorySizeInBytes()

void Aws::Glacier::Model::GlacierJobDescription::SetInventorySizeInBytes ( long long  value)
inline

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.

Definition at line 471 of file GlacierJobDescription.h.

◆ SetJobDescription() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobDescription ( const Aws::String value)
inline

The job description provided when initiating the job.

Definition at line 100 of file GlacierJobDescription.h.

◆ SetJobDescription() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobDescription ( Aws::String &&  value)
inline

The job description provided when initiating the job.

Definition at line 105 of file GlacierJobDescription.h.

◆ SetJobDescription() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobDescription ( const char *  value)
inline

The job description provided when initiating the job.

Definition at line 110 of file GlacierJobDescription.h.

◆ SetJobId() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobId ( const Aws::String value)
inline

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 59 of file GlacierJobDescription.h.

◆ SetJobId() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobId ( Aws::String &&  value)
inline

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 64 of file GlacierJobDescription.h.

◆ SetJobId() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobId ( const char *  value)
inline

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 69 of file GlacierJobDescription.h.

◆ SetJobOutputPath() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobOutputPath ( const Aws::String value)
inline

Contains the job output location.

Definition at line 923 of file GlacierJobDescription.h.

◆ SetJobOutputPath() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobOutputPath ( Aws::String &&  value)
inline

Contains the job output location.

Definition at line 928 of file GlacierJobDescription.h.

◆ SetJobOutputPath() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetJobOutputPath ( const char *  value)
inline

Contains the job output location.

Definition at line 933 of file GlacierJobDescription.h.

◆ SetOutputLocation() [1/2]

void Aws::Glacier::Model::GlacierJobDescription::SetOutputLocation ( const OutputLocation value)
inline

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

Definition at line 995 of file GlacierJobDescription.h.

◆ SetOutputLocation() [2/2]

void Aws::Glacier::Model::GlacierJobDescription::SetOutputLocation ( OutputLocation &&  value)
inline

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

Definition at line 1000 of file GlacierJobDescription.h.

◆ SetRetrievalByteRange() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetRetrievalByteRange ( const Aws::String value)
inline

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.

Definition at line 769 of file GlacierJobDescription.h.

◆ SetRetrievalByteRange() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetRetrievalByteRange ( Aws::String &&  value)
inline

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.

Definition at line 779 of file GlacierJobDescription.h.

◆ SetRetrievalByteRange() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetRetrievalByteRange ( const char *  value)
inline

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.

Definition at line 789 of file GlacierJobDescription.h.

◆ SetSelectParameters() [1/2]

void Aws::Glacier::Model::GlacierJobDescription::SetSelectParameters ( const SelectParameters value)
inline

Contains the parameters used for a select.

Definition at line 964 of file GlacierJobDescription.h.

◆ SetSelectParameters() [2/2]

void Aws::Glacier::Model::GlacierJobDescription::SetSelectParameters ( SelectParameters &&  value)
inline

Contains the parameters used for a select.

Definition at line 969 of file GlacierJobDescription.h.

◆ SetSHA256TreeHash() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetSHA256TreeHash ( const Aws::String value)
inline

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

Definition at line 614 of file GlacierJobDescription.h.

◆ SetSHA256TreeHash() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetSHA256TreeHash ( Aws::String &&  value)
inline

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

Definition at line 629 of file GlacierJobDescription.h.

◆ SetSHA256TreeHash() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetSHA256TreeHash ( const char *  value)
inline

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

Definition at line 644 of file GlacierJobDescription.h.

◆ SetSNSTopic() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetSNSTopic ( const Aws::String value)
inline

An Amazon SNS topic that receives notification.

Definition at line 494 of file GlacierJobDescription.h.

◆ SetSNSTopic() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetSNSTopic ( Aws::String &&  value)
inline

An Amazon SNS topic that receives notification.

Definition at line 499 of file GlacierJobDescription.h.

◆ SetSNSTopic() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetSNSTopic ( const char *  value)
inline

An Amazon SNS topic that receives notification.

Definition at line 504 of file GlacierJobDescription.h.

◆ SetStatusCode() [1/2]

void Aws::Glacier::Model::GlacierJobDescription::SetStatusCode ( const StatusCode value)
inline

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

Definition at line 361 of file GlacierJobDescription.h.

◆ SetStatusCode() [2/2]

void Aws::Glacier::Model::GlacierJobDescription::SetStatusCode ( StatusCode &&  value)
inline

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

Definition at line 367 of file GlacierJobDescription.h.

◆ SetStatusMessage() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetStatusMessage ( const Aws::String value)
inline

A friendly message that describes the job status.

Definition at line 395 of file GlacierJobDescription.h.

◆ SetStatusMessage() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetStatusMessage ( Aws::String &&  value)
inline

A friendly message that describes the job status.

Definition at line 400 of file GlacierJobDescription.h.

◆ SetStatusMessage() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetStatusMessage ( const char *  value)
inline

A friendly message that describes the job status.

Definition at line 405 of file GlacierJobDescription.h.

◆ SetTier() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetTier ( const Aws::String value)
inline

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

Definition at line 841 of file GlacierJobDescription.h.

◆ SetTier() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetTier ( Aws::String &&  value)
inline

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

Definition at line 848 of file GlacierJobDescription.h.

◆ SetTier() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetTier ( const char *  value)
inline

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

Definition at line 855 of file GlacierJobDescription.h.

◆ SetVaultARN() [1/3]

void Aws::Glacier::Model::GlacierJobDescription::SetVaultARN ( const Aws::String value)
inline

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

Definition at line 230 of file GlacierJobDescription.h.

◆ SetVaultARN() [2/3]

void Aws::Glacier::Model::GlacierJobDescription::SetVaultARN ( Aws::String &&  value)
inline

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

Definition at line 236 of file GlacierJobDescription.h.

◆ SetVaultARN() [3/3]

void Aws::Glacier::Model::GlacierJobDescription::SetVaultARN ( const char *  value)
inline

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

Definition at line 242 of file GlacierJobDescription.h.

◆ SHA256TreeHashHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::SHA256TreeHashHasBeenSet ( ) const
inline

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

Definition at line 599 of file GlacierJobDescription.h.

◆ SNSTopicHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::SNSTopicHasBeenSet ( ) const
inline

An Amazon SNS topic that receives notification.

Definition at line 489 of file GlacierJobDescription.h.

◆ StatusCodeHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::StatusCodeHasBeenSet ( ) const
inline

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

Definition at line 355 of file GlacierJobDescription.h.

◆ StatusMessageHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::StatusMessageHasBeenSet ( ) const
inline

A friendly message that describes the job status.

Definition at line 390 of file GlacierJobDescription.h.

◆ TierHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::TierHasBeenSet ( ) const
inline

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

Definition at line 834 of file GlacierJobDescription.h.

◆ VaultARNHasBeenSet()

bool Aws::Glacier::Model::GlacierJobDescription::VaultARNHasBeenSet ( ) const
inline

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

Definition at line 224 of file GlacierJobDescription.h.

◆ WithAction() [1/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithAction ( const ActionCode value)
inline

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

Definition at line 156 of file GlacierJobDescription.h.

◆ WithAction() [2/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithAction ( ActionCode &&  value)
inline

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

Definition at line 162 of file GlacierJobDescription.h.

◆ WithArchiveId() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithArchiveId ( const Aws::String value)
inline

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

Definition at line 199 of file GlacierJobDescription.h.

◆ WithArchiveId() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithArchiveId ( Aws::String &&  value)
inline

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

Definition at line 205 of file GlacierJobDescription.h.

◆ WithArchiveId() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithArchiveId ( const char *  value)
inline

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

Definition at line 211 of file GlacierJobDescription.h.

◆ WithArchiveSHA256TreeHash() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithArchiveSHA256TreeHash ( const Aws::String value)
inline

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

Definition at line 726 of file GlacierJobDescription.h.

◆ WithArchiveSHA256TreeHash() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithArchiveSHA256TreeHash ( Aws::String &&  value)
inline

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

Definition at line 732 of file GlacierJobDescription.h.

◆ WithArchiveSHA256TreeHash() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithArchiveSHA256TreeHash ( const char *  value)
inline

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

Definition at line 738 of file GlacierJobDescription.h.

◆ WithArchiveSizeInBytes()

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithArchiveSizeInBytes ( long long  value)
inline

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.

Definition at line 449 of file GlacierJobDescription.h.

◆ WithCompleted()

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithCompleted ( bool  value)
inline

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

Definition at line 342 of file GlacierJobDescription.h.

◆ WithCompletionDate() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithCompletionDate ( const Aws::String value)
inline

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

Definition at line 556 of file GlacierJobDescription.h.

◆ WithCompletionDate() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithCompletionDate ( Aws::String &&  value)
inline

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

Definition at line 562 of file GlacierJobDescription.h.

◆ WithCompletionDate() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithCompletionDate ( const char *  value)
inline

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

Definition at line 568 of file GlacierJobDescription.h.

◆ WithCreationDate() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithCreationDate ( const Aws::String value)
inline

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

Definition at line 303 of file GlacierJobDescription.h.

◆ WithCreationDate() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithCreationDate ( Aws::String &&  value)
inline

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

Definition at line 310 of file GlacierJobDescription.h.

◆ WithCreationDate() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithCreationDate ( const char *  value)
inline

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

Definition at line 317 of file GlacierJobDescription.h.

◆ WithInventoryRetrievalParameters() [1/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithInventoryRetrievalParameters ( const InventoryRetrievalJobDescription value)
inline

Parameters used for range inventory retrieval.

Definition at line 902 of file GlacierJobDescription.h.

◆ WithInventoryRetrievalParameters() [2/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithInventoryRetrievalParameters ( InventoryRetrievalJobDescription &&  value)
inline

Parameters used for range inventory retrieval.

Definition at line 907 of file GlacierJobDescription.h.

◆ WithInventorySizeInBytes()

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithInventorySizeInBytes ( long long  value)
inline

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.

Definition at line 478 of file GlacierJobDescription.h.

◆ WithJobDescription() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobDescription ( const Aws::String value)
inline

The job description provided when initiating the job.

Definition at line 115 of file GlacierJobDescription.h.

◆ WithJobDescription() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobDescription ( Aws::String &&  value)
inline

The job description provided when initiating the job.

Definition at line 120 of file GlacierJobDescription.h.

◆ WithJobDescription() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobDescription ( const char *  value)
inline

The job description provided when initiating the job.

Definition at line 125 of file GlacierJobDescription.h.

◆ WithJobId() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobId ( const Aws::String value)
inline

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 74 of file GlacierJobDescription.h.

◆ WithJobId() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobId ( Aws::String &&  value)
inline

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 79 of file GlacierJobDescription.h.

◆ WithJobId() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobId ( const char *  value)
inline

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 84 of file GlacierJobDescription.h.

◆ WithJobOutputPath() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobOutputPath ( const Aws::String value)
inline

Contains the job output location.

Definition at line 938 of file GlacierJobDescription.h.

◆ WithJobOutputPath() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobOutputPath ( Aws::String &&  value)
inline

Contains the job output location.

Definition at line 943 of file GlacierJobDescription.h.

◆ WithJobOutputPath() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithJobOutputPath ( const char *  value)
inline

Contains the job output location.

Definition at line 948 of file GlacierJobDescription.h.

◆ WithOutputLocation() [1/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithOutputLocation ( const OutputLocation value)
inline

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

Definition at line 1005 of file GlacierJobDescription.h.

◆ WithOutputLocation() [2/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithOutputLocation ( OutputLocation &&  value)
inline

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

Definition at line 1010 of file GlacierJobDescription.h.

◆ WithRetrievalByteRange() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithRetrievalByteRange ( const Aws::String value)
inline

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.

Definition at line 799 of file GlacierJobDescription.h.

◆ WithRetrievalByteRange() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithRetrievalByteRange ( Aws::String &&  value)
inline

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.

Definition at line 809 of file GlacierJobDescription.h.

◆ WithRetrievalByteRange() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithRetrievalByteRange ( const char *  value)
inline

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.

Definition at line 819 of file GlacierJobDescription.h.

◆ WithSelectParameters() [1/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithSelectParameters ( const SelectParameters value)
inline

Contains the parameters used for a select.

Definition at line 974 of file GlacierJobDescription.h.

◆ WithSelectParameters() [2/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithSelectParameters ( SelectParameters &&  value)
inline

Contains the parameters used for a select.

Definition at line 979 of file GlacierJobDescription.h.

◆ WithSHA256TreeHash() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithSHA256TreeHash ( const Aws::String value)
inline

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

Definition at line 659 of file GlacierJobDescription.h.

◆ WithSHA256TreeHash() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithSHA256TreeHash ( Aws::String &&  value)
inline

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

Definition at line 674 of file GlacierJobDescription.h.

◆ WithSHA256TreeHash() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithSHA256TreeHash ( const char *  value)
inline

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

Definition at line 689 of file GlacierJobDescription.h.

◆ WithSNSTopic() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithSNSTopic ( const Aws::String value)
inline

An Amazon SNS topic that receives notification.

Definition at line 509 of file GlacierJobDescription.h.

◆ WithSNSTopic() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithSNSTopic ( Aws::String &&  value)
inline

An Amazon SNS topic that receives notification.

Definition at line 514 of file GlacierJobDescription.h.

◆ WithSNSTopic() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithSNSTopic ( const char *  value)
inline

An Amazon SNS topic that receives notification.

Definition at line 519 of file GlacierJobDescription.h.

◆ WithStatusCode() [1/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithStatusCode ( const StatusCode value)
inline

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

Definition at line 373 of file GlacierJobDescription.h.

◆ WithStatusCode() [2/2]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithStatusCode ( StatusCode &&  value)
inline

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

Definition at line 379 of file GlacierJobDescription.h.

◆ WithStatusMessage() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithStatusMessage ( const Aws::String value)
inline

A friendly message that describes the job status.

Definition at line 410 of file GlacierJobDescription.h.

◆ WithStatusMessage() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithStatusMessage ( Aws::String &&  value)
inline

A friendly message that describes the job status.

Definition at line 415 of file GlacierJobDescription.h.

◆ WithStatusMessage() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithStatusMessage ( const char *  value)
inline

A friendly message that describes the job status.

Definition at line 420 of file GlacierJobDescription.h.

◆ WithTier() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithTier ( const Aws::String value)
inline

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

Definition at line 862 of file GlacierJobDescription.h.

◆ WithTier() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithTier ( Aws::String &&  value)
inline

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

Definition at line 869 of file GlacierJobDescription.h.

◆ WithTier() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithTier ( const char *  value)
inline

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

Definition at line 876 of file GlacierJobDescription.h.

◆ WithVaultARN() [1/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithVaultARN ( const Aws::String value)
inline

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

Definition at line 248 of file GlacierJobDescription.h.

◆ WithVaultARN() [2/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithVaultARN ( Aws::String &&  value)
inline

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

Definition at line 254 of file GlacierJobDescription.h.

◆ WithVaultARN() [3/3]

GlacierJobDescription& Aws::Glacier::Model::GlacierJobDescription::WithVaultARN ( const char *  value)
inline

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

Definition at line 260 of file GlacierJobDescription.h.


The documentation for this class was generated from the following file: