@Generated(value="software.amazon.awssdk:codegen") public final 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.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateUsagePlanRequest.Builder |
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() |
overrideConfiguration
copy
public String name()
The name of the usage plan.
public String description()
The description of the usage plan.
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.
public ThrottleSettings throttle()
The throttling limits of the usage plan.
public QuotaSettings quota()
The quota of the usage plan.
public CreateUsagePlanRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>
toBuilder
in class ApiGatewayRequest
public static CreateUsagePlanRequest.Builder builder()
public static Class<? extends CreateUsagePlanRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.