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

#include <GetUsagePlanKeysRequest.h>

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

Public Member Functions

 GetUsagePlanKeysRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetUsagePlanId () const
 
bool UsagePlanIdHasBeenSet () const
 
void SetUsagePlanId (const Aws::String &value)
 
void SetUsagePlanId (Aws::String &&value)
 
void SetUsagePlanId (const char *value)
 
GetUsagePlanKeysRequestWithUsagePlanId (const Aws::String &value)
 
GetUsagePlanKeysRequestWithUsagePlanId (Aws::String &&value)
 
GetUsagePlanKeysRequestWithUsagePlanId (const char *value)
 
const Aws::StringGetPosition () const
 
bool PositionHasBeenSet () const
 
void SetPosition (const Aws::String &value)
 
void SetPosition (Aws::String &&value)
 
void SetPosition (const char *value)
 
GetUsagePlanKeysRequestWithPosition (const Aws::String &value)
 
GetUsagePlanKeysRequestWithPosition (Aws::String &&value)
 
GetUsagePlanKeysRequestWithPosition (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetUsagePlanKeysRequestWithLimit (int value)
 
const Aws::StringGetNameQuery () const
 
bool NameQueryHasBeenSet () const
 
void SetNameQuery (const Aws::String &value)
 
void SetNameQuery (Aws::String &&value)
 
void SetNameQuery (const char *value)
 
GetUsagePlanKeysRequestWithNameQuery (const Aws::String &value)
 
GetUsagePlanKeysRequestWithNameQuery (Aws::String &&value)
 
GetUsagePlanKeysRequestWithNameQuery (const char *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 plan keys representing the API keys added to a specified usage plan.

See Also:

AWS API Reference

Definition at line 29 of file GetUsagePlanKeysRequest.h.

Constructor & Destructor Documentation

◆ GetUsagePlanKeysRequest()

Aws::APIGateway::Model::GetUsagePlanKeysRequest::GetUsagePlanKeysRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetLimit()

int Aws::APIGateway::Model::GetUsagePlanKeysRequest::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 147 of file GetUsagePlanKeysRequest.h.

◆ GetNameQuery()

const Aws::String& Aws::APIGateway::Model::GetUsagePlanKeysRequest::GetNameQuery ( ) const
inline

A query parameter specifying the name of the to-be-returned usage plan keys.

Definition at line 172 of file GetUsagePlanKeysRequest.h.

◆ GetPosition()

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

The current pagination position in the paged result set.

Definition at line 105 of file GetUsagePlanKeysRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file GetUsagePlanKeysRequest.h.

◆ GetUsagePlanId()

const Aws::String& Aws::APIGateway::Model::GetUsagePlanKeysRequest::GetUsagePlanId ( ) const
inline

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Definition at line 50 of file GetUsagePlanKeysRequest.h.

◆ LimitHasBeenSet()

bool Aws::APIGateway::Model::GetUsagePlanKeysRequest::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 153 of file GetUsagePlanKeysRequest.h.

◆ NameQueryHasBeenSet()

bool Aws::APIGateway::Model::GetUsagePlanKeysRequest::NameQueryHasBeenSet ( ) const
inline

A query parameter specifying the name of the to-be-returned usage plan keys.

Definition at line 178 of file GetUsagePlanKeysRequest.h.

◆ PositionHasBeenSet()

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

The current pagination position in the paged result set.

Definition at line 110 of file GetUsagePlanKeysRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLimit()

void Aws::APIGateway::Model::GetUsagePlanKeysRequest::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 159 of file GetUsagePlanKeysRequest.h.

◆ SetNameQuery() [1/3]

void Aws::APIGateway::Model::GetUsagePlanKeysRequest::SetNameQuery ( Aws::String &&  value)
inline

A query parameter specifying the name of the to-be-returned usage plan keys.

Definition at line 190 of file GetUsagePlanKeysRequest.h.

◆ SetNameQuery() [2/3]

void Aws::APIGateway::Model::GetUsagePlanKeysRequest::SetNameQuery ( const Aws::String value)
inline

A query parameter specifying the name of the to-be-returned usage plan keys.

Definition at line 184 of file GetUsagePlanKeysRequest.h.

◆ SetNameQuery() [3/3]

void Aws::APIGateway::Model::GetUsagePlanKeysRequest::SetNameQuery ( const char *  value)
inline

A query parameter specifying the name of the to-be-returned usage plan keys.

Definition at line 196 of file GetUsagePlanKeysRequest.h.

◆ SetPosition() [1/3]

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

The current pagination position in the paged result set.

Definition at line 120 of file GetUsagePlanKeysRequest.h.

◆ SetPosition() [2/3]

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

The current pagination position in the paged result set.

Definition at line 115 of file GetUsagePlanKeysRequest.h.

◆ SetPosition() [3/3]

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

The current pagination position in the paged result set.

Definition at line 125 of file GetUsagePlanKeysRequest.h.

◆ SetUsagePlanId() [1/3]

void Aws::APIGateway::Model::GetUsagePlanKeysRequest::SetUsagePlanId ( Aws::String &&  value)
inline

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Definition at line 71 of file GetUsagePlanKeysRequest.h.

◆ SetUsagePlanId() [2/3]

void Aws::APIGateway::Model::GetUsagePlanKeysRequest::SetUsagePlanId ( const Aws::String value)
inline

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Definition at line 64 of file GetUsagePlanKeysRequest.h.

◆ SetUsagePlanId() [3/3]

void Aws::APIGateway::Model::GetUsagePlanKeysRequest::SetUsagePlanId ( const char *  value)
inline

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Definition at line 78 of file GetUsagePlanKeysRequest.h.

◆ UsagePlanIdHasBeenSet()

bool Aws::APIGateway::Model::GetUsagePlanKeysRequest::UsagePlanIdHasBeenSet ( ) const
inline

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Definition at line 57 of file GetUsagePlanKeysRequest.h.

◆ WithLimit()

GetUsagePlanKeysRequest& Aws::APIGateway::Model::GetUsagePlanKeysRequest::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 165 of file GetUsagePlanKeysRequest.h.

◆ WithNameQuery() [1/3]

GetUsagePlanKeysRequest& Aws::APIGateway::Model::GetUsagePlanKeysRequest::WithNameQuery ( Aws::String &&  value)
inline

A query parameter specifying the name of the to-be-returned usage plan keys.

Definition at line 208 of file GetUsagePlanKeysRequest.h.

◆ WithNameQuery() [2/3]

GetUsagePlanKeysRequest& Aws::APIGateway::Model::GetUsagePlanKeysRequest::WithNameQuery ( const Aws::String value)
inline

A query parameter specifying the name of the to-be-returned usage plan keys.

Definition at line 202 of file GetUsagePlanKeysRequest.h.

◆ WithNameQuery() [3/3]

GetUsagePlanKeysRequest& Aws::APIGateway::Model::GetUsagePlanKeysRequest::WithNameQuery ( const char *  value)
inline

A query parameter specifying the name of the to-be-returned usage plan keys.

Definition at line 214 of file GetUsagePlanKeysRequest.h.

◆ WithPosition() [1/3]

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

The current pagination position in the paged result set.

Definition at line 135 of file GetUsagePlanKeysRequest.h.

◆ WithPosition() [2/3]

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

The current pagination position in the paged result set.

Definition at line 130 of file GetUsagePlanKeysRequest.h.

◆ WithPosition() [3/3]

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

The current pagination position in the paged result set.

Definition at line 140 of file GetUsagePlanKeysRequest.h.

◆ WithUsagePlanId() [1/3]

GetUsagePlanKeysRequest& Aws::APIGateway::Model::GetUsagePlanKeysRequest::WithUsagePlanId ( Aws::String &&  value)
inline

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Definition at line 92 of file GetUsagePlanKeysRequest.h.

◆ WithUsagePlanId() [2/3]

GetUsagePlanKeysRequest& Aws::APIGateway::Model::GetUsagePlanKeysRequest::WithUsagePlanId ( const Aws::String value)
inline

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Definition at line 85 of file GetUsagePlanKeysRequest.h.

◆ WithUsagePlanId() [3/3]

GetUsagePlanKeysRequest& Aws::APIGateway::Model::GetUsagePlanKeysRequest::WithUsagePlanId ( const char *  value)
inline

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Definition at line 99 of file GetUsagePlanKeysRequest.h.


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