Aws::CloudHSMV2::Model::DescribeBackupsRequest Class Reference

#include <DescribeBackupsRequest.h>

Inheritance diagram for Aws::CloudHSMV2::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::String &	GetNextToken () const
bool	NextTokenHasBeenSet () const
void	SetNextToken (const Aws::String &value)
void	SetNextToken (Aws::String &&value)
void	SetNextToken (const char *value)
DescribeBackupsRequest &	WithNextToken (const Aws::String &value)
DescribeBackupsRequest &	WithNextToken (Aws::String &&value)
DescribeBackupsRequest &	WithNextToken (const char *value)
int	GetMaxResults () const
bool	MaxResultsHasBeenSet () const
void	SetMaxResults (int value)
DescribeBackupsRequest &	WithMaxResults (int value)
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > &	GetFilters () const
bool	FiltersHasBeenSet () const
void	SetFilters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
void	SetFilters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
DescribeBackupsRequest &	WithFilters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
DescribeBackupsRequest &	WithFilters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
DescribeBackupsRequest &	AddFilters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
DescribeBackupsRequest &	AddFilters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
DescribeBackupsRequest &	AddFilters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
DescribeBackupsRequest &	AddFilters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
DescribeBackupsRequest &	AddFilters (const char *key, Aws::Vector< Aws::String > &&value)
DescribeBackupsRequest &	AddFilters (const char *key, const Aws::Vector< Aws::String > &value)
bool	GetSortAscending () const
bool	SortAscendingHasBeenSet () const
void	SetSortAscending (bool value)
DescribeBackupsRequest &	WithSortAscending (bool value)
Public Member Functions inherited from Aws::CloudHSMV2::CloudHSMV2Request
virtual	~CloudHSMV2Request ()
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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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

Definition at line 23 of file DescribeBackupsRequest.h.

Constructor & Destructor Documentation

DescribeBackupsRequest()

Aws::CloudHSMV2::Model::DescribeBackupsRequest::DescribeBackupsRequest

(

)

Member Function Documentation

AddFilters() [1/6]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::AddFilters ( Aws::String &&  key, Aws::Vector< Aws::String > &&  value  )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 285 of file DescribeBackupsRequest.h.

AddFilters() [2/6]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::AddFilters ( Aws::String &&  key, const Aws::Vector< Aws::String > &  value  )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 251 of file DescribeBackupsRequest.h.

AddFilters() [3/6]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::AddFilters ( const Aws::String &  key, Aws::Vector< Aws::String > &&  value  )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 268 of file DescribeBackupsRequest.h.

AddFilters() [4/6]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::AddFilters ( const Aws::String &  key, const Aws::Vector< Aws::String > &  value  )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 234 of file DescribeBackupsRequest.h.

AddFilters() [5/6]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::AddFilters ( const char *  key, Aws::Vector< Aws::String > &&  value  )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 302 of file DescribeBackupsRequest.h.

AddFilters() [6/6]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::AddFilters ( const char *  key, const Aws::Vector< Aws::String > &  value  )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 319 of file DescribeBackupsRequest.h.

FiltersHasBeenSet()

bool Aws::CloudHSMV2::Model::DescribeBackupsRequest::FiltersHasBeenSet ( ) const

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 149 of file DescribeBackupsRequest.h.

GetFilters()

const Aws::Map<Aws::String, Aws::Vector<Aws::String> >& Aws::CloudHSMV2::Model::DescribeBackupsRequest::GetFilters ( ) const

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 132 of file DescribeBackupsRequest.h.

GetMaxResults()

int Aws::CloudHSMV2::Model::DescribeBackupsRequest::GetMaxResults ( ) const

inline

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Definition at line 93 of file DescribeBackupsRequest.h.

GetNextToken()

const Aws::String& Aws::CloudHSMV2::Model::DescribeBackupsRequest::GetNextToken ( ) const

inline

The NextToken value that you received in the previous response. Use this value to get more backups.

Definition at line 43 of file DescribeBackupsRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CloudHSMV2::Model::DescribeBackupsRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::CloudHSMV2::CloudHSMV2Request.

GetServiceRequestName()

virtual const char* Aws::CloudHSMV2::Model::DescribeBackupsRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeBackupsRequest.h.

GetSortAscending()

bool Aws::CloudHSMV2::Model::DescribeBackupsRequest::GetSortAscending ( ) const

inline

Designates whether or not to sort the return backups by ascending chronological order of generation.

Definition at line 326 of file DescribeBackupsRequest.h.

MaxResultsHasBeenSet()

bool Aws::CloudHSMV2::Model::DescribeBackupsRequest::MaxResultsHasBeenSet ( ) const

inline

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Definition at line 100 of file DescribeBackupsRequest.h.

NextTokenHasBeenSet()

bool Aws::CloudHSMV2::Model::DescribeBackupsRequest::NextTokenHasBeenSet ( ) const

inline

The NextToken value that you received in the previous response. Use this value to get more backups.

Definition at line 49 of file DescribeBackupsRequest.h.

SerializePayload()

Aws::String Aws::CloudHSMV2::Model::DescribeBackupsRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetFilters() [1/2]

void Aws::CloudHSMV2::Model::DescribeBackupsRequest::SetFilters ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 183 of file DescribeBackupsRequest.h.

SetFilters() [2/2]

void Aws::CloudHSMV2::Model::DescribeBackupsRequest::SetFilters ( const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &  value )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 166 of file DescribeBackupsRequest.h.

SetMaxResults()

void Aws::CloudHSMV2::Model::DescribeBackupsRequest::SetMaxResults ( int  value )

inline

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Definition at line 107 of file DescribeBackupsRequest.h.

SetNextToken() [1/3]

void Aws::CloudHSMV2::Model::DescribeBackupsRequest::SetNextToken ( Aws::String &&  value )

inline

The NextToken value that you received in the previous response. Use this value to get more backups.

Definition at line 61 of file DescribeBackupsRequest.h.

SetNextToken() [2/3]

void Aws::CloudHSMV2::Model::DescribeBackupsRequest::SetNextToken ( const Aws::String &  value )

inline

The NextToken value that you received in the previous response. Use this value to get more backups.

Definition at line 55 of file DescribeBackupsRequest.h.

SetNextToken() [3/3]

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

inline

The NextToken value that you received in the previous response. Use this value to get more backups.

Definition at line 67 of file DescribeBackupsRequest.h.

SetSortAscending()

void Aws::CloudHSMV2::Model::DescribeBackupsRequest::SetSortAscending ( bool  value )

inline

Designates whether or not to sort the return backups by ascending chronological order of generation.

Definition at line 338 of file DescribeBackupsRequest.h.

SortAscendingHasBeenSet()

bool Aws::CloudHSMV2::Model::DescribeBackupsRequest::SortAscendingHasBeenSet ( ) const

inline

Designates whether or not to sort the return backups by ascending chronological order of generation.

Definition at line 332 of file DescribeBackupsRequest.h.

WithFilters() [1/2]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::WithFilters ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 217 of file DescribeBackupsRequest.h.

WithFilters() [2/2]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::WithFilters ( const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &  value )

inline

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Definition at line 200 of file DescribeBackupsRequest.h.

WithMaxResults()

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::WithMaxResults ( int  value )

inline

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Definition at line 114 of file DescribeBackupsRequest.h.

WithNextToken() [1/3]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::WithNextToken ( Aws::String &&  value )

inline

The NextToken value that you received in the previous response. Use this value to get more backups.

Definition at line 79 of file DescribeBackupsRequest.h.

WithNextToken() [2/3]

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::WithNextToken ( const Aws::String &  value )

inline

The NextToken value that you received in the previous response. Use this value to get more backups.

Definition at line 73 of file DescribeBackupsRequest.h.

WithNextToken() [3/3]

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

inline

The NextToken value that you received in the previous response. Use this value to get more backups.

Definition at line 85 of file DescribeBackupsRequest.h.

WithSortAscending()

DescribeBackupsRequest& Aws::CloudHSMV2::Model::DescribeBackupsRequest::WithSortAscending ( bool  value )

inline

Designates whether or not to sort the return backups by ascending chronological order of generation.

Definition at line 344 of file DescribeBackupsRequest.h.

---

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

• aws-cpp-sdk-cloudhsmv2/include/aws/cloudhsmv2/model/DescribeBackupsRequest.h