@Generated(value="software.amazon.awssdk:codegen") public class CreateUsagePlanResponse extends APIGatewayResponse implements ToCopyableBuilder<CreateUsagePlanResponse.Builder,CreateUsagePlanResponse>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateUsagePlanResponse.Builder |
Modifier and Type | Method and Description |
---|---|
List<ApiStage> |
apiStages()
The associated API stages of a usage plan.
|
static CreateUsagePlanResponse.Builder |
builder() |
String |
description()
The description of a 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
SdkResponse . |
int |
hashCode() |
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.
|
static Class<? extends CreateUsagePlanResponse.Builder> |
serializableBuilderClass() |
ThrottleSettings |
throttle()
The request throttle limits of a usage plan.
|
CreateUsagePlanResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String id()
The identifier of a UsagePlan resource.
public String name()
The name of a usage plan.
public String description()
The description of a usage plan.
public 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.
public ThrottleSettings throttle()
The request throttle limits of a usage plan.
public QuotaSettings quota()
The maximum number of permitted requests per a given unit time interval.
public String productCode()
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
public CreateUsagePlanResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateUsagePlanResponse.Builder,CreateUsagePlanResponse>
toBuilder
in class AwsResponse
public static CreateUsagePlanResponse.Builder builder()
public static Class<? extends CreateUsagePlanResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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 SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
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.