Package software.amazon.awscdk.services.apigateway

Class QuotaSettings.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.QuotaSettings.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<QuotaSettings>

Enclosing interface:

QuotaSettings

@Stability(Stable)
public static final class QuotaSettings.Builder
extends Object
implements software.amazon.jsii.Builder<QuotaSettings>

A builder for QuotaSettings

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QuotaSettings	build()	Builds the configured instance.
QuotaSettings.Builder	limit(Number limit)	Sets the value of QuotaSettings.getLimit()
QuotaSettings.Builder	offset(Number offset)	Sets the value of QuotaSettings.getOffset()
QuotaSettings.Builder	period(Period period)	Sets the value of QuotaSettings.getPeriod()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

limit

@Stability(Stable)
public QuotaSettings.Builder limit(Number limit)

Sets the value of QuotaSettings.getLimit()

Parameters:

limit - The maximum number of requests that users can make within the specified time period.

Returns:

this

offset

@Stability(Stable)
public QuotaSettings.Builder offset(Number offset)

Sets the value of QuotaSettings.getOffset()

Parameters:

offset - For the initial time period, the number of requests to subtract from the specified limit.

Returns:

this

period

@Stability(Stable)
public QuotaSettings.Builder period(Period period)

Sets the value of QuotaSettings.getPeriod()

Parameters:

period - The time period for which the maximum limit of requests applies.

Returns:

this

build

@Stability(Stable)
public QuotaSettings build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<QuotaSettings>

Returns:

a new instance of QuotaSettings

Throws:

NullPointerException - if any required attribute was not provided