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

#include <QuotaSettings.h>

Public Member Functions

 QuotaSettings ()
 
 QuotaSettings (Aws::Utils::Json::JsonView jsonValue)
 
QuotaSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
QuotaSettingsWithLimit (int value)
 
int GetOffset () const
 
bool OffsetHasBeenSet () const
 
void SetOffset (int value)
 
QuotaSettingsWithOffset (int value)
 
const QuotaPeriodTypeGetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (const QuotaPeriodType &value)
 
void SetPeriod (QuotaPeriodType &&value)
 
QuotaSettingsWithPeriod (const QuotaPeriodType &value)
 
QuotaSettingsWithPeriod (QuotaPeriodType &&value)
 

Detailed Description

Quotas configured for a usage plan.

See Also:

AWS API Reference

Definition at line 31 of file QuotaSettings.h.

Constructor & Destructor Documentation

◆ QuotaSettings() [1/2]

Aws::APIGateway::Model::QuotaSettings::QuotaSettings ( )

◆ QuotaSettings() [2/2]

Aws::APIGateway::Model::QuotaSettings::QuotaSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetLimit()

int Aws::APIGateway::Model::QuotaSettings::GetLimit ( ) const
inline

The maximum number of requests that can be made in a given time period.

Definition at line 43 of file QuotaSettings.h.

◆ GetOffset()

int Aws::APIGateway::Model::QuotaSettings::GetOffset ( ) const
inline

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Definition at line 66 of file QuotaSettings.h.

◆ GetPeriod()

const QuotaPeriodType& Aws::APIGateway::Model::QuotaSettings::GetPeriod ( ) const
inline

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Definition at line 94 of file QuotaSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::QuotaSettings::Jsonize ( ) const

◆ LimitHasBeenSet()

bool Aws::APIGateway::Model::QuotaSettings::LimitHasBeenSet ( ) const
inline

The maximum number of requests that can be made in a given time period.

Definition at line 48 of file QuotaSettings.h.

◆ OffsetHasBeenSet()

bool Aws::APIGateway::Model::QuotaSettings::OffsetHasBeenSet ( ) const
inline

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Definition at line 73 of file QuotaSettings.h.

◆ operator=()

QuotaSettings& Aws::APIGateway::Model::QuotaSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PeriodHasBeenSet()

bool Aws::APIGateway::Model::QuotaSettings::PeriodHasBeenSet ( ) const
inline

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Definition at line 100 of file QuotaSettings.h.

◆ SetLimit()

void Aws::APIGateway::Model::QuotaSettings::SetLimit ( int  value)
inline

The maximum number of requests that can be made in a given time period.

Definition at line 53 of file QuotaSettings.h.

◆ SetOffset()

void Aws::APIGateway::Model::QuotaSettings::SetOffset ( int  value)
inline

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Definition at line 80 of file QuotaSettings.h.

◆ SetPeriod() [1/2]

void Aws::APIGateway::Model::QuotaSettings::SetPeriod ( const QuotaPeriodType value)
inline

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Definition at line 106 of file QuotaSettings.h.

◆ SetPeriod() [2/2]

void Aws::APIGateway::Model::QuotaSettings::SetPeriod ( QuotaPeriodType &&  value)
inline

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Definition at line 112 of file QuotaSettings.h.

◆ WithLimit()

QuotaSettings& Aws::APIGateway::Model::QuotaSettings::WithLimit ( int  value)
inline

The maximum number of requests that can be made in a given time period.

Definition at line 58 of file QuotaSettings.h.

◆ WithOffset()

QuotaSettings& Aws::APIGateway::Model::QuotaSettings::WithOffset ( int  value)
inline

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Definition at line 87 of file QuotaSettings.h.

◆ WithPeriod() [1/2]

QuotaSettings& Aws::APIGateway::Model::QuotaSettings::WithPeriod ( const QuotaPeriodType value)
inline

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Definition at line 118 of file QuotaSettings.h.

◆ WithPeriod() [2/2]

QuotaSettings& Aws::APIGateway::Model::QuotaSettings::WithPeriod ( QuotaPeriodType &&  value)
inline

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Definition at line 124 of file QuotaSettings.h.


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