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

#include <UpdateUsageRequest.h>

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

Public Member Functions

 UpdateUsageRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () 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)
 
UpdateUsageRequestWithUsagePlanId (const Aws::String &value)
 
UpdateUsageRequestWithUsagePlanId (Aws::String &&value)
 
UpdateUsageRequestWithUsagePlanId (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)
 
UpdateUsageRequestWithKeyId (const Aws::String &value)
 
UpdateUsageRequestWithKeyId (Aws::String &&value)
 
UpdateUsageRequestWithKeyId (const char *value)
 
const Aws::Vector< PatchOperation > & GetPatchOperations () const
 
bool PatchOperationsHasBeenSet () const
 
void SetPatchOperations (const Aws::Vector< PatchOperation > &value)
 
void SetPatchOperations (Aws::Vector< PatchOperation > &&value)
 
UpdateUsageRequestWithPatchOperations (const Aws::Vector< PatchOperation > &value)
 
UpdateUsageRequestWithPatchOperations (Aws::Vector< PatchOperation > &&value)
 
UpdateUsageRequestAddPatchOperations (const PatchOperation &value)
 
UpdateUsageRequestAddPatchOperations (PatchOperation &&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 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::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 PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

See Also:

AWS API Reference

Definition at line 27 of file UpdateUsageRequest.h.

Constructor & Destructor Documentation

◆ UpdateUsageRequest()

Aws::APIGateway::Model::UpdateUsageRequest::UpdateUsageRequest ( )

Member Function Documentation

◆ AddPatchOperations() [1/2]

UpdateUsageRequest& Aws::APIGateway::Model::UpdateUsageRequest::AddPatchOperations ( const PatchOperation value)
inline

A list of update operations to be applied to the specified resource and in the order specified in this list.

Definition at line 171 of file UpdateUsageRequest.h.

◆ AddPatchOperations() [2/2]

UpdateUsageRequest& Aws::APIGateway::Model::UpdateUsageRequest::AddPatchOperations ( PatchOperation &&  value)
inline

A list of update operations to be applied to the specified resource and in the order specified in this list.

Definition at line 177 of file UpdateUsageRequest.h.

◆ GetKeyId()

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

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Definition at line 86 of file UpdateUsageRequest.h.

◆ GetPatchOperations()

const Aws::Vector<PatchOperation>& Aws::APIGateway::Model::UpdateUsageRequest::GetPatchOperations ( ) const
inline

A list of update operations to be applied to the specified resource and in the order specified in this list.

Definition at line 135 of file UpdateUsageRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file UpdateUsageRequest.h.

◆ GetUsagePlanId()

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

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

Definition at line 44 of file UpdateUsageRequest.h.

◆ KeyIdHasBeenSet()

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

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Definition at line 92 of file UpdateUsageRequest.h.

◆ PatchOperationsHasBeenSet()

bool Aws::APIGateway::Model::UpdateUsageRequest::PatchOperationsHasBeenSet ( ) const
inline

A list of update operations to be applied to the specified resource and in the order specified in this list.

Definition at line 141 of file UpdateUsageRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

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

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Definition at line 98 of file UpdateUsageRequest.h.

◆ SetKeyId() [2/3]

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

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Definition at line 104 of file UpdateUsageRequest.h.

◆ SetKeyId() [3/3]

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

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Definition at line 110 of file UpdateUsageRequest.h.

◆ SetPatchOperations() [1/2]

void Aws::APIGateway::Model::UpdateUsageRequest::SetPatchOperations ( const Aws::Vector< PatchOperation > &  value)
inline

A list of update operations to be applied to the specified resource and in the order specified in this list.

Definition at line 147 of file UpdateUsageRequest.h.

◆ SetPatchOperations() [2/2]

void Aws::APIGateway::Model::UpdateUsageRequest::SetPatchOperations ( Aws::Vector< PatchOperation > &&  value)
inline

A list of update operations to be applied to the specified resource and in the order specified in this list.

Definition at line 153 of file UpdateUsageRequest.h.

◆ SetUsagePlanId() [1/3]

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

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

Definition at line 54 of file UpdateUsageRequest.h.

◆ SetUsagePlanId() [2/3]

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

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

Definition at line 59 of file UpdateUsageRequest.h.

◆ SetUsagePlanId() [3/3]

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

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

Definition at line 64 of file UpdateUsageRequest.h.

◆ UsagePlanIdHasBeenSet()

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

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

Definition at line 49 of file UpdateUsageRequest.h.

◆ WithKeyId() [1/3]

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

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Definition at line 116 of file UpdateUsageRequest.h.

◆ WithKeyId() [2/3]

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

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Definition at line 122 of file UpdateUsageRequest.h.

◆ WithKeyId() [3/3]

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

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Definition at line 128 of file UpdateUsageRequest.h.

◆ WithPatchOperations() [1/2]

UpdateUsageRequest& Aws::APIGateway::Model::UpdateUsageRequest::WithPatchOperations ( const Aws::Vector< PatchOperation > &  value)
inline

A list of update operations to be applied to the specified resource and in the order specified in this list.

Definition at line 159 of file UpdateUsageRequest.h.

◆ WithPatchOperations() [2/2]

UpdateUsageRequest& Aws::APIGateway::Model::UpdateUsageRequest::WithPatchOperations ( Aws::Vector< PatchOperation > &&  value)
inline

A list of update operations to be applied to the specified resource and in the order specified in this list.

Definition at line 165 of file UpdateUsageRequest.h.

◆ WithUsagePlanId() [1/3]

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

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

Definition at line 69 of file UpdateUsageRequest.h.

◆ WithUsagePlanId() [2/3]

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

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

Definition at line 74 of file UpdateUsageRequest.h.

◆ WithUsagePlanId() [3/3]

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

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

Definition at line 79 of file UpdateUsageRequest.h.


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