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

#include <GetUsagePlanKeyResult.h>

Public Member Functions

 GetUsagePlanKeyResult ()
 
 GetUsagePlanKeyResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetUsagePlanKeyResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
GetUsagePlanKeyResultWithId (const Aws::String &value)
 
GetUsagePlanKeyResultWithId (Aws::String &&value)
 
GetUsagePlanKeyResultWithId (const char *value)
 
const Aws::StringGetType () const
 
void SetType (const Aws::String &value)
 
void SetType (Aws::String &&value)
 
void SetType (const char *value)
 
GetUsagePlanKeyResultWithType (const Aws::String &value)
 
GetUsagePlanKeyResultWithType (Aws::String &&value)
 
GetUsagePlanKeyResultWithType (const char *value)
 
const Aws::StringGetValue () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
GetUsagePlanKeyResultWithValue (const Aws::String &value)
 
GetUsagePlanKeyResultWithValue (Aws::String &&value)
 
GetUsagePlanKeyResultWithValue (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
GetUsagePlanKeyResultWithName (const Aws::String &value)
 
GetUsagePlanKeyResultWithName (Aws::String &&value)
 
GetUsagePlanKeyResultWithName (const char *value)
 

Detailed Description

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

" <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html">Create and Use Usage Plans

See Also:

AWS API Reference

Definition at line 37 of file GetUsagePlanKeyResult.h.

Constructor & Destructor Documentation

◆ GetUsagePlanKeyResult() [1/2]

Aws::APIGateway::Model::GetUsagePlanKeyResult::GetUsagePlanKeyResult ( )

◆ GetUsagePlanKeyResult() [2/2]

Aws::APIGateway::Model::GetUsagePlanKeyResult::GetUsagePlanKeyResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetId()

const Aws::String& Aws::APIGateway::Model::GetUsagePlanKeyResult::GetId ( ) const
inline

The Id of a usage plan key.

Definition at line 48 of file GetUsagePlanKeyResult.h.

◆ GetName()

const Aws::String& Aws::APIGateway::Model::GetUsagePlanKeyResult::GetName ( ) const
inline

The name of a usage plan key.

Definition at line 163 of file GetUsagePlanKeyResult.h.

◆ GetType()

const Aws::String& Aws::APIGateway::Model::GetUsagePlanKeyResult::GetType ( ) const
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 85 of file GetUsagePlanKeyResult.h.

◆ GetValue()

const Aws::String& Aws::APIGateway::Model::GetUsagePlanKeyResult::GetValue ( ) const
inline

The value of a usage plan key.

Definition at line 127 of file GetUsagePlanKeyResult.h.

◆ operator=()

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetId() [1/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetId ( Aws::String &&  value)
inline

The Id of a usage plan key.

Definition at line 58 of file GetUsagePlanKeyResult.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetId ( const Aws::String value)
inline

The Id of a usage plan key.

Definition at line 53 of file GetUsagePlanKeyResult.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetId ( const char *  value)
inline

The Id of a usage plan key.

Definition at line 63 of file GetUsagePlanKeyResult.h.

◆ SetName() [1/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetName ( Aws::String &&  value)
inline

The name of a usage plan key.

Definition at line 173 of file GetUsagePlanKeyResult.h.

◆ SetName() [2/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetName ( const Aws::String value)
inline

The name of a usage plan key.

Definition at line 168 of file GetUsagePlanKeyResult.h.

◆ SetName() [3/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetName ( const char *  value)
inline

The name of a usage plan key.

Definition at line 178 of file GetUsagePlanKeyResult.h.

◆ SetType() [1/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetType ( Aws::String &&  value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 97 of file GetUsagePlanKeyResult.h.

◆ SetType() [2/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetType ( const Aws::String value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 91 of file GetUsagePlanKeyResult.h.

◆ SetType() [3/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetType ( const char *  value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 103 of file GetUsagePlanKeyResult.h.

◆ SetValue() [1/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetValue ( Aws::String &&  value)
inline

The value of a usage plan key.

Definition at line 137 of file GetUsagePlanKeyResult.h.

◆ SetValue() [2/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetValue ( const Aws::String value)
inline

The value of a usage plan key.

Definition at line 132 of file GetUsagePlanKeyResult.h.

◆ SetValue() [3/3]

void Aws::APIGateway::Model::GetUsagePlanKeyResult::SetValue ( const char *  value)
inline

The value of a usage plan key.

Definition at line 142 of file GetUsagePlanKeyResult.h.

◆ WithId() [1/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithId ( Aws::String &&  value)
inline

The Id of a usage plan key.

Definition at line 73 of file GetUsagePlanKeyResult.h.

◆ WithId() [2/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithId ( const Aws::String value)
inline

The Id of a usage plan key.

Definition at line 68 of file GetUsagePlanKeyResult.h.

◆ WithId() [3/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithId ( const char *  value)
inline

The Id of a usage plan key.

Definition at line 78 of file GetUsagePlanKeyResult.h.

◆ WithName() [1/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithName ( Aws::String &&  value)
inline

The name of a usage plan key.

Definition at line 188 of file GetUsagePlanKeyResult.h.

◆ WithName() [2/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithName ( const Aws::String value)
inline

The name of a usage plan key.

Definition at line 183 of file GetUsagePlanKeyResult.h.

◆ WithName() [3/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithName ( const char *  value)
inline

The name of a usage plan key.

Definition at line 193 of file GetUsagePlanKeyResult.h.

◆ WithType() [1/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithType ( Aws::String &&  value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 115 of file GetUsagePlanKeyResult.h.

◆ WithType() [2/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithType ( const Aws::String value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 109 of file GetUsagePlanKeyResult.h.

◆ WithType() [3/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithType ( const char *  value)
inline

The type of a usage plan key. Currently, the valid key type is API_KEY.

Definition at line 121 of file GetUsagePlanKeyResult.h.

◆ WithValue() [1/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithValue ( Aws::String &&  value)
inline

The value of a usage plan key.

Definition at line 152 of file GetUsagePlanKeyResult.h.

◆ WithValue() [2/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithValue ( const Aws::String value)
inline

The value of a usage plan key.

Definition at line 147 of file GetUsagePlanKeyResult.h.

◆ WithValue() [3/3]

GetUsagePlanKeyResult& Aws::APIGateway::Model::GetUsagePlanKeyResult::WithValue ( const char *  value)
inline

The value of a usage plan key.

Definition at line 157 of file GetUsagePlanKeyResult.h.


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