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

#include <DeleteUsagePlanKeyRequest.h>

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

Public Member Functions

 DeleteUsagePlanKeyRequest ()
 
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)
 
DeleteUsagePlanKeyRequestWithUsagePlanId (const Aws::String &value)
 
DeleteUsagePlanKeyRequestWithUsagePlanId (Aws::String &&value)
 
DeleteUsagePlanKeyRequestWithUsagePlanId (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)
 
DeleteUsagePlanKeyRequestWithKeyId (const Aws::String &value)
 
DeleteUsagePlanKeyRequestWithKeyId (Aws::String &&value)
 
DeleteUsagePlanKeyRequestWithKeyId (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 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 DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

See Also:

AWS API Reference

Definition at line 25 of file DeleteUsagePlanKeyRequest.h.

Constructor & Destructor Documentation

◆ DeleteUsagePlanKeyRequest()

Aws::APIGateway::Model::DeleteUsagePlanKeyRequest::DeleteUsagePlanKeyRequest ( )

Member Function Documentation

◆ GetKeyId()

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

[Required] The Id of the UsagePlanKey resource to be deleted.

Definition at line 99 of file DeleteUsagePlanKeyRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DeleteUsagePlanKeyRequest.h.

◆ GetUsagePlanId()

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

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

Definition at line 44 of file DeleteUsagePlanKeyRequest.h.

◆ KeyIdHasBeenSet()

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

[Required] The Id of the UsagePlanKey resource to be deleted.

Definition at line 104 of file DeleteUsagePlanKeyRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

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

[Required] The Id of the UsagePlanKey resource to be deleted.

Definition at line 114 of file DeleteUsagePlanKeyRequest.h.

◆ SetKeyId() [2/3]

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

[Required] The Id of the UsagePlanKey resource to be deleted.

Definition at line 109 of file DeleteUsagePlanKeyRequest.h.

◆ SetKeyId() [3/3]

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

[Required] The Id of the UsagePlanKey resource to be deleted.

Definition at line 119 of file DeleteUsagePlanKeyRequest.h.

◆ SetUsagePlanId() [1/3]

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

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

Definition at line 65 of file DeleteUsagePlanKeyRequest.h.

◆ SetUsagePlanId() [2/3]

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

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

Definition at line 58 of file DeleteUsagePlanKeyRequest.h.

◆ SetUsagePlanId() [3/3]

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

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

Definition at line 72 of file DeleteUsagePlanKeyRequest.h.

◆ UsagePlanIdHasBeenSet()

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

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

Definition at line 51 of file DeleteUsagePlanKeyRequest.h.

◆ WithKeyId() [1/3]

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

[Required] The Id of the UsagePlanKey resource to be deleted.

Definition at line 129 of file DeleteUsagePlanKeyRequest.h.

◆ WithKeyId() [2/3]

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

[Required] The Id of the UsagePlanKey resource to be deleted.

Definition at line 124 of file DeleteUsagePlanKeyRequest.h.

◆ WithKeyId() [3/3]

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

[Required] The Id of the UsagePlanKey resource to be deleted.

Definition at line 134 of file DeleteUsagePlanKeyRequest.h.

◆ WithUsagePlanId() [1/3]

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

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

Definition at line 86 of file DeleteUsagePlanKeyRequest.h.

◆ WithUsagePlanId() [2/3]

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

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

Definition at line 79 of file DeleteUsagePlanKeyRequest.h.

◆ WithUsagePlanId() [3/3]

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

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

Definition at line 93 of file DeleteUsagePlanKeyRequest.h.


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