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

Class CreateUsagePlanRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.CreateUsagePlanRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>

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

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUsagePlanRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
List<ApiStage>	apiStages()	The associated API stages of the usage plan.
static CreateUsagePlanRequest.Builder	builder()
String	description()	The description of the usage plan.
boolean	equals(Object obj)
int	hashCode()
String	name()	The name of the usage plan.
QuotaSettings	quota()	The quota of the usage plan.
static Class<? extends CreateUsagePlanRequest.Builder>	serializableBuilderClass()
ThrottleSettings	throttle()	The throttling limits of the usage plan.
CreateUsagePlanRequest.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 software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

name

public String name()

The name of the usage plan.

Returns:

The name of the usage plan.

description

public String description()

The description of the usage plan.

Returns:

The description of the usage plan.

apiStages

public List<ApiStage> apiStages()

The associated API stages of the usage plan.

Returns:

The associated API stages of the usage plan.

throttle

public ThrottleSettings throttle()

The throttling limits of the usage plan.

Returns:

The throttling limits of the usage plan.

quota

public QuotaSettings quota()

The quota of the usage plan.

Returns:

The quota of the usage plan.

toBuilder

public CreateUsagePlanRequest.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<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>

Returns:

a builder for type T

builder

public static CreateUsagePlanRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUsagePlanRequest.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