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

#include <GetUsageRequest.h>

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

Public Member Functions

 GetUsageRequest ()
 
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)
 
GetUsageRequestWithUsagePlanId (const Aws::String &value)
 
GetUsageRequestWithUsagePlanId (Aws::String &&value)
 
GetUsageRequestWithUsagePlanId (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)
 
GetUsageRequestWithKeyId (const Aws::String &value)
 
GetUsageRequestWithKeyId (Aws::String &&value)
 
GetUsageRequestWithKeyId (const char *value)
 
const Aws::StringGetStartDate () const
 
bool StartDateHasBeenSet () const
 
void SetStartDate (const Aws::String &value)
 
void SetStartDate (Aws::String &&value)
 
void SetStartDate (const char *value)
 
GetUsageRequestWithStartDate (const Aws::String &value)
 
GetUsageRequestWithStartDate (Aws::String &&value)
 
GetUsageRequestWithStartDate (const char *value)
 
const Aws::StringGetEndDate () const
 
bool EndDateHasBeenSet () const
 
void SetEndDate (const Aws::String &value)
 
void SetEndDate (Aws::String &&value)
 
void SetEndDate (const char *value)
 
GetUsageRequestWithEndDate (const Aws::String &value)
 
GetUsageRequestWithEndDate (Aws::String &&value)
 
GetUsageRequestWithEndDate (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)
 
GetUsageRequestWithPosition (const Aws::String &value)
 
GetUsageRequestWithPosition (Aws::String &&value)
 
GetUsageRequestWithPosition (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetUsageRequestWithLimit (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 the usage data of a usage plan in a specified time interval.

See Also:

AWS API Reference

Definition at line 29 of file GetUsageRequest.h.

Constructor & Destructor Documentation

◆ GetUsageRequest()

Aws::APIGateway::Model::GetUsageRequest::GetUsageRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EndDateHasBeenSet()

bool Aws::APIGateway::Model::GetUsageRequest::EndDateHasBeenSet ( ) const
inline

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Definition at line 176 of file GetUsageRequest.h.

◆ GetEndDate()

const Aws::String& Aws::APIGateway::Model::GetUsageRequest::GetEndDate ( ) const
inline

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Definition at line 171 of file GetUsageRequest.h.

◆ GetKeyId()

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

The Id of the API key associated with the resultant usage data.

Definition at line 89 of file GetUsageRequest.h.

◆ GetLimit()

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

◆ GetPosition()

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

The current pagination position in the paged result set.

Definition at line 212 of file GetUsageRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file GetUsageRequest.h.

◆ GetStartDate()

const Aws::String& Aws::APIGateway::Model::GetUsageRequest::GetStartDate ( ) const
inline

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Definition at line 130 of file GetUsageRequest.h.

◆ GetUsagePlanId()

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

[Required] The Id of the usage plan associated with the usage data.

Definition at line 48 of file GetUsageRequest.h.

◆ KeyIdHasBeenSet()

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

The Id of the API key associated with the resultant usage data.

Definition at line 94 of file GetUsageRequest.h.

◆ LimitHasBeenSet()

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

◆ PositionHasBeenSet()

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

The current pagination position in the paged result set.

Definition at line 217 of file GetUsageRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndDate() [1/3]

void Aws::APIGateway::Model::GetUsageRequest::SetEndDate ( Aws::String &&  value)
inline

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Definition at line 186 of file GetUsageRequest.h.

◆ SetEndDate() [2/3]

void Aws::APIGateway::Model::GetUsageRequest::SetEndDate ( const Aws::String value)
inline

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Definition at line 181 of file GetUsageRequest.h.

◆ SetEndDate() [3/3]

void Aws::APIGateway::Model::GetUsageRequest::SetEndDate ( const char *  value)
inline

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Definition at line 191 of file GetUsageRequest.h.

◆ SetKeyId() [1/3]

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

The Id of the API key associated with the resultant usage data.

Definition at line 104 of file GetUsageRequest.h.

◆ SetKeyId() [2/3]

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

The Id of the API key associated with the resultant usage data.

Definition at line 99 of file GetUsageRequest.h.

◆ SetKeyId() [3/3]

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

The Id of the API key associated with the resultant usage data.

Definition at line 109 of file GetUsageRequest.h.

◆ SetLimit()

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

◆ SetPosition() [1/3]

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

The current pagination position in the paged result set.

Definition at line 227 of file GetUsageRequest.h.

◆ SetPosition() [2/3]

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

The current pagination position in the paged result set.

Definition at line 222 of file GetUsageRequest.h.

◆ SetPosition() [3/3]

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

The current pagination position in the paged result set.

Definition at line 232 of file GetUsageRequest.h.

◆ SetStartDate() [1/3]

void Aws::APIGateway::Model::GetUsageRequest::SetStartDate ( Aws::String &&  value)
inline

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Definition at line 145 of file GetUsageRequest.h.

◆ SetStartDate() [2/3]

void Aws::APIGateway::Model::GetUsageRequest::SetStartDate ( const Aws::String value)
inline

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Definition at line 140 of file GetUsageRequest.h.

◆ SetStartDate() [3/3]

void Aws::APIGateway::Model::GetUsageRequest::SetStartDate ( const char *  value)
inline

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Definition at line 150 of file GetUsageRequest.h.

◆ SetUsagePlanId() [1/3]

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

[Required] The Id of the usage plan associated with the usage data.

Definition at line 63 of file GetUsageRequest.h.

◆ SetUsagePlanId() [2/3]

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

[Required] The Id of the usage plan associated with the usage data.

Definition at line 58 of file GetUsageRequest.h.

◆ SetUsagePlanId() [3/3]

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

[Required] The Id of the usage plan associated with the usage data.

Definition at line 68 of file GetUsageRequest.h.

◆ StartDateHasBeenSet()

bool Aws::APIGateway::Model::GetUsageRequest::StartDateHasBeenSet ( ) const
inline

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Definition at line 135 of file GetUsageRequest.h.

◆ UsagePlanIdHasBeenSet()

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

[Required] The Id of the usage plan associated with the usage data.

Definition at line 53 of file GetUsageRequest.h.

◆ WithEndDate() [1/3]

GetUsageRequest& Aws::APIGateway::Model::GetUsageRequest::WithEndDate ( Aws::String &&  value)
inline

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Definition at line 201 of file GetUsageRequest.h.

◆ WithEndDate() [2/3]

GetUsageRequest& Aws::APIGateway::Model::GetUsageRequest::WithEndDate ( const Aws::String value)
inline

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Definition at line 196 of file GetUsageRequest.h.

◆ WithEndDate() [3/3]

GetUsageRequest& Aws::APIGateway::Model::GetUsageRequest::WithEndDate ( const char *  value)
inline

[Required] The ending date (e.g., 2016-12-31) of the usage data.

Definition at line 206 of file GetUsageRequest.h.

◆ WithKeyId() [1/3]

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

The Id of the API key associated with the resultant usage data.

Definition at line 119 of file GetUsageRequest.h.

◆ WithKeyId() [2/3]

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

The Id of the API key associated with the resultant usage data.

Definition at line 114 of file GetUsageRequest.h.

◆ WithKeyId() [3/3]

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

The Id of the API key associated with the resultant usage data.

Definition at line 124 of file GetUsageRequest.h.

◆ WithLimit()

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

◆ WithPosition() [1/3]

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

The current pagination position in the paged result set.

Definition at line 242 of file GetUsageRequest.h.

◆ WithPosition() [2/3]

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

The current pagination position in the paged result set.

Definition at line 237 of file GetUsageRequest.h.

◆ WithPosition() [3/3]

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

The current pagination position in the paged result set.

Definition at line 247 of file GetUsageRequest.h.

◆ WithStartDate() [1/3]

GetUsageRequest& Aws::APIGateway::Model::GetUsageRequest::WithStartDate ( Aws::String &&  value)
inline

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Definition at line 160 of file GetUsageRequest.h.

◆ WithStartDate() [2/3]

GetUsageRequest& Aws::APIGateway::Model::GetUsageRequest::WithStartDate ( const Aws::String value)
inline

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Definition at line 155 of file GetUsageRequest.h.

◆ WithStartDate() [3/3]

GetUsageRequest& Aws::APIGateway::Model::GetUsageRequest::WithStartDate ( const char *  value)
inline

[Required] The starting date (e.g., 2016-01-01) of the usage data.

Definition at line 165 of file GetUsageRequest.h.

◆ WithUsagePlanId() [1/3]

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

[Required] The Id of the usage plan associated with the usage data.

Definition at line 78 of file GetUsageRequest.h.

◆ WithUsagePlanId() [2/3]

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

[Required] The Id of the usage plan associated with the usage data.

Definition at line 73 of file GetUsageRequest.h.

◆ WithUsagePlanId() [3/3]

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

[Required] The Id of the usage plan associated with the usage data.

Definition at line 83 of file GetUsageRequest.h.


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