AWS SDK for C++  1.9.105
AWS SDK for C++
Public Member Functions | List of all members
Aws::EKS::Model::ListClustersRequest Class Reference

#include <ListClustersRequest.h>

+ Inheritance diagram for Aws::EKS::Model::ListClustersRequest:

Public Member Functions

 ListClustersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListClustersRequestWithMaxResults (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)
 
ListClustersRequestWithNextToken (const Aws::String &value)
 
ListClustersRequestWithNextToken (Aws::String &&value)
 
ListClustersRequestWithNextToken (const char *value)
 
const Aws::Vector< Aws::String > & GetInclude () const
 
bool IncludeHasBeenSet () const
 
void SetInclude (const Aws::Vector< Aws::String > &value)
 
void SetInclude (Aws::Vector< Aws::String > &&value)
 
ListClustersRequestWithInclude (const Aws::Vector< Aws::String > &value)
 
ListClustersRequestWithInclude (Aws::Vector< Aws::String > &&value)
 
ListClustersRequestAddInclude (const Aws::String &value)
 
ListClustersRequestAddInclude (Aws::String &&value)
 
ListClustersRequestAddInclude (const char *value)
 
- Public Member Functions inherited from Aws::EKS::EKSRequest
virtual ~EKSRequest ()
 
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::EKS::EKSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file ListClustersRequest.h.

Constructor & Destructor Documentation

◆ ListClustersRequest()

Aws::EKS::Model::ListClustersRequest::ListClustersRequest ( )

Member Function Documentation

◆ AddInclude() [1/3]

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::AddInclude ( Aws::String &&  value)
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 226 of file ListClustersRequest.h.

◆ AddInclude() [2/3]

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::AddInclude ( const Aws::String value)
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 220 of file ListClustersRequest.h.

◆ AddInclude() [3/3]

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::AddInclude ( const char *  value)
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 232 of file ListClustersRequest.h.

◆ AddQueryStringParameters()

void Aws::EKS::Model::ListClustersRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetInclude()

const Aws::Vector<Aws::String>& Aws::EKS::Model::ListClustersRequest::GetInclude ( ) const
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 184 of file ListClustersRequest.h.

◆ GetMaxResults()

int Aws::EKS::Model::ListClustersRequest::GetMaxResults ( ) const
inline

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

Definition at line 52 of file ListClustersRequest.h.

◆ GetNextToken()

const Aws::String& Aws::EKS::Model::ListClustersRequest::GetNextToken ( ) const
inline

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 100 of file ListClustersRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EKS::Model::ListClustersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file ListClustersRequest.h.

◆ IncludeHasBeenSet()

bool Aws::EKS::Model::ListClustersRequest::IncludeHasBeenSet ( ) const
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 190 of file ListClustersRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::EKS::Model::ListClustersRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

Definition at line 64 of file ListClustersRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::EKS::Model::ListClustersRequest::NextTokenHasBeenSet ( ) const
inline

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 111 of file ListClustersRequest.h.

◆ SerializePayload()

Aws::String Aws::EKS::Model::ListClustersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetInclude() [1/2]

void Aws::EKS::Model::ListClustersRequest::SetInclude ( Aws::Vector< Aws::String > &&  value)
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 202 of file ListClustersRequest.h.

◆ SetInclude() [2/2]

void Aws::EKS::Model::ListClustersRequest::SetInclude ( const Aws::Vector< Aws::String > &  value)
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 196 of file ListClustersRequest.h.

◆ SetMaxResults()

void Aws::EKS::Model::ListClustersRequest::SetMaxResults ( int  value)
inline

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

Definition at line 76 of file ListClustersRequest.h.

◆ SetNextToken() [1/3]

void Aws::EKS::Model::ListClustersRequest::SetNextToken ( Aws::String &&  value)
inline

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 133 of file ListClustersRequest.h.

◆ SetNextToken() [2/3]

void Aws::EKS::Model::ListClustersRequest::SetNextToken ( const Aws::String value)
inline

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 122 of file ListClustersRequest.h.

◆ SetNextToken() [3/3]

void Aws::EKS::Model::ListClustersRequest::SetNextToken ( const char *  value)
inline

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 144 of file ListClustersRequest.h.

◆ WithInclude() [1/2]

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::WithInclude ( Aws::Vector< Aws::String > &&  value)
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 214 of file ListClustersRequest.h.

◆ WithInclude() [2/2]

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::WithInclude ( const Aws::Vector< Aws::String > &  value)
inline

Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.

Definition at line 208 of file ListClustersRequest.h.

◆ WithMaxResults()

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::WithMaxResults ( int  value)
inline

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

Definition at line 88 of file ListClustersRequest.h.

◆ WithNextToken() [1/3]

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::WithNextToken ( Aws::String &&  value)
inline

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 166 of file ListClustersRequest.h.

◆ WithNextToken() [2/3]

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::WithNextToken ( const Aws::String value)
inline

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 155 of file ListClustersRequest.h.

◆ WithNextToken() [3/3]

ListClustersRequest& Aws::EKS::Model::ListClustersRequest::WithNextToken ( const char *  value)
inline

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 177 of file ListClustersRequest.h.


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