AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::GetUsagePlansRequest Class Reference

#include <GetUsagePlansRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::GetUsagePlansRequest:

Public Member Functions

 GetUsagePlansRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetPosition () const
 
bool PositionHasBeenSet () const
 
void SetPosition (const Aws::String &value)
 
void SetPosition (Aws::String &&value)
 
void SetPosition (const char *value)
 
GetUsagePlansRequestWithPosition (const Aws::String &value)
 
GetUsagePlansRequestWithPosition (Aws::String &&value)
 
GetUsagePlansRequestWithPosition (const char *value)
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
GetUsagePlansRequestWithKeyId (const Aws::String &value)
 
GetUsagePlansRequestWithKeyId (Aws::String &&value)
 
GetUsagePlansRequestWithKeyId (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetUsagePlansRequestWithLimit (int value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
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::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

The GET request to get all the usage plans of the caller's account.

See Also:

AWS API Reference

Definition at line 29 of file GetUsagePlansRequest.h.

Constructor & Destructor Documentation

◆ GetUsagePlansRequest()

Aws::APIGateway::Model::GetUsagePlansRequest::GetUsagePlansRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::APIGateway::Model::GetUsagePlansRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetKeyId()

const Aws::String& Aws::APIGateway::Model::GetUsagePlansRequest::GetKeyId ( ) const
inline

The identifier of the API key associated with the usage plans.

Definition at line 89 of file GetUsagePlansRequest.h.

◆ GetLimit()

int Aws::APIGateway::Model::GetUsagePlansRequest::GetLimit ( ) const
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 131 of file GetUsagePlansRequest.h.

◆ GetPosition()

const Aws::String& Aws::APIGateway::Model::GetUsagePlansRequest::GetPosition ( ) const
inline

The current pagination position in the paged result set.

Definition at line 48 of file GetUsagePlansRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::GetUsagePlansRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file GetUsagePlansRequest.h.

◆ KeyIdHasBeenSet()

bool Aws::APIGateway::Model::GetUsagePlansRequest::KeyIdHasBeenSet ( ) const
inline

The identifier of the API key associated with the usage plans.

Definition at line 94 of file GetUsagePlansRequest.h.

◆ LimitHasBeenSet()

bool Aws::APIGateway::Model::GetUsagePlansRequest::LimitHasBeenSet ( ) const
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 137 of file GetUsagePlansRequest.h.

◆ PositionHasBeenSet()

bool Aws::APIGateway::Model::GetUsagePlansRequest::PositionHasBeenSet ( ) const
inline

The current pagination position in the paged result set.

Definition at line 53 of file GetUsagePlansRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::GetUsagePlansRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

void Aws::APIGateway::Model::GetUsagePlansRequest::SetKeyId ( Aws::String &&  value)
inline

The identifier of the API key associated with the usage plans.

Definition at line 104 of file GetUsagePlansRequest.h.

◆ SetKeyId() [2/3]

void Aws::APIGateway::Model::GetUsagePlansRequest::SetKeyId ( const Aws::String value)
inline

The identifier of the API key associated with the usage plans.

Definition at line 99 of file GetUsagePlansRequest.h.

◆ SetKeyId() [3/3]

void Aws::APIGateway::Model::GetUsagePlansRequest::SetKeyId ( const char *  value)
inline

The identifier of the API key associated with the usage plans.

Definition at line 109 of file GetUsagePlansRequest.h.

◆ SetLimit()

void Aws::APIGateway::Model::GetUsagePlansRequest::SetLimit ( int  value)
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 143 of file GetUsagePlansRequest.h.

◆ SetPosition() [1/3]

void Aws::APIGateway::Model::GetUsagePlansRequest::SetPosition ( Aws::String &&  value)
inline

The current pagination position in the paged result set.

Definition at line 63 of file GetUsagePlansRequest.h.

◆ SetPosition() [2/3]

void Aws::APIGateway::Model::GetUsagePlansRequest::SetPosition ( const Aws::String value)
inline

The current pagination position in the paged result set.

Definition at line 58 of file GetUsagePlansRequest.h.

◆ SetPosition() [3/3]

void Aws::APIGateway::Model::GetUsagePlansRequest::SetPosition ( const char *  value)
inline

The current pagination position in the paged result set.

Definition at line 68 of file GetUsagePlansRequest.h.

◆ WithKeyId() [1/3]

GetUsagePlansRequest& Aws::APIGateway::Model::GetUsagePlansRequest::WithKeyId ( Aws::String &&  value)
inline

The identifier of the API key associated with the usage plans.

Definition at line 119 of file GetUsagePlansRequest.h.

◆ WithKeyId() [2/3]

GetUsagePlansRequest& Aws::APIGateway::Model::GetUsagePlansRequest::WithKeyId ( const Aws::String value)
inline

The identifier of the API key associated with the usage plans.

Definition at line 114 of file GetUsagePlansRequest.h.

◆ WithKeyId() [3/3]

GetUsagePlansRequest& Aws::APIGateway::Model::GetUsagePlansRequest::WithKeyId ( const char *  value)
inline

The identifier of the API key associated with the usage plans.

Definition at line 124 of file GetUsagePlansRequest.h.

◆ WithLimit()

GetUsagePlansRequest& Aws::APIGateway::Model::GetUsagePlansRequest::WithLimit ( int  value)
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 149 of file GetUsagePlansRequest.h.

◆ WithPosition() [1/3]

GetUsagePlansRequest& Aws::APIGateway::Model::GetUsagePlansRequest::WithPosition ( Aws::String &&  value)
inline

The current pagination position in the paged result set.

Definition at line 78 of file GetUsagePlansRequest.h.

◆ WithPosition() [2/3]

GetUsagePlansRequest& Aws::APIGateway::Model::GetUsagePlansRequest::WithPosition ( const Aws::String value)
inline

The current pagination position in the paged result set.

Definition at line 73 of file GetUsagePlansRequest.h.

◆ WithPosition() [3/3]

GetUsagePlansRequest& Aws::APIGateway::Model::GetUsagePlansRequest::WithPosition ( const char *  value)
inline

The current pagination position in the paged result set.

Definition at line 83 of file GetUsagePlansRequest.h.


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