software.amazon.awssdk.services.apigateway.model

Class CreateUsagePlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.APIGatewayRequest

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

All Implemented Interfaces:

ToCopyableBuilder<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class CreateUsagePlanRequest
extends APIGatewayRequest
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 and Description
static interface	CreateUsagePlanRequest.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

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.

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

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>

Specified by:

toBuilder in class APIGatewayRequest

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

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value