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

#include <GetJobOutputRequest.h>

+ Inheritance diagram for Aws::Glacier::Model::GetJobOutputRequest:

Public Member Functions

 GetJobOutputRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAccountId () const
 
bool AccountIdHasBeenSet () const
 
void SetAccountId (const Aws::String &value)
 
void SetAccountId (Aws::String &&value)
 
void SetAccountId (const char *value)
 
GetJobOutputRequestWithAccountId (const Aws::String &value)
 
GetJobOutputRequestWithAccountId (Aws::String &&value)
 
GetJobOutputRequestWithAccountId (const char *value)
 
const Aws::StringGetVaultName () const
 
bool VaultNameHasBeenSet () const
 
void SetVaultName (const Aws::String &value)
 
void SetVaultName (Aws::String &&value)
 
void SetVaultName (const char *value)
 
GetJobOutputRequestWithVaultName (const Aws::String &value)
 
GetJobOutputRequestWithVaultName (Aws::String &&value)
 
GetJobOutputRequestWithVaultName (const char *value)
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
GetJobOutputRequestWithJobId (const Aws::String &value)
 
GetJobOutputRequestWithJobId (Aws::String &&value)
 
GetJobOutputRequestWithJobId (const char *value)
 
const Aws::StringGetRange () const
 
bool RangeHasBeenSet () const
 
void SetRange (const Aws::String &value)
 
void SetRange (Aws::String &&value)
 
void SetRange (const char *value)
 
GetJobOutputRequestWithRange (const Aws::String &value)
 
GetJobOutputRequestWithRange (Aws::String &&value)
 
GetJobOutputRequestWithRange (const char *value)
 
- Public Member Functions inherited from Aws::Glacier::GlacierRequest
virtual ~GlacierRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Provides options for downloading output of an Amazon S3 Glacier job.

See Also:

AWS API Reference

Definition at line 25 of file GetJobOutputRequest.h.

Constructor & Destructor Documentation

◆ GetJobOutputRequest()

Aws::Glacier::Model::GetJobOutputRequest::GetJobOutputRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

bool Aws::Glacier::Model::GetJobOutputRequest::AccountIdHasBeenSet ( ) const
inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 57 of file GetJobOutputRequest.h.

◆ GetAccountId()

const Aws::String& Aws::Glacier::Model::GetJobOutputRequest::GetAccountId ( ) const
inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 48 of file GetJobOutputRequest.h.

◆ GetJobId()

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

The job ID whose data is downloaded.

Definition at line 158 of file GetJobOutputRequest.h.

◆ GetRange()

const Aws::String& Aws::Glacier::Model::GetJobOutputRequest::GetRange ( ) const
inline

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Definition at line 220 of file GetJobOutputRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Glacier::Model::GetJobOutputRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Glacier::GlacierRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Glacier::Model::GetJobOutputRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file GetJobOutputRequest.h.

◆ GetVaultName()

const Aws::String& Aws::Glacier::Model::GetJobOutputRequest::GetVaultName ( ) const
inline

The name of the vault.

Definition at line 117 of file GetJobOutputRequest.h.

◆ JobIdHasBeenSet()

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

The job ID whose data is downloaded.

Definition at line 163 of file GetJobOutputRequest.h.

◆ RangeHasBeenSet()

bool Aws::Glacier::Model::GetJobOutputRequest::RangeHasBeenSet ( ) const
inline

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Definition at line 246 of file GetJobOutputRequest.h.

◆ SerializePayload()

Aws::String Aws::Glacier::Model::GetJobOutputRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetAccountId ( const Aws::String value)
inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 66 of file GetJobOutputRequest.h.

◆ SetAccountId() [2/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetAccountId ( Aws::String &&  value)
inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 75 of file GetJobOutputRequest.h.

◆ SetAccountId() [3/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetAccountId ( const char *  value)
inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 84 of file GetJobOutputRequest.h.

◆ SetJobId() [1/3]

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

The job ID whose data is downloaded.

Definition at line 168 of file GetJobOutputRequest.h.

◆ SetJobId() [2/3]

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

The job ID whose data is downloaded.

Definition at line 173 of file GetJobOutputRequest.h.

◆ SetJobId() [3/3]

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

The job ID whose data is downloaded.

Definition at line 178 of file GetJobOutputRequest.h.

◆ SetRange() [1/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetRange ( const Aws::String value)
inline

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Definition at line 272 of file GetJobOutputRequest.h.

◆ SetRange() [2/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetRange ( Aws::String &&  value)
inline

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Definition at line 298 of file GetJobOutputRequest.h.

◆ SetRange() [3/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetRange ( const char *  value)
inline

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Definition at line 324 of file GetJobOutputRequest.h.

◆ SetVaultName() [1/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetVaultName ( const Aws::String value)
inline

The name of the vault.

Definition at line 127 of file GetJobOutputRequest.h.

◆ SetVaultName() [2/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetVaultName ( Aws::String &&  value)
inline

The name of the vault.

Definition at line 132 of file GetJobOutputRequest.h.

◆ SetVaultName() [3/3]

void Aws::Glacier::Model::GetJobOutputRequest::SetVaultName ( const char *  value)
inline

The name of the vault.

Definition at line 137 of file GetJobOutputRequest.h.

◆ VaultNameHasBeenSet()

bool Aws::Glacier::Model::GetJobOutputRequest::VaultNameHasBeenSet ( ) const
inline

The name of the vault.

Definition at line 122 of file GetJobOutputRequest.h.

◆ WithAccountId() [1/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithAccountId ( const Aws::String value)
inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 93 of file GetJobOutputRequest.h.

◆ WithAccountId() [2/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithAccountId ( Aws::String &&  value)
inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 102 of file GetJobOutputRequest.h.

◆ WithAccountId() [3/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithAccountId ( const char *  value)
inline

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

Definition at line 111 of file GetJobOutputRequest.h.

◆ WithJobId() [1/3]

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

The job ID whose data is downloaded.

Definition at line 183 of file GetJobOutputRequest.h.

◆ WithJobId() [2/3]

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

The job ID whose data is downloaded.

Definition at line 188 of file GetJobOutputRequest.h.

◆ WithJobId() [3/3]

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

The job ID whose data is downloaded.

Definition at line 193 of file GetJobOutputRequest.h.

◆ WithRange() [1/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithRange ( const Aws::String value)
inline

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Definition at line 350 of file GetJobOutputRequest.h.

◆ WithRange() [2/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithRange ( Aws::String &&  value)
inline

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Definition at line 376 of file GetJobOutputRequest.h.

◆ WithRange() [3/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithRange ( const char *  value)
inline

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Definition at line 402 of file GetJobOutputRequest.h.

◆ WithVaultName() [1/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithVaultName ( const Aws::String value)
inline

The name of the vault.

Definition at line 142 of file GetJobOutputRequest.h.

◆ WithVaultName() [2/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithVaultName ( Aws::String &&  value)
inline

The name of the vault.

Definition at line 147 of file GetJobOutputRequest.h.

◆ WithVaultName() [3/3]

GetJobOutputRequest& Aws::Glacier::Model::GetJobOutputRequest::WithVaultName ( const char *  value)
inline

The name of the vault.

Definition at line 152 of file GetJobOutputRequest.h.


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