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

#include <InitiateJobRequest.h>

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

Public Member Functions

 InitiateJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () 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)
 
InitiateJobRequestWithAccountId (const Aws::String &value)
 
InitiateJobRequestWithAccountId (Aws::String &&value)
 
InitiateJobRequestWithAccountId (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)
 
InitiateJobRequestWithVaultName (const Aws::String &value)
 
InitiateJobRequestWithVaultName (Aws::String &&value)
 
InitiateJobRequestWithVaultName (const char *value)
 
const JobParametersGetJobParameters () const
 
bool JobParametersHasBeenSet () const
 
void SetJobParameters (const JobParameters &value)
 
void SetJobParameters (JobParameters &&value)
 
InitiateJobRequestWithJobParameters (const JobParameters &value)
 
InitiateJobRequestWithJobParameters (JobParameters &&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::Glacier::GlacierRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Provides options for initiating an Amazon S3 Glacier job.

See Also:

AWS API Reference

Definition at line 26 of file InitiateJobRequest.h.

Constructor & Destructor Documentation

◆ InitiateJobRequest()

Aws::Glacier::Model::InitiateJobRequest::InitiateJobRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

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

◆ GetAccountId()

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

◆ GetJobParameters()

const JobParameters& Aws::Glacier::Model::InitiateJobRequest::GetJobParameters ( ) const
inline

Provides options for specifying job information.

Definition at line 157 of file InitiateJobRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file InitiateJobRequest.h.

◆ GetVaultName()

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

The name of the vault.

Definition at line 116 of file InitiateJobRequest.h.

◆ JobParametersHasBeenSet()

bool Aws::Glacier::Model::InitiateJobRequest::JobParametersHasBeenSet ( ) const
inline

Provides options for specifying job information.

Definition at line 162 of file InitiateJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

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

◆ SetAccountId() [2/3]

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

◆ SetAccountId() [3/3]

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

◆ SetJobParameters() [1/2]

void Aws::Glacier::Model::InitiateJobRequest::SetJobParameters ( const JobParameters value)
inline

Provides options for specifying job information.

Definition at line 167 of file InitiateJobRequest.h.

◆ SetJobParameters() [2/2]

void Aws::Glacier::Model::InitiateJobRequest::SetJobParameters ( JobParameters &&  value)
inline

Provides options for specifying job information.

Definition at line 172 of file InitiateJobRequest.h.

◆ SetVaultName() [1/3]

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

The name of the vault.

Definition at line 126 of file InitiateJobRequest.h.

◆ SetVaultName() [2/3]

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

The name of the vault.

Definition at line 131 of file InitiateJobRequest.h.

◆ SetVaultName() [3/3]

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

The name of the vault.

Definition at line 136 of file InitiateJobRequest.h.

◆ VaultNameHasBeenSet()

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

The name of the vault.

Definition at line 121 of file InitiateJobRequest.h.

◆ WithAccountId() [1/3]

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

◆ WithAccountId() [2/3]

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

◆ WithAccountId() [3/3]

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

◆ WithJobParameters() [1/2]

InitiateJobRequest& Aws::Glacier::Model::InitiateJobRequest::WithJobParameters ( const JobParameters value)
inline

Provides options for specifying job information.

Definition at line 177 of file InitiateJobRequest.h.

◆ WithJobParameters() [2/2]

InitiateJobRequest& Aws::Glacier::Model::InitiateJobRequest::WithJobParameters ( JobParameters &&  value)
inline

Provides options for specifying job information.

Definition at line 182 of file InitiateJobRequest.h.

◆ WithVaultName() [1/3]

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

The name of the vault.

Definition at line 141 of file InitiateJobRequest.h.

◆ WithVaultName() [2/3]

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

The name of the vault.

Definition at line 146 of file InitiateJobRequest.h.

◆ WithVaultName() [3/3]

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

The name of the vault.

Definition at line 151 of file InitiateJobRequest.h.


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