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

#include <GetUsagePlanResult.h>

Public Member Functions

 GetUsagePlanResult ()
 
 GetUsagePlanResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetUsagePlanResultoperator= (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)
 
GetUsagePlanResultWithId (const Aws::String &value)
 
GetUsagePlanResultWithId (Aws::String &&value)
 
GetUsagePlanResultWithId (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
GetUsagePlanResultWithName (const Aws::String &value)
 
GetUsagePlanResultWithName (Aws::String &&value)
 
GetUsagePlanResultWithName (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
GetUsagePlanResultWithDescription (const Aws::String &value)
 
GetUsagePlanResultWithDescription (Aws::String &&value)
 
GetUsagePlanResultWithDescription (const char *value)
 
const Aws::Vector< ApiStage > & GetApiStages () const
 
void SetApiStages (const Aws::Vector< ApiStage > &value)
 
void SetApiStages (Aws::Vector< ApiStage > &&value)
 
GetUsagePlanResultWithApiStages (const Aws::Vector< ApiStage > &value)
 
GetUsagePlanResultWithApiStages (Aws::Vector< ApiStage > &&value)
 
GetUsagePlanResultAddApiStages (const ApiStage &value)
 
GetUsagePlanResultAddApiStages (ApiStage &&value)
 
const ThrottleSettingsGetThrottle () const
 
void SetThrottle (const ThrottleSettings &value)
 
void SetThrottle (ThrottleSettings &&value)
 
GetUsagePlanResultWithThrottle (const ThrottleSettings &value)
 
GetUsagePlanResultWithThrottle (ThrottleSettings &&value)
 
const QuotaSettingsGetQuota () const
 
void SetQuota (const QuotaSettings &value)
 
void SetQuota (QuotaSettings &&value)
 
GetUsagePlanResultWithQuota (const QuotaSettings &value)
 
GetUsagePlanResultWithQuota (QuotaSettings &&value)
 
const Aws::StringGetProductCode () const
 
void SetProductCode (const Aws::String &value)
 
void SetProductCode (Aws::String &&value)
 
void SetProductCode (const char *value)
 
GetUsagePlanResultWithProductCode (const Aws::String &value)
 
GetUsagePlanResultWithProductCode (Aws::String &&value)
 
GetUsagePlanResultWithProductCode (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
GetUsagePlanResultWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
GetUsagePlanResultWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
GetUsagePlanResultAddTags (const Aws::String &key, const Aws::String &value)
 
GetUsagePlanResultAddTags (Aws::String &&key, const Aws::String &value)
 
GetUsagePlanResultAddTags (const Aws::String &key, Aws::String &&value)
 
GetUsagePlanResultAddTags (Aws::String &&key, Aws::String &&value)
 
GetUsagePlanResultAddTags (const char *key, Aws::String &&value)
 
GetUsagePlanResultAddTags (Aws::String &&key, const char *value)
 
GetUsagePlanResultAddTags (const char *key, const char *value)
 

Detailed Description

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

See Also:

AWS API Reference

Definition at line 43 of file GetUsagePlanResult.h.

Constructor & Destructor Documentation

◆ GetUsagePlanResult() [1/2]

Aws::APIGateway::Model::GetUsagePlanResult::GetUsagePlanResult ( )

◆ GetUsagePlanResult() [2/2]

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

Member Function Documentation

◆ AddApiStages() [1/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddApiStages ( ApiStage &&  value)
inline

The associated API stages of a usage plan.

Definition at line 192 of file GetUsagePlanResult.h.

◆ AddApiStages() [2/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddApiStages ( const ApiStage value)
inline

The associated API stages of a usage plan.

Definition at line 187 of file GetUsagePlanResult.h.

◆ AddTags() [1/7]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 342 of file GetUsagePlanResult.h.

◆ AddTags() [2/7]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 330 of file GetUsagePlanResult.h.

◆ AddTags() [3/7]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 354 of file GetUsagePlanResult.h.

◆ AddTags() [4/7]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 336 of file GetUsagePlanResult.h.

◆ AddTags() [5/7]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 324 of file GetUsagePlanResult.h.

◆ AddTags() [6/7]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 348 of file GetUsagePlanResult.h.

◆ AddTags() [7/7]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::AddTags ( const char *  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 360 of file GetUsagePlanResult.h.

◆ GetApiStages()

const Aws::Vector<ApiStage>& Aws::APIGateway::Model::GetUsagePlanResult::GetApiStages ( ) const
inline

The associated API stages of a usage plan.

Definition at line 162 of file GetUsagePlanResult.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::GetUsagePlanResult::GetDescription ( ) const
inline

The description of a usage plan.

Definition at line 126 of file GetUsagePlanResult.h.

◆ GetId()

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

The identifier of a UsagePlan resource.

Definition at line 54 of file GetUsagePlanResult.h.

◆ GetName()

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

The name of a usage plan.

Definition at line 90 of file GetUsagePlanResult.h.

◆ GetProductCode()

const Aws::String& Aws::APIGateway::Model::GetUsagePlanResult::GetProductCode ( ) const
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 251 of file GetUsagePlanResult.h.

◆ GetQuota()

const QuotaSettings& Aws::APIGateway::Model::GetUsagePlanResult::GetQuota ( ) const
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 224 of file GetUsagePlanResult.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::GetUsagePlanResult::GetTags ( ) const
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 294 of file GetUsagePlanResult.h.

◆ GetThrottle()

const ThrottleSettings& Aws::APIGateway::Model::GetUsagePlanResult::GetThrottle ( ) const
inline

The request throttle limits of a usage plan.

Definition at line 198 of file GetUsagePlanResult.h.

◆ operator=()

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

◆ SetApiStages() [1/2]

void Aws::APIGateway::Model::GetUsagePlanResult::SetApiStages ( Aws::Vector< ApiStage > &&  value)
inline

The associated API stages of a usage plan.

Definition at line 172 of file GetUsagePlanResult.h.

◆ SetApiStages() [2/2]

void Aws::APIGateway::Model::GetUsagePlanResult::SetApiStages ( const Aws::Vector< ApiStage > &  value)
inline

The associated API stages of a usage plan.

Definition at line 167 of file GetUsagePlanResult.h.

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::GetUsagePlanResult::SetDescription ( Aws::String &&  value)
inline

The description of a usage plan.

Definition at line 136 of file GetUsagePlanResult.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::GetUsagePlanResult::SetDescription ( const Aws::String value)
inline

The description of a usage plan.

Definition at line 131 of file GetUsagePlanResult.h.

◆ SetDescription() [3/3]

void Aws::APIGateway::Model::GetUsagePlanResult::SetDescription ( const char *  value)
inline

The description of a usage plan.

Definition at line 141 of file GetUsagePlanResult.h.

◆ SetId() [1/3]

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

The identifier of a UsagePlan resource.

Definition at line 64 of file GetUsagePlanResult.h.

◆ SetId() [2/3]

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

The identifier of a UsagePlan resource.

Definition at line 59 of file GetUsagePlanResult.h.

◆ SetId() [3/3]

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

The identifier of a UsagePlan resource.

Definition at line 69 of file GetUsagePlanResult.h.

◆ SetName() [1/3]

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

The name of a usage plan.

Definition at line 100 of file GetUsagePlanResult.h.

◆ SetName() [2/3]

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

The name of a usage plan.

Definition at line 95 of file GetUsagePlanResult.h.

◆ SetName() [3/3]

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

The name of a usage plan.

Definition at line 105 of file GetUsagePlanResult.h.

◆ SetProductCode() [1/3]

void Aws::APIGateway::Model::GetUsagePlanResult::SetProductCode ( Aws::String &&  value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 263 of file GetUsagePlanResult.h.

◆ SetProductCode() [2/3]

void Aws::APIGateway::Model::GetUsagePlanResult::SetProductCode ( const Aws::String value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 257 of file GetUsagePlanResult.h.

◆ SetProductCode() [3/3]

void Aws::APIGateway::Model::GetUsagePlanResult::SetProductCode ( const char *  value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 269 of file GetUsagePlanResult.h.

◆ SetQuota() [1/2]

void Aws::APIGateway::Model::GetUsagePlanResult::SetQuota ( const QuotaSettings value)
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 229 of file GetUsagePlanResult.h.

◆ SetQuota() [2/2]

void Aws::APIGateway::Model::GetUsagePlanResult::SetQuota ( QuotaSettings &&  value)
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 234 of file GetUsagePlanResult.h.

◆ SetTags() [1/2]

void Aws::APIGateway::Model::GetUsagePlanResult::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 306 of file GetUsagePlanResult.h.

◆ SetTags() [2/2]

void Aws::APIGateway::Model::GetUsagePlanResult::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 300 of file GetUsagePlanResult.h.

◆ SetThrottle() [1/2]

void Aws::APIGateway::Model::GetUsagePlanResult::SetThrottle ( const ThrottleSettings value)
inline

The request throttle limits of a usage plan.

Definition at line 203 of file GetUsagePlanResult.h.

◆ SetThrottle() [2/2]

void Aws::APIGateway::Model::GetUsagePlanResult::SetThrottle ( ThrottleSettings &&  value)
inline

The request throttle limits of a usage plan.

Definition at line 208 of file GetUsagePlanResult.h.

◆ WithApiStages() [1/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithApiStages ( Aws::Vector< ApiStage > &&  value)
inline

The associated API stages of a usage plan.

Definition at line 182 of file GetUsagePlanResult.h.

◆ WithApiStages() [2/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithApiStages ( const Aws::Vector< ApiStage > &  value)
inline

The associated API stages of a usage plan.

Definition at line 177 of file GetUsagePlanResult.h.

◆ WithDescription() [1/3]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithDescription ( Aws::String &&  value)
inline

The description of a usage plan.

Definition at line 151 of file GetUsagePlanResult.h.

◆ WithDescription() [2/3]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithDescription ( const Aws::String value)
inline

The description of a usage plan.

Definition at line 146 of file GetUsagePlanResult.h.

◆ WithDescription() [3/3]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithDescription ( const char *  value)
inline

The description of a usage plan.

Definition at line 156 of file GetUsagePlanResult.h.

◆ WithId() [1/3]

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

The identifier of a UsagePlan resource.

Definition at line 79 of file GetUsagePlanResult.h.

◆ WithId() [2/3]

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

The identifier of a UsagePlan resource.

Definition at line 74 of file GetUsagePlanResult.h.

◆ WithId() [3/3]

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

The identifier of a UsagePlan resource.

Definition at line 84 of file GetUsagePlanResult.h.

◆ WithName() [1/3]

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

The name of a usage plan.

Definition at line 115 of file GetUsagePlanResult.h.

◆ WithName() [2/3]

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

The name of a usage plan.

Definition at line 110 of file GetUsagePlanResult.h.

◆ WithName() [3/3]

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

The name of a usage plan.

Definition at line 120 of file GetUsagePlanResult.h.

◆ WithProductCode() [1/3]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithProductCode ( Aws::String &&  value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 281 of file GetUsagePlanResult.h.

◆ WithProductCode() [2/3]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithProductCode ( const Aws::String value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 275 of file GetUsagePlanResult.h.

◆ WithProductCode() [3/3]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithProductCode ( const char *  value)
inline

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Definition at line 287 of file GetUsagePlanResult.h.

◆ WithQuota() [1/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithQuota ( const QuotaSettings value)
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 239 of file GetUsagePlanResult.h.

◆ WithQuota() [2/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithQuota ( QuotaSettings &&  value)
inline

The maximum number of permitted requests per a given unit time interval.

Definition at line 244 of file GetUsagePlanResult.h.

◆ WithTags() [1/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 318 of file GetUsagePlanResult.h.

◆ WithTags() [2/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 312 of file GetUsagePlanResult.h.

◆ WithThrottle() [1/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithThrottle ( const ThrottleSettings value)
inline

The request throttle limits of a usage plan.

Definition at line 213 of file GetUsagePlanResult.h.

◆ WithThrottle() [2/2]

GetUsagePlanResult& Aws::APIGateway::Model::GetUsagePlanResult::WithThrottle ( ThrottleSettings &&  value)
inline

The request throttle limits of a usage plan.

Definition at line 218 of file GetUsagePlanResult.h.


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