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

#include <GetJobOutputResult.h>

Public Member Functions

 GetJobOutputResult ()
 
 GetJobOutputResult (GetJobOutputResult &&)
 
GetJobOutputResultoperator= (GetJobOutputResult &&)
 
 GetJobOutputResult (const GetJobOutputResult &)=delete
 
GetJobOutputResultoperator= (const GetJobOutputResult &)=delete
 
 GetJobOutputResult (Aws::AmazonWebServiceResult< Aws::Utils::Stream::ResponseStream > &&result)
 
GetJobOutputResultoperator= (Aws::AmazonWebServiceResult< Aws::Utils::Stream::ResponseStream > &&result)
 
Aws::IOStreamGetBody ()
 
void ReplaceBody (Aws::IOStream *body)
 
const Aws::StringGetChecksum () const
 
void SetChecksum (const Aws::String &value)
 
void SetChecksum (Aws::String &&value)
 
void SetChecksum (const char *value)
 
GetJobOutputResultWithChecksum (const Aws::String &value)
 
GetJobOutputResultWithChecksum (Aws::String &&value)
 
GetJobOutputResultWithChecksum (const char *value)
 
int GetStatus () const
 
void SetStatus (int value)
 
GetJobOutputResultWithStatus (int value)
 
const Aws::StringGetContentRange () const
 
void SetContentRange (const Aws::String &value)
 
void SetContentRange (Aws::String &&value)
 
void SetContentRange (const char *value)
 
GetJobOutputResultWithContentRange (const Aws::String &value)
 
GetJobOutputResultWithContentRange (Aws::String &&value)
 
GetJobOutputResultWithContentRange (const char *value)
 
const Aws::StringGetAcceptRanges () const
 
void SetAcceptRanges (const Aws::String &value)
 
void SetAcceptRanges (Aws::String &&value)
 
void SetAcceptRanges (const char *value)
 
GetJobOutputResultWithAcceptRanges (const Aws::String &value)
 
GetJobOutputResultWithAcceptRanges (Aws::String &&value)
 
GetJobOutputResultWithAcceptRanges (const char *value)
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &value)
 
void SetContentType (Aws::String &&value)
 
void SetContentType (const char *value)
 
GetJobOutputResultWithContentType (const Aws::String &value)
 
GetJobOutputResultWithContentType (Aws::String &&value)
 
GetJobOutputResultWithContentType (const char *value)
 
const Aws::StringGetArchiveDescription () const
 
void SetArchiveDescription (const Aws::String &value)
 
void SetArchiveDescription (Aws::String &&value)
 
void SetArchiveDescription (const char *value)
 
GetJobOutputResultWithArchiveDescription (const Aws::String &value)
 
GetJobOutputResultWithArchiveDescription (Aws::String &&value)
 
GetJobOutputResultWithArchiveDescription (const char *value)
 

Detailed Description

Contains the Amazon S3 Glacier response to your request.

See Also:

AWS API Reference

Definition at line 28 of file GetJobOutputResult.h.

Constructor & Destructor Documentation

◆ GetJobOutputResult() [1/4]

Aws::Glacier::Model::GetJobOutputResult::GetJobOutputResult ( )

◆ GetJobOutputResult() [2/4]

Aws::Glacier::Model::GetJobOutputResult::GetJobOutputResult ( GetJobOutputResult &&  )

◆ GetJobOutputResult() [3/4]

Aws::Glacier::Model::GetJobOutputResult::GetJobOutputResult ( const GetJobOutputResult )
delete

◆ GetJobOutputResult() [4/4]

Aws::Glacier::Model::GetJobOutputResult::GetJobOutputResult ( Aws::AmazonWebServiceResult< Aws::Utils::Stream::ResponseStream > &&  result)

Member Function Documentation

◆ GetAcceptRanges()

const Aws::String& Aws::Glacier::Model::GetJobOutputResult::GetAcceptRanges ( ) const
inline

Indicates the range units accepted. For more information, see RFC2616.

Definition at line 243 of file GetJobOutputResult.h.

◆ GetArchiveDescription()

const Aws::String& Aws::Glacier::Model::GetJobOutputResult::GetArchiveDescription ( ) const
inline

The description of an archive.

Definition at line 349 of file GetJobOutputResult.h.

◆ GetBody()

Aws::IOStream& Aws::Glacier::Model::GetJobOutputResult::GetBody ( )
inline

The job data, either archive data or inventory data.

Definition at line 49 of file GetJobOutputResult.h.

◆ GetChecksum()

const Aws::String& Aws::Glacier::Model::GetJobOutputResult::GetChecksum ( ) const
inline

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

Definition at line 71 of file GetJobOutputResult.h.

◆ GetContentRange()

const Aws::String& Aws::Glacier::Model::GetJobOutputResult::GetContentRange ( ) const
inline

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

Definition at line 194 of file GetJobOutputResult.h.

◆ GetContentType()

const Aws::String& Aws::Glacier::Model::GetJobOutputResult::GetContentType ( ) const
inline

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

Definition at line 289 of file GetJobOutputResult.h.

◆ GetStatus()

int Aws::Glacier::Model::GetJobOutputResult::GetStatus ( ) const
inline

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

Definition at line 174 of file GetJobOutputResult.h.

◆ operator=() [1/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::operator= ( GetJobOutputResult &&  )

◆ operator=() [2/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::operator= ( const GetJobOutputResult )
delete

◆ operator=() [3/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::operator= ( Aws::AmazonWebServiceResult< Aws::Utils::Stream::ResponseStream > &&  result)

◆ ReplaceBody()

void Aws::Glacier::Model::GetJobOutputResult::ReplaceBody ( Aws::IOStream body)
inline

The job data, either archive data or inventory data.

Definition at line 54 of file GetJobOutputResult.h.

◆ SetAcceptRanges() [1/3]

void Aws::Glacier::Model::GetJobOutputResult::SetAcceptRanges ( const Aws::String value)
inline

Indicates the range units accepted. For more information, see RFC2616.

Definition at line 249 of file GetJobOutputResult.h.

◆ SetAcceptRanges() [2/3]

void Aws::Glacier::Model::GetJobOutputResult::SetAcceptRanges ( Aws::String &&  value)
inline

Indicates the range units accepted. For more information, see RFC2616.

Definition at line 255 of file GetJobOutputResult.h.

◆ SetAcceptRanges() [3/3]

void Aws::Glacier::Model::GetJobOutputResult::SetAcceptRanges ( const char *  value)
inline

Indicates the range units accepted. For more information, see RFC2616.

Definition at line 261 of file GetJobOutputResult.h.

◆ SetArchiveDescription() [1/3]

void Aws::Glacier::Model::GetJobOutputResult::SetArchiveDescription ( const Aws::String value)
inline

The description of an archive.

Definition at line 354 of file GetJobOutputResult.h.

◆ SetArchiveDescription() [2/3]

void Aws::Glacier::Model::GetJobOutputResult::SetArchiveDescription ( Aws::String &&  value)
inline

The description of an archive.

Definition at line 359 of file GetJobOutputResult.h.

◆ SetArchiveDescription() [3/3]

void Aws::Glacier::Model::GetJobOutputResult::SetArchiveDescription ( const char *  value)
inline

The description of an archive.

Definition at line 364 of file GetJobOutputResult.h.

◆ SetChecksum() [1/3]

void Aws::Glacier::Model::GetJobOutputResult::SetChecksum ( const Aws::String value)
inline

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

Definition at line 87 of file GetJobOutputResult.h.

◆ SetChecksum() [2/3]

void Aws::Glacier::Model::GetJobOutputResult::SetChecksum ( Aws::String &&  value)
inline

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

Definition at line 103 of file GetJobOutputResult.h.

◆ SetChecksum() [3/3]

void Aws::Glacier::Model::GetJobOutputResult::SetChecksum ( const char *  value)
inline

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

Definition at line 119 of file GetJobOutputResult.h.

◆ SetContentRange() [1/3]

void Aws::Glacier::Model::GetJobOutputResult::SetContentRange ( const Aws::String value)
inline

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

Definition at line 201 of file GetJobOutputResult.h.

◆ SetContentRange() [2/3]

void Aws::Glacier::Model::GetJobOutputResult::SetContentRange ( Aws::String &&  value)
inline

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

Definition at line 208 of file GetJobOutputResult.h.

◆ SetContentRange() [3/3]

void Aws::Glacier::Model::GetJobOutputResult::SetContentRange ( const char *  value)
inline

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

Definition at line 215 of file GetJobOutputResult.h.

◆ SetContentType() [1/3]

void Aws::Glacier::Model::GetJobOutputResult::SetContentType ( const Aws::String value)
inline

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

Definition at line 298 of file GetJobOutputResult.h.

◆ SetContentType() [2/3]

void Aws::Glacier::Model::GetJobOutputResult::SetContentType ( Aws::String &&  value)
inline

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

Definition at line 307 of file GetJobOutputResult.h.

◆ SetContentType() [3/3]

void Aws::Glacier::Model::GetJobOutputResult::SetContentType ( const char *  value)
inline

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

Definition at line 316 of file GetJobOutputResult.h.

◆ SetStatus()

void Aws::Glacier::Model::GetJobOutputResult::SetStatus ( int  value)
inline

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

Definition at line 180 of file GetJobOutputResult.h.

◆ WithAcceptRanges() [1/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithAcceptRanges ( const Aws::String value)
inline

Indicates the range units accepted. For more information, see RFC2616.

Definition at line 267 of file GetJobOutputResult.h.

◆ WithAcceptRanges() [2/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithAcceptRanges ( Aws::String &&  value)
inline

Indicates the range units accepted. For more information, see RFC2616.

Definition at line 273 of file GetJobOutputResult.h.

◆ WithAcceptRanges() [3/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithAcceptRanges ( const char *  value)
inline

Indicates the range units accepted. For more information, see RFC2616.

Definition at line 279 of file GetJobOutputResult.h.

◆ WithArchiveDescription() [1/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithArchiveDescription ( const Aws::String value)
inline

The description of an archive.

Definition at line 369 of file GetJobOutputResult.h.

◆ WithArchiveDescription() [2/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithArchiveDescription ( Aws::String &&  value)
inline

The description of an archive.

Definition at line 374 of file GetJobOutputResult.h.

◆ WithArchiveDescription() [3/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithArchiveDescription ( const char *  value)
inline

The description of an archive.

Definition at line 379 of file GetJobOutputResult.h.

◆ WithChecksum() [1/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithChecksum ( const Aws::String value)
inline

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

Definition at line 135 of file GetJobOutputResult.h.

◆ WithChecksum() [2/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithChecksum ( Aws::String &&  value)
inline

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

Definition at line 151 of file GetJobOutputResult.h.

◆ WithChecksum() [3/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithChecksum ( const char *  value)
inline

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

Definition at line 167 of file GetJobOutputResult.h.

◆ WithContentRange() [1/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithContentRange ( const Aws::String value)
inline

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

Definition at line 222 of file GetJobOutputResult.h.

◆ WithContentRange() [2/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithContentRange ( Aws::String &&  value)
inline

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

Definition at line 229 of file GetJobOutputResult.h.

◆ WithContentRange() [3/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithContentRange ( const char *  value)
inline

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

Definition at line 236 of file GetJobOutputResult.h.

◆ WithContentType() [1/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithContentType ( const Aws::String value)
inline

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

Definition at line 325 of file GetJobOutputResult.h.

◆ WithContentType() [2/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithContentType ( Aws::String &&  value)
inline

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

Definition at line 334 of file GetJobOutputResult.h.

◆ WithContentType() [3/3]

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithContentType ( const char *  value)
inline

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

Definition at line 343 of file GetJobOutputResult.h.

◆ WithStatus()

GetJobOutputResult& Aws::Glacier::Model::GetJobOutputResult::WithStatus ( int  value)
inline

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

Definition at line 186 of file GetJobOutputResult.h.


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