AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudHSMV2::Model::DescribeClustersRequest Class Reference

#include <DescribeClustersRequest.h>

+ Inheritance diagram for Aws::CloudHSMV2::Model::DescribeClustersRequest:

Public Member Functions

 DescribeClustersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
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)
 
DescribeClustersRequestWithFilters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
DescribeClustersRequestWithFilters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
DescribeClustersRequestAddFilters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
DescribeClustersRequestAddFilters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
DescribeClustersRequestAddFilters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestAddFilters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestAddFilters (const char *key, Aws::Vector< Aws::String > &&value)
 
DescribeClustersRequestAddFilters (const char *key, const Aws::Vector< Aws::String > &value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeClustersRequestWithNextToken (const Aws::String &value)
 
DescribeClustersRequestWithNextToken (Aws::String &&value)
 
DescribeClustersRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeClustersRequestWithMaxResults (int 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::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

Definition at line 23 of file DescribeClustersRequest.h.

Constructor & Destructor Documentation

◆ DescribeClustersRequest()

Aws::CloudHSMV2::Model::DescribeClustersRequest::DescribeClustersRequest ( )

Member Function Documentation

◆ AddFilters() [1/6]

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::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 clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 114 of file DescribeClustersRequest.h.

◆ AddFilters() [2/6]

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::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 clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 125 of file DescribeClustersRequest.h.

◆ AddFilters() [3/6]

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::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 clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 136 of file DescribeClustersRequest.h.

◆ AddFilters() [4/6]

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

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

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

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 147 of file DescribeClustersRequest.h.

◆ AddFilters() [5/6]

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

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

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

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 158 of file DescribeClustersRequest.h.

◆ AddFilters() [6/6]

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::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 clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 169 of file DescribeClustersRequest.h.

◆ FiltersHasBeenSet()

bool Aws::CloudHSMV2::Model::DescribeClustersRequest::FiltersHasBeenSet ( ) const
inline

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

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

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 59 of file DescribeClustersRequest.h.

◆ GetFilters()

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

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

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

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 48 of file DescribeClustersRequest.h.

◆ GetMaxResults()

int Aws::CloudHSMV2::Model::DescribeClustersRequest::GetMaxResults ( ) const
inline

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

Definition at line 226 of file DescribeClustersRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CloudHSMV2::Model::DescribeClustersRequest::GetNextToken ( ) const
inline

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

Definition at line 176 of file DescribeClustersRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CloudHSMV2::Model::DescribeClustersRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CloudHSMV2::Model::DescribeClustersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeClustersRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::CloudHSMV2::Model::DescribeClustersRequest::MaxResultsHasBeenSet ( ) const
inline

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

Definition at line 233 of file DescribeClustersRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CloudHSMV2::Model::DescribeClustersRequest::NextTokenHasBeenSet ( ) const
inline

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

Definition at line 182 of file DescribeClustersRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudHSMV2::Model::DescribeClustersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::CloudHSMV2::Model::DescribeClustersRequest::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 clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 70 of file DescribeClustersRequest.h.

◆ SetFilters() [2/2]

void Aws::CloudHSMV2::Model::DescribeClustersRequest::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 clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 81 of file DescribeClustersRequest.h.

◆ SetMaxResults()

void Aws::CloudHSMV2::Model::DescribeClustersRequest::SetMaxResults ( int  value)
inline

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

Definition at line 240 of file DescribeClustersRequest.h.

◆ SetNextToken() [1/3]

void Aws::CloudHSMV2::Model::DescribeClustersRequest::SetNextToken ( const Aws::String value)
inline

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

Definition at line 188 of file DescribeClustersRequest.h.

◆ SetNextToken() [2/3]

void Aws::CloudHSMV2::Model::DescribeClustersRequest::SetNextToken ( Aws::String &&  value)
inline

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

Definition at line 194 of file DescribeClustersRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 200 of file DescribeClustersRequest.h.

◆ WithFilters() [1/2]

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::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 clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 92 of file DescribeClustersRequest.h.

◆ WithFilters() [2/2]

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::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 clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

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

Definition at line 103 of file DescribeClustersRequest.h.

◆ WithMaxResults()

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::WithMaxResults ( int  value)
inline

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

Definition at line 247 of file DescribeClustersRequest.h.

◆ WithNextToken() [1/3]

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::WithNextToken ( const Aws::String value)
inline

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

Definition at line 206 of file DescribeClustersRequest.h.

◆ WithNextToken() [2/3]

DescribeClustersRequest& Aws::CloudHSMV2::Model::DescribeClustersRequest::WithNextToken ( Aws::String &&  value)
inline

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

Definition at line 212 of file DescribeClustersRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 218 of file DescribeClustersRequest.h.


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