software.amazon.awssdk.services.apigateway.model

Class UsagePlan

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UsagePlan.Builder,UsagePlan>

@Generated(value="software.amazon.awssdk:codegen")
public final class UsagePlan
extends Object
implements SdkPojo, Serializable, 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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UsagePlan.Builder

Method Summary

Modifier and Type	Method and 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasApiStages() Returns true if the ApiStages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	id() The identifier of a UsagePlan resource.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends UsagePlan.Builder>	serializableBuilderClass()
Map<String,String>	tags() The collection of tags.
ThrottleSettings	throttle() The request throttle limits of a usage plan.
UsagePlan.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The identifier of a UsagePlan resource.

Returns:

The identifier of a UsagePlan resource.

name

public final String name()

The name of a usage plan.

Returns:

The name of a usage plan.

description

public final String description()

The description of a usage plan.

Returns:

The description of a usage plan.

hasApiStages

public final boolean hasApiStages()

Returns true if the ApiStages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

apiStages

public final List<ApiStage> apiStages()

The associated API stages of a usage plan.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasApiStages() to see if a value was sent in this field.

Returns:

The associated API stages of a usage plan.

throttle

public final ThrottleSettings throttle()

The request throttle limits of a usage plan.

Returns:

The request throttle limits of a usage plan.

quota

public final 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 final 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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

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

toBuilder

public UsagePlan.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsagePlan.Builder,UsagePlan>

builder

public static UsagePlan.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo