AWS SDK for C++  1.9.107
AWS SDK for C++
Public Member Functions | List of all members
Aws::FSx::Model::DescribeBackupsRequest Class Reference

#include <DescribeBackupsRequest.h>

+ Inheritance diagram for Aws::FSx::Model::DescribeBackupsRequest:

Public Member Functions

 DescribeBackupsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetBackupIds () const
 
bool BackupIdsHasBeenSet () const
 
void SetBackupIds (const Aws::Vector< Aws::String > &value)
 
void SetBackupIds (Aws::Vector< Aws::String > &&value)
 
DescribeBackupsRequestWithBackupIds (const Aws::Vector< Aws::String > &value)
 
DescribeBackupsRequestWithBackupIds (Aws::Vector< Aws::String > &&value)
 
DescribeBackupsRequestAddBackupIds (const Aws::String &value)
 
DescribeBackupsRequestAddBackupIds (Aws::String &&value)
 
DescribeBackupsRequestAddBackupIds (const char *value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeBackupsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeBackupsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeBackupsRequestAddFilters (const Filter &value)
 
DescribeBackupsRequestAddFilters (Filter &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeBackupsRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeBackupsRequestWithNextToken (const Aws::String &value)
 
DescribeBackupsRequestWithNextToken (Aws::String &&value)
 
DescribeBackupsRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::FSx::FSxRequest
virtual ~FSxRequest ()
 
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

The request object for DescribeBackups operation.

See Also:

AWS API Reference

Definition at line 27 of file DescribeBackupsRequest.h.

Constructor & Destructor Documentation

◆ DescribeBackupsRequest()

Aws::FSx::Model::DescribeBackupsRequest::DescribeBackupsRequest ( )

Member Function Documentation

◆ AddBackupIds() [1/3]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::AddBackupIds ( Aws::String &&  value)
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 89 of file DescribeBackupsRequest.h.

◆ AddBackupIds() [2/3]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::AddBackupIds ( const Aws::String value)
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 83 of file DescribeBackupsRequest.h.

◆ AddBackupIds() [3/3]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::AddBackupIds ( const char *  value)
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 95 of file DescribeBackupsRequest.h.

◆ AddFilters() [1/2]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::AddFilters ( const Filter value)
inline

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

Definition at line 145 of file DescribeBackupsRequest.h.

◆ AddFilters() [2/2]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::AddFilters ( Filter &&  value)
inline

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

Definition at line 152 of file DescribeBackupsRequest.h.

◆ BackupIdsHasBeenSet()

bool Aws::FSx::Model::DescribeBackupsRequest::BackupIdsHasBeenSet ( ) const
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 53 of file DescribeBackupsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::FSx::Model::DescribeBackupsRequest::FiltersHasBeenSet ( ) const
inline

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

Definition at line 110 of file DescribeBackupsRequest.h.

◆ GetBackupIds()

const Aws::Vector<Aws::String>& Aws::FSx::Model::DescribeBackupsRequest::GetBackupIds ( ) const
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 47 of file DescribeBackupsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::FSx::Model::DescribeBackupsRequest::GetFilters ( ) const
inline

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

Definition at line 103 of file DescribeBackupsRequest.h.

◆ GetMaxResults()

int Aws::FSx::Model::DescribeBackupsRequest::GetMaxResults ( ) const
inline

Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Definition at line 161 of file DescribeBackupsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::FSx::Model::DescribeBackupsRequest::GetNextToken ( ) const
inline

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Definition at line 193 of file DescribeBackupsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::FSx::Model::DescribeBackupsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::FSx::FSxRequest.

◆ GetServiceRequestName()

virtual const char* Aws::FSx::Model::DescribeBackupsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DescribeBackupsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::FSx::Model::DescribeBackupsRequest::MaxResultsHasBeenSet ( ) const
inline

Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Definition at line 169 of file DescribeBackupsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::FSx::Model::DescribeBackupsRequest::NextTokenHasBeenSet ( ) const
inline

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Definition at line 200 of file DescribeBackupsRequest.h.

◆ SerializePayload()

Aws::String Aws::FSx::Model::DescribeBackupsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBackupIds() [1/2]

void Aws::FSx::Model::DescribeBackupsRequest::SetBackupIds ( Aws::Vector< Aws::String > &&  value)
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 65 of file DescribeBackupsRequest.h.

◆ SetBackupIds() [2/2]

void Aws::FSx::Model::DescribeBackupsRequest::SetBackupIds ( const Aws::Vector< Aws::String > &  value)
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 59 of file DescribeBackupsRequest.h.

◆ SetFilters() [1/2]

void Aws::FSx::Model::DescribeBackupsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

Definition at line 124 of file DescribeBackupsRequest.h.

◆ SetFilters() [2/2]

void Aws::FSx::Model::DescribeBackupsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

Definition at line 117 of file DescribeBackupsRequest.h.

◆ SetMaxResults()

void Aws::FSx::Model::DescribeBackupsRequest::SetMaxResults ( int  value)
inline

Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Definition at line 177 of file DescribeBackupsRequest.h.

◆ SetNextToken() [1/3]

void Aws::FSx::Model::DescribeBackupsRequest::SetNextToken ( Aws::String &&  value)
inline

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Definition at line 214 of file DescribeBackupsRequest.h.

◆ SetNextToken() [2/3]

void Aws::FSx::Model::DescribeBackupsRequest::SetNextToken ( const Aws::String value)
inline

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Definition at line 207 of file DescribeBackupsRequest.h.

◆ SetNextToken() [3/3]

void Aws::FSx::Model::DescribeBackupsRequest::SetNextToken ( const char *  value)
inline

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Definition at line 221 of file DescribeBackupsRequest.h.

◆ WithBackupIds() [1/2]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::WithBackupIds ( Aws::Vector< Aws::String > &&  value)
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 77 of file DescribeBackupsRequest.h.

◆ WithBackupIds() [2/2]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::WithBackupIds ( const Aws::Vector< Aws::String > &  value)
inline

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Definition at line 71 of file DescribeBackupsRequest.h.

◆ WithFilters() [1/2]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

Definition at line 138 of file DescribeBackupsRequest.h.

◆ WithFilters() [2/2]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

Definition at line 131 of file DescribeBackupsRequest.h.

◆ WithMaxResults()

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::WithMaxResults ( int  value)
inline

Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Definition at line 185 of file DescribeBackupsRequest.h.

◆ WithNextToken() [1/3]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::WithNextToken ( Aws::String &&  value)
inline

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Definition at line 235 of file DescribeBackupsRequest.h.

◆ WithNextToken() [2/3]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::WithNextToken ( const Aws::String value)
inline

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Definition at line 228 of file DescribeBackupsRequest.h.

◆ WithNextToken() [3/3]

DescribeBackupsRequest& Aws::FSx::Model::DescribeBackupsRequest::WithNextToken ( const char *  value)
inline

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Definition at line 242 of file DescribeBackupsRequest.h.


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