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

#include <UploadArchiveRequest.h>

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

Public Member Functions

 UploadArchiveRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetVaultName () const
 
bool VaultNameHasBeenSet () const
 
void SetVaultName (const Aws::String &value)
 
void SetVaultName (Aws::String &&value)
 
void SetVaultName (const char *value)
 
UploadArchiveRequestWithVaultName (const Aws::String &value)
 
UploadArchiveRequestWithVaultName (Aws::String &&value)
 
UploadArchiveRequestWithVaultName (const char *value)
 
const Aws::StringGetAccountId () const
 
bool AccountIdHasBeenSet () const
 
void SetAccountId (const Aws::String &value)
 
void SetAccountId (Aws::String &&value)
 
void SetAccountId (const char *value)
 
UploadArchiveRequestWithAccountId (const Aws::String &value)
 
UploadArchiveRequestWithAccountId (Aws::String &&value)
 
UploadArchiveRequestWithAccountId (const char *value)
 
const Aws::StringGetArchiveDescription () const
 
bool ArchiveDescriptionHasBeenSet () const
 
void SetArchiveDescription (const Aws::String &value)
 
void SetArchiveDescription (Aws::String &&value)
 
void SetArchiveDescription (const char *value)
 
UploadArchiveRequestWithArchiveDescription (const Aws::String &value)
 
UploadArchiveRequestWithArchiveDescription (Aws::String &&value)
 
UploadArchiveRequestWithArchiveDescription (const char *value)
 
const Aws::StringGetChecksum () const
 
bool ChecksumHasBeenSet () const
 
void SetChecksum (const Aws::String &value)
 
void SetChecksum (Aws::String &&value)
 
void SetChecksum (const char *value)
 
UploadArchiveRequestWithChecksum (const Aws::String &value)
 
UploadArchiveRequestWithChecksum (Aws::String &&value)
 
UploadArchiveRequestWithChecksum (const char *value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- 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 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 to add an archive to a vault.

See Also:

AWS API Reference

Definition at line 25 of file UploadArchiveRequest.h.

Constructor & Destructor Documentation

◆ UploadArchiveRequest()

Aws::Glacier::Model::UploadArchiveRequest::UploadArchiveRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

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

◆ ArchiveDescriptionHasBeenSet()

bool Aws::Glacier::Model::UploadArchiveRequest::ArchiveDescriptionHasBeenSet ( ) const
inline

The optional description of the archive you are uploading.

Definition at line 161 of file UploadArchiveRequest.h.

◆ ChecksumHasBeenSet()

bool Aws::Glacier::Model::UploadArchiveRequest::ChecksumHasBeenSet ( ) const
inline

The SHA256 tree hash of the data being uploaded.

Definition at line 202 of file UploadArchiveRequest.h.

◆ GetAccountId()

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

◆ GetArchiveDescription()

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

The optional description of the archive you are uploading.

Definition at line 156 of file UploadArchiveRequest.h.

◆ GetChecksum()

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

The SHA256 tree hash of the data being uploaded.

Definition at line 197 of file UploadArchiveRequest.h.

◆ GetRequestSpecificHeaders()

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

Override this method to put data members from a subclass into the headers collection.

Reimplemented from Aws::AmazonStreamingWebServiceRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file UploadArchiveRequest.h.

◆ GetVaultName()

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

The name of the vault.

Definition at line 42 of file UploadArchiveRequest.h.

◆ SetAccountId() [1/3]

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

◆ SetAccountId() [2/3]

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

◆ SetAccountId() [3/3]

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

◆ SetArchiveDescription() [1/3]

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

The optional description of the archive you are uploading.

Definition at line 166 of file UploadArchiveRequest.h.

◆ SetArchiveDescription() [2/3]

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

The optional description of the archive you are uploading.

Definition at line 171 of file UploadArchiveRequest.h.

◆ SetArchiveDescription() [3/3]

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

The optional description of the archive you are uploading.

Definition at line 176 of file UploadArchiveRequest.h.

◆ SetChecksum() [1/3]

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

The SHA256 tree hash of the data being uploaded.

Definition at line 207 of file UploadArchiveRequest.h.

◆ SetChecksum() [2/3]

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

The SHA256 tree hash of the data being uploaded.

Definition at line 212 of file UploadArchiveRequest.h.

◆ SetChecksum() [3/3]

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

The SHA256 tree hash of the data being uploaded.

Definition at line 217 of file UploadArchiveRequest.h.

◆ SetVaultName() [1/3]

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

The name of the vault.

Definition at line 52 of file UploadArchiveRequest.h.

◆ SetVaultName() [2/3]

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

The name of the vault.

Definition at line 57 of file UploadArchiveRequest.h.

◆ SetVaultName() [3/3]

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

The name of the vault.

Definition at line 62 of file UploadArchiveRequest.h.

◆ VaultNameHasBeenSet()

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

The name of the vault.

Definition at line 47 of file UploadArchiveRequest.h.

◆ WithAccountId() [1/3]

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

◆ WithAccountId() [2/3]

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

◆ WithAccountId() [3/3]

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

◆ WithArchiveDescription() [1/3]

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

The optional description of the archive you are uploading.

Definition at line 181 of file UploadArchiveRequest.h.

◆ WithArchiveDescription() [2/3]

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

The optional description of the archive you are uploading.

Definition at line 186 of file UploadArchiveRequest.h.

◆ WithArchiveDescription() [3/3]

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

The optional description of the archive you are uploading.

Definition at line 191 of file UploadArchiveRequest.h.

◆ WithChecksum() [1/3]

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

The SHA256 tree hash of the data being uploaded.

Definition at line 222 of file UploadArchiveRequest.h.

◆ WithChecksum() [2/3]

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

The SHA256 tree hash of the data being uploaded.

Definition at line 227 of file UploadArchiveRequest.h.

◆ WithChecksum() [3/3]

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

The SHA256 tree hash of the data being uploaded.

Definition at line 232 of file UploadArchiveRequest.h.

◆ WithVaultName() [1/3]

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

The name of the vault.

Definition at line 67 of file UploadArchiveRequest.h.

◆ WithVaultName() [2/3]

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

The name of the vault.

Definition at line 72 of file UploadArchiveRequest.h.

◆ WithVaultName() [3/3]

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

The name of the vault.

Definition at line 77 of file UploadArchiveRequest.h.


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