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

#include <DescribeJobResult.h>

Public Member Functions

 DescribeJobResult ()
 
 DescribeJobResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeJobResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetJobId () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
DescribeJobResultWithJobId (const Aws::String &value)
 
DescribeJobResultWithJobId (Aws::String &&value)
 
DescribeJobResultWithJobId (const char *value)
 
const Aws::StringGetJobDescription () const
 
void SetJobDescription (const Aws::String &value)
 
void SetJobDescription (Aws::String &&value)
 
void SetJobDescription (const char *value)
 
DescribeJobResultWithJobDescription (const Aws::String &value)
 
DescribeJobResultWithJobDescription (Aws::String &&value)
 
DescribeJobResultWithJobDescription (const char *value)
 
const ActionCodeGetAction () const
 
void SetAction (const ActionCode &value)
 
void SetAction (ActionCode &&value)
 
DescribeJobResultWithAction (const ActionCode &value)
 
DescribeJobResultWithAction (ActionCode &&value)
 
const Aws::StringGetArchiveId () const
 
void SetArchiveId (const Aws::String &value)
 
void SetArchiveId (Aws::String &&value)
 
void SetArchiveId (const char *value)
 
DescribeJobResultWithArchiveId (const Aws::String &value)
 
DescribeJobResultWithArchiveId (Aws::String &&value)
 
DescribeJobResultWithArchiveId (const char *value)
 
const Aws::StringGetVaultARN () const
 
void SetVaultARN (const Aws::String &value)
 
void SetVaultARN (Aws::String &&value)
 
void SetVaultARN (const char *value)
 
DescribeJobResultWithVaultARN (const Aws::String &value)
 
DescribeJobResultWithVaultARN (Aws::String &&value)
 
DescribeJobResultWithVaultARN (const char *value)
 
const Aws::StringGetCreationDate () const
 
void SetCreationDate (const Aws::String &value)
 
void SetCreationDate (Aws::String &&value)
 
void SetCreationDate (const char *value)
 
DescribeJobResultWithCreationDate (const Aws::String &value)
 
DescribeJobResultWithCreationDate (Aws::String &&value)
 
DescribeJobResultWithCreationDate (const char *value)
 
bool GetCompleted () const
 
void SetCompleted (bool value)
 
DescribeJobResultWithCompleted (bool value)
 
const StatusCodeGetStatusCode () const
 
void SetStatusCode (const StatusCode &value)
 
void SetStatusCode (StatusCode &&value)
 
DescribeJobResultWithStatusCode (const StatusCode &value)
 
DescribeJobResultWithStatusCode (StatusCode &&value)
 
const Aws::StringGetStatusMessage () const
 
void SetStatusMessage (const Aws::String &value)
 
void SetStatusMessage (Aws::String &&value)
 
void SetStatusMessage (const char *value)
 
DescribeJobResultWithStatusMessage (const Aws::String &value)
 
DescribeJobResultWithStatusMessage (Aws::String &&value)
 
DescribeJobResultWithStatusMessage (const char *value)
 
long long GetArchiveSizeInBytes () const
 
void SetArchiveSizeInBytes (long long value)
 
DescribeJobResultWithArchiveSizeInBytes (long long value)
 
long long GetInventorySizeInBytes () const
 
void SetInventorySizeInBytes (long long value)
 
DescribeJobResultWithInventorySizeInBytes (long long value)
 
const Aws::StringGetSNSTopic () const
 
void SetSNSTopic (const Aws::String &value)
 
void SetSNSTopic (Aws::String &&value)
 
void SetSNSTopic (const char *value)
 
DescribeJobResultWithSNSTopic (const Aws::String &value)
 
DescribeJobResultWithSNSTopic (Aws::String &&value)
 
DescribeJobResultWithSNSTopic (const char *value)
 
const Aws::StringGetCompletionDate () const
 
void SetCompletionDate (const Aws::String &value)
 
void SetCompletionDate (Aws::String &&value)
 
void SetCompletionDate (const char *value)
 
DescribeJobResultWithCompletionDate (const Aws::String &value)
 
DescribeJobResultWithCompletionDate (Aws::String &&value)
 
DescribeJobResultWithCompletionDate (const char *value)
 
const Aws::StringGetSHA256TreeHash () const
 
void SetSHA256TreeHash (const Aws::String &value)
 
void SetSHA256TreeHash (Aws::String &&value)
 
void SetSHA256TreeHash (const char *value)
 
DescribeJobResultWithSHA256TreeHash (const Aws::String &value)
 
DescribeJobResultWithSHA256TreeHash (Aws::String &&value)
 
DescribeJobResultWithSHA256TreeHash (const char *value)
 
const Aws::StringGetArchiveSHA256TreeHash () const
 
void SetArchiveSHA256TreeHash (const Aws::String &value)
 
void SetArchiveSHA256TreeHash (Aws::String &&value)
 
void SetArchiveSHA256TreeHash (const char *value)
 
DescribeJobResultWithArchiveSHA256TreeHash (const Aws::String &value)
 
DescribeJobResultWithArchiveSHA256TreeHash (Aws::String &&value)
 
DescribeJobResultWithArchiveSHA256TreeHash (const char *value)
 
const Aws::StringGetRetrievalByteRange () const
 
void SetRetrievalByteRange (const Aws::String &value)
 
void SetRetrievalByteRange (Aws::String &&value)
 
void SetRetrievalByteRange (const char *value)
 
DescribeJobResultWithRetrievalByteRange (const Aws::String &value)
 
DescribeJobResultWithRetrievalByteRange (Aws::String &&value)
 
DescribeJobResultWithRetrievalByteRange (const char *value)
 
const Aws::StringGetTier () const
 
void SetTier (const Aws::String &value)
 
void SetTier (Aws::String &&value)
 
void SetTier (const char *value)
 
DescribeJobResultWithTier (const Aws::String &value)
 
DescribeJobResultWithTier (Aws::String &&value)
 
DescribeJobResultWithTier (const char *value)
 
const InventoryRetrievalJobDescriptionGetInventoryRetrievalParameters () const
 
void SetInventoryRetrievalParameters (const InventoryRetrievalJobDescription &value)
 
void SetInventoryRetrievalParameters (InventoryRetrievalJobDescription &&value)
 
DescribeJobResultWithInventoryRetrievalParameters (const InventoryRetrievalJobDescription &value)
 
DescribeJobResultWithInventoryRetrievalParameters (InventoryRetrievalJobDescription &&value)
 
const Aws::StringGetJobOutputPath () const
 
void SetJobOutputPath (const Aws::String &value)
 
void SetJobOutputPath (Aws::String &&value)
 
void SetJobOutputPath (const char *value)
 
DescribeJobResultWithJobOutputPath (const Aws::String &value)
 
DescribeJobResultWithJobOutputPath (Aws::String &&value)
 
DescribeJobResultWithJobOutputPath (const char *value)
 
const SelectParametersGetSelectParameters () const
 
void SetSelectParameters (const SelectParameters &value)
 
void SetSelectParameters (SelectParameters &&value)
 
DescribeJobResultWithSelectParameters (const SelectParameters &value)
 
DescribeJobResultWithSelectParameters (SelectParameters &&value)
 
const OutputLocationGetOutputLocation () const
 
void SetOutputLocation (const OutputLocation &value)
 
void SetOutputLocation (OutputLocation &&value)
 
DescribeJobResultWithOutputLocation (const OutputLocation &value)
 
DescribeJobResultWithOutputLocation (OutputLocation &&value)
 

Detailed Description

Contains the description of an Amazon S3 Glacier job.

See Also:

AWS API Reference

Definition at line 38 of file DescribeJobResult.h.

Constructor & Destructor Documentation

◆ DescribeJobResult() [1/2]

Aws::Glacier::Model::DescribeJobResult::DescribeJobResult ( )

◆ DescribeJobResult() [2/2]

Aws::Glacier::Model::DescribeJobResult::DescribeJobResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetAction()

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

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

Definition at line 122 of file DescribeJobResult.h.

◆ GetArchiveId()

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

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

Definition at line 153 of file DescribeJobResult.h.

◆ GetArchiveSHA256TreeHash()

const Aws::String& Aws::Glacier::Model::DescribeJobResult::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 604 of file DescribeJobResult.h.

◆ GetArchiveSizeInBytes()

long long Aws::Glacier::Model::DescribeJobResult::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 376 of file DescribeJobResult.h.

◆ GetCompleted()

bool Aws::Glacier::Model::DescribeJobResult::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 289 of file DescribeJobResult.h.

◆ GetCompletionDate()

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

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

Definition at line 455 of file DescribeJobResult.h.

◆ GetCreationDate()

const Aws::String& Aws::Glacier::Model::DescribeJobResult::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 240 of file DescribeJobResult.h.

◆ GetInventoryRetrievalParameters()

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

Parameters used for range inventory retrieval.

Definition at line 767 of file DescribeJobResult.h.

◆ GetInventorySizeInBytes()

long long Aws::Glacier::Model::DescribeJobResult::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 398 of file DescribeJobResult.h.

◆ GetJobDescription()

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

The job description provided when initiating the job.

Definition at line 85 of file DescribeJobResult.h.

◆ GetJobId()

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

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 49 of file DescribeJobResult.h.

◆ GetJobOutputPath()

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

Contains the job output location.

Definition at line 793 of file DescribeJobResult.h.

◆ GetOutputLocation()

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

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

Definition at line 855 of file DescribeJobResult.h.

◆ GetRetrievalByteRange()

const Aws::String& Aws::Glacier::Model::DescribeJobResult::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 651 of file DescribeJobResult.h.

◆ GetSelectParameters()

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

Contains the parameters used for a select.

Definition at line 829 of file DescribeJobResult.h.

◆ GetSHA256TreeHash()

const Aws::String& Aws::Glacier::Model::DescribeJobResult::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 507 of file DescribeJobResult.h.

◆ GetSNSTopic()

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

An Amazon SNS topic that receives notification.

Definition at line 418 of file DescribeJobResult.h.

◆ GetStatusCode()

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

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

Definition at line 308 of file DescribeJobResult.h.

◆ GetStatusMessage()

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

A friendly message that describes the job status.

Definition at line 338 of file DescribeJobResult.h.

◆ GetTier()

const Aws::String& Aws::Glacier::Model::DescribeJobResult::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 719 of file DescribeJobResult.h.

◆ GetVaultARN()

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

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

Definition at line 196 of file DescribeJobResult.h.

◆ operator=()

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetAction() [1/2]

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

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

Definition at line 128 of file DescribeJobResult.h.

◆ SetAction() [2/2]

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

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

Definition at line 134 of file DescribeJobResult.h.

◆ SetArchiveId() [1/3]

void Aws::Glacier::Model::DescribeJobResult::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 159 of file DescribeJobResult.h.

◆ SetArchiveId() [2/3]

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

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

Definition at line 165 of file DescribeJobResult.h.

◆ SetArchiveId() [3/3]

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

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

Definition at line 171 of file DescribeJobResult.h.

◆ SetArchiveSHA256TreeHash() [1/3]

void Aws::Glacier::Model::DescribeJobResult::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 610 of file DescribeJobResult.h.

◆ SetArchiveSHA256TreeHash() [2/3]

void Aws::Glacier::Model::DescribeJobResult::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 616 of file DescribeJobResult.h.

◆ SetArchiveSHA256TreeHash() [3/3]

void Aws::Glacier::Model::DescribeJobResult::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 622 of file DescribeJobResult.h.

◆ SetArchiveSizeInBytes()

void Aws::Glacier::Model::DescribeJobResult::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 383 of file DescribeJobResult.h.

◆ SetCompleted()

void Aws::Glacier::Model::DescribeJobResult::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 295 of file DescribeJobResult.h.

◆ SetCompletionDate() [1/3]

void Aws::Glacier::Model::DescribeJobResult::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 461 of file DescribeJobResult.h.

◆ SetCompletionDate() [2/3]

void Aws::Glacier::Model::DescribeJobResult::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 467 of file DescribeJobResult.h.

◆ SetCompletionDate() [3/3]

void Aws::Glacier::Model::DescribeJobResult::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 473 of file DescribeJobResult.h.

◆ SetCreationDate() [1/3]

void Aws::Glacier::Model::DescribeJobResult::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 247 of file DescribeJobResult.h.

◆ SetCreationDate() [2/3]

void Aws::Glacier::Model::DescribeJobResult::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 254 of file DescribeJobResult.h.

◆ SetCreationDate() [3/3]

void Aws::Glacier::Model::DescribeJobResult::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 261 of file DescribeJobResult.h.

◆ SetInventoryRetrievalParameters() [1/2]

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

Parameters used for range inventory retrieval.

Definition at line 772 of file DescribeJobResult.h.

◆ SetInventoryRetrievalParameters() [2/2]

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

Parameters used for range inventory retrieval.

Definition at line 777 of file DescribeJobResult.h.

◆ SetInventorySizeInBytes()

void Aws::Glacier::Model::DescribeJobResult::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 405 of file DescribeJobResult.h.

◆ SetJobDescription() [1/3]

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

The job description provided when initiating the job.

Definition at line 90 of file DescribeJobResult.h.

◆ SetJobDescription() [2/3]

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

The job description provided when initiating the job.

Definition at line 95 of file DescribeJobResult.h.

◆ SetJobDescription() [3/3]

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

The job description provided when initiating the job.

Definition at line 100 of file DescribeJobResult.h.

◆ SetJobId() [1/3]

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

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 54 of file DescribeJobResult.h.

◆ SetJobId() [2/3]

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

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 59 of file DescribeJobResult.h.

◆ SetJobId() [3/3]

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

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 64 of file DescribeJobResult.h.

◆ SetJobOutputPath() [1/3]

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

Contains the job output location.

Definition at line 798 of file DescribeJobResult.h.

◆ SetJobOutputPath() [2/3]

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

Contains the job output location.

Definition at line 803 of file DescribeJobResult.h.

◆ SetJobOutputPath() [3/3]

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

Contains the job output location.

Definition at line 808 of file DescribeJobResult.h.

◆ SetOutputLocation() [1/2]

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

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

Definition at line 860 of file DescribeJobResult.h.

◆ SetOutputLocation() [2/2]

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

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

Definition at line 865 of file DescribeJobResult.h.

◆ SetRetrievalByteRange() [1/3]

void Aws::Glacier::Model::DescribeJobResult::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 661 of file DescribeJobResult.h.

◆ SetRetrievalByteRange() [2/3]

void Aws::Glacier::Model::DescribeJobResult::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 671 of file DescribeJobResult.h.

◆ SetRetrievalByteRange() [3/3]

void Aws::Glacier::Model::DescribeJobResult::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 681 of file DescribeJobResult.h.

◆ SetSelectParameters() [1/2]

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

Contains the parameters used for a select.

Definition at line 834 of file DescribeJobResult.h.

◆ SetSelectParameters() [2/2]

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

Contains the parameters used for a select.

Definition at line 839 of file DescribeJobResult.h.

◆ SetSHA256TreeHash() [1/3]

void Aws::Glacier::Model::DescribeJobResult::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 522 of file DescribeJobResult.h.

◆ SetSHA256TreeHash() [2/3]

void Aws::Glacier::Model::DescribeJobResult::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 537 of file DescribeJobResult.h.

◆ SetSHA256TreeHash() [3/3]

void Aws::Glacier::Model::DescribeJobResult::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 552 of file DescribeJobResult.h.

◆ SetSNSTopic() [1/3]

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

An Amazon SNS topic that receives notification.

Definition at line 423 of file DescribeJobResult.h.

◆ SetSNSTopic() [2/3]

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

An Amazon SNS topic that receives notification.

Definition at line 428 of file DescribeJobResult.h.

◆ SetSNSTopic() [3/3]

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

An Amazon SNS topic that receives notification.

Definition at line 433 of file DescribeJobResult.h.

◆ SetStatusCode() [1/2]

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

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

Definition at line 314 of file DescribeJobResult.h.

◆ SetStatusCode() [2/2]

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

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

Definition at line 320 of file DescribeJobResult.h.

◆ SetStatusMessage() [1/3]

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

A friendly message that describes the job status.

Definition at line 343 of file DescribeJobResult.h.

◆ SetStatusMessage() [2/3]

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

A friendly message that describes the job status.

Definition at line 348 of file DescribeJobResult.h.

◆ SetStatusMessage() [3/3]

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

A friendly message that describes the job status.

Definition at line 353 of file DescribeJobResult.h.

◆ SetTier() [1/3]

void Aws::Glacier::Model::DescribeJobResult::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 726 of file DescribeJobResult.h.

◆ SetTier() [2/3]

void Aws::Glacier::Model::DescribeJobResult::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 733 of file DescribeJobResult.h.

◆ SetTier() [3/3]

void Aws::Glacier::Model::DescribeJobResult::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 740 of file DescribeJobResult.h.

◆ SetVaultARN() [1/3]

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

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

Definition at line 202 of file DescribeJobResult.h.

◆ SetVaultARN() [2/3]

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

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

Definition at line 208 of file DescribeJobResult.h.

◆ SetVaultARN() [3/3]

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

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

Definition at line 214 of file DescribeJobResult.h.

◆ WithAction() [1/2]

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

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

Definition at line 140 of file DescribeJobResult.h.

◆ WithAction() [2/2]

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

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

Definition at line 146 of file DescribeJobResult.h.

◆ WithArchiveId() [1/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 177 of file DescribeJobResult.h.

◆ WithArchiveId() [2/3]

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

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

Definition at line 183 of file DescribeJobResult.h.

◆ WithArchiveId() [3/3]

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

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

Definition at line 189 of file DescribeJobResult.h.

◆ WithArchiveSHA256TreeHash() [1/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 628 of file DescribeJobResult.h.

◆ WithArchiveSHA256TreeHash() [2/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 634 of file DescribeJobResult.h.

◆ WithArchiveSHA256TreeHash() [3/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 640 of file DescribeJobResult.h.

◆ WithArchiveSizeInBytes()

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 390 of file DescribeJobResult.h.

◆ WithCompleted()

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 301 of file DescribeJobResult.h.

◆ WithCompletionDate() [1/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 479 of file DescribeJobResult.h.

◆ WithCompletionDate() [2/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 485 of file DescribeJobResult.h.

◆ WithCompletionDate() [3/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 491 of file DescribeJobResult.h.

◆ WithCreationDate() [1/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 268 of file DescribeJobResult.h.

◆ WithCreationDate() [2/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 275 of file DescribeJobResult.h.

◆ WithCreationDate() [3/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 282 of file DescribeJobResult.h.

◆ WithInventoryRetrievalParameters() [1/2]

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

Parameters used for range inventory retrieval.

Definition at line 782 of file DescribeJobResult.h.

◆ WithInventoryRetrievalParameters() [2/2]

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

Parameters used for range inventory retrieval.

Definition at line 787 of file DescribeJobResult.h.

◆ WithInventorySizeInBytes()

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 412 of file DescribeJobResult.h.

◆ WithJobDescription() [1/3]

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

The job description provided when initiating the job.

Definition at line 105 of file DescribeJobResult.h.

◆ WithJobDescription() [2/3]

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

The job description provided when initiating the job.

Definition at line 110 of file DescribeJobResult.h.

◆ WithJobDescription() [3/3]

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

The job description provided when initiating the job.

Definition at line 115 of file DescribeJobResult.h.

◆ WithJobId() [1/3]

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

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 69 of file DescribeJobResult.h.

◆ WithJobId() [2/3]

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

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 74 of file DescribeJobResult.h.

◆ WithJobId() [3/3]

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

An opaque string that identifies an Amazon S3 Glacier job.

Definition at line 79 of file DescribeJobResult.h.

◆ WithJobOutputPath() [1/3]

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

Contains the job output location.

Definition at line 813 of file DescribeJobResult.h.

◆ WithJobOutputPath() [2/3]

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

Contains the job output location.

Definition at line 818 of file DescribeJobResult.h.

◆ WithJobOutputPath() [3/3]

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

Contains the job output location.

Definition at line 823 of file DescribeJobResult.h.

◆ WithOutputLocation() [1/2]

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

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

Definition at line 870 of file DescribeJobResult.h.

◆ WithOutputLocation() [2/2]

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

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

Definition at line 875 of file DescribeJobResult.h.

◆ WithRetrievalByteRange() [1/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 691 of file DescribeJobResult.h.

◆ WithRetrievalByteRange() [2/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 701 of file DescribeJobResult.h.

◆ WithRetrievalByteRange() [3/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 711 of file DescribeJobResult.h.

◆ WithSelectParameters() [1/2]

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

Contains the parameters used for a select.

Definition at line 844 of file DescribeJobResult.h.

◆ WithSelectParameters() [2/2]

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

Contains the parameters used for a select.

Definition at line 849 of file DescribeJobResult.h.

◆ WithSHA256TreeHash() [1/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 567 of file DescribeJobResult.h.

◆ WithSHA256TreeHash() [2/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 582 of file DescribeJobResult.h.

◆ WithSHA256TreeHash() [3/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 597 of file DescribeJobResult.h.

◆ WithSNSTopic() [1/3]

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

An Amazon SNS topic that receives notification.

Definition at line 438 of file DescribeJobResult.h.

◆ WithSNSTopic() [2/3]

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

An Amazon SNS topic that receives notification.

Definition at line 443 of file DescribeJobResult.h.

◆ WithSNSTopic() [3/3]

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

An Amazon SNS topic that receives notification.

Definition at line 448 of file DescribeJobResult.h.

◆ WithStatusCode() [1/2]

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

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

Definition at line 326 of file DescribeJobResult.h.

◆ WithStatusCode() [2/2]

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

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

Definition at line 332 of file DescribeJobResult.h.

◆ WithStatusMessage() [1/3]

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

A friendly message that describes the job status.

Definition at line 358 of file DescribeJobResult.h.

◆ WithStatusMessage() [2/3]

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

A friendly message that describes the job status.

Definition at line 363 of file DescribeJobResult.h.

◆ WithStatusMessage() [3/3]

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

A friendly message that describes the job status.

Definition at line 368 of file DescribeJobResult.h.

◆ WithTier() [1/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 747 of file DescribeJobResult.h.

◆ WithTier() [2/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 754 of file DescribeJobResult.h.

◆ WithTier() [3/3]

DescribeJobResult& Aws::Glacier::Model::DescribeJobResult::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 761 of file DescribeJobResult.h.

◆ WithVaultARN() [1/3]

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

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

Definition at line 220 of file DescribeJobResult.h.

◆ WithVaultARN() [2/3]

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

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

Definition at line 226 of file DescribeJobResult.h.

◆ WithVaultARN() [3/3]

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

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

Definition at line 232 of file DescribeJobResult.h.


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