Package software.amazon.awssdk.services.apigateway.model

Class UsagePlan

java.lang.Object

software.amazon.awssdk.services.apigateway.model.UsagePlan

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<UsagePlan.Builder,UsagePlan>

@Generated("software.amazon.awssdk:codegen")
public class UsagePlan
extends Object
implements StructuredPojo, ToCopyableBuilder<UsagePlan.Builder,UsagePlan>

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.

Create and Use Usage Plans

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UsagePlan.Builder

Method Summary

Modifier and Type	Method	Description
List<ApiStage>	apiStages()	The associated API stages of a usage plan.
static UsagePlan.Builder	builder()
String	description()	The description of a usage plan.
boolean	equals(Object obj)
int	hashCode()
String	id()	The identifier of a UsagePlan resource.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The name of a usage plan.
String	productCode()	The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
QuotaSettings	quota()	The maximum number of permitted requests per a given unit time interval.
static Class<? extends UsagePlan.Builder>	serializableBuilderClass()
ThrottleSettings	throttle()	The request throttle limits of a usage plan.
UsagePlan.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

id

public String id()

The identifier of a UsagePlan resource.

Returns:

The identifier of a UsagePlan resource.

name

public String name()

The name of a usage plan.

Returns:

The name of a usage plan.

description

public String description()

The description of a usage plan.

Returns:

The description of a usage plan.

apiStages

public List<ApiStage> apiStages()

The associated API stages of a usage plan.

Returns:

The associated API stages of a usage plan.

throttle

public ThrottleSettings throttle()

The request throttle limits of a usage plan.

Returns:

The request throttle limits of a usage plan.

quota

public QuotaSettings quota()

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

Returns:

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

productCode

public String productCode()

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

Returns:

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

toBuilder

public UsagePlan.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UsagePlan.Builder,UsagePlan>

Returns:

a builder for type T

builder

public static UsagePlan.Builder builder()

serializableBuilderClass

public static Class<? extends UsagePlan.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.