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

#include <ListVaultsRequest.h>

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

Public Member Functions

 ListVaultsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) 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)
 
ListVaultsRequestWithAccountId (const Aws::String &value)
 
ListVaultsRequestWithAccountId (Aws::String &&value)
 
ListVaultsRequestWithAccountId (const char *value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
ListVaultsRequestWithMarker (const Aws::String &value)
 
ListVaultsRequestWithMarker (Aws::String &&value)
 
ListVaultsRequestWithMarker (const char *value)
 
const Aws::StringGetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (const Aws::String &value)
 
void SetLimit (Aws::String &&value)
 
void SetLimit (const char *value)
 
ListVaultsRequestWithLimit (const Aws::String &value)
 
ListVaultsRequestWithLimit (Aws::String &&value)
 
ListVaultsRequestWithLimit (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 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 to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

See Also:

AWS API Reference

Definition at line 30 of file ListVaultsRequest.h.

Constructor & Destructor Documentation

◆ ListVaultsRequest()

Aws::Glacier::Model::ListVaultsRequest::ListVaultsRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

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

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

Definition at line 64 of file ListVaultsRequest.h.

◆ AddQueryStringParameters()

void Aws::Glacier::Model::ListVaultsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetAccountId()

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

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

Definition at line 54 of file ListVaultsRequest.h.

◆ GetLimit()

const Aws::String& Aws::Glacier::Model::ListVaultsRequest::GetLimit ( ) const
inline

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Definition at line 181 of file ListVaultsRequest.h.

◆ GetMarker()

const Aws::String& Aws::Glacier::Model::ListVaultsRequest::GetMarker ( ) const
inline

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Definition at line 131 of file ListVaultsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file ListVaultsRequest.h.

◆ LimitHasBeenSet()

bool Aws::Glacier::Model::ListVaultsRequest::LimitHasBeenSet ( ) const
inline

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Definition at line 188 of file ListVaultsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::Glacier::Model::ListVaultsRequest::MarkerHasBeenSet ( ) const
inline

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Definition at line 137 of file ListVaultsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

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

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

Definition at line 74 of file ListVaultsRequest.h.

◆ SetAccountId() [2/3]

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

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

Definition at line 84 of file ListVaultsRequest.h.

◆ SetAccountId() [3/3]

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

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

Definition at line 94 of file ListVaultsRequest.h.

◆ SetLimit() [1/3]

void Aws::Glacier::Model::ListVaultsRequest::SetLimit ( const Aws::String value)
inline

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Definition at line 195 of file ListVaultsRequest.h.

◆ SetLimit() [2/3]

void Aws::Glacier::Model::ListVaultsRequest::SetLimit ( Aws::String &&  value)
inline

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Definition at line 202 of file ListVaultsRequest.h.

◆ SetLimit() [3/3]

void Aws::Glacier::Model::ListVaultsRequest::SetLimit ( const char *  value)
inline

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Definition at line 209 of file ListVaultsRequest.h.

◆ SetMarker() [1/3]

void Aws::Glacier::Model::ListVaultsRequest::SetMarker ( const Aws::String value)
inline

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Definition at line 143 of file ListVaultsRequest.h.

◆ SetMarker() [2/3]

void Aws::Glacier::Model::ListVaultsRequest::SetMarker ( Aws::String &&  value)
inline

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Definition at line 149 of file ListVaultsRequest.h.

◆ SetMarker() [3/3]

void Aws::Glacier::Model::ListVaultsRequest::SetMarker ( const char *  value)
inline

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Definition at line 155 of file ListVaultsRequest.h.

◆ WithAccountId() [1/3]

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

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

Definition at line 104 of file ListVaultsRequest.h.

◆ WithAccountId() [2/3]

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

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

Definition at line 114 of file ListVaultsRequest.h.

◆ WithAccountId() [3/3]

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

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

Definition at line 124 of file ListVaultsRequest.h.

◆ WithLimit() [1/3]

ListVaultsRequest& Aws::Glacier::Model::ListVaultsRequest::WithLimit ( const Aws::String value)
inline

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Definition at line 216 of file ListVaultsRequest.h.

◆ WithLimit() [2/3]

ListVaultsRequest& Aws::Glacier::Model::ListVaultsRequest::WithLimit ( Aws::String &&  value)
inline

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Definition at line 223 of file ListVaultsRequest.h.

◆ WithLimit() [3/3]

ListVaultsRequest& Aws::Glacier::Model::ListVaultsRequest::WithLimit ( const char *  value)
inline

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Definition at line 230 of file ListVaultsRequest.h.

◆ WithMarker() [1/3]

ListVaultsRequest& Aws::Glacier::Model::ListVaultsRequest::WithMarker ( const Aws::String value)
inline

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Definition at line 161 of file ListVaultsRequest.h.

◆ WithMarker() [2/3]

ListVaultsRequest& Aws::Glacier::Model::ListVaultsRequest::WithMarker ( Aws::String &&  value)
inline

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Definition at line 167 of file ListVaultsRequest.h.

◆ WithMarker() [3/3]

ListVaultsRequest& Aws::Glacier::Model::ListVaultsRequest::WithMarker ( const char *  value)
inline

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Definition at line 173 of file ListVaultsRequest.h.


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