@Generated(value="software.amazon.awssdk:codegen") public final class GetUsagePlanResponse extends ApiGatewayResponse implements ToCopyableBuilder<GetUsagePlanResponse.Builder,GetUsagePlanResponse>
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetUsagePlanResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<ApiStage> |
apiStages()
The associated API stages of a usage plan.
|
static GetUsagePlanResponse.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()
For responses, this returns true if the service returned a value for the ApiStages property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
id()
The identifier of a UsagePlan resource.
|
String |
name()
The name of a usage plan.
|
String |
productCode()
The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the
Amazon Web Services Marketplace.
|
QuotaSettings |
quota()
The target maximum number of permitted requests per a given unit time interval.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetUsagePlanResponse.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
The collection of tags.
|
ThrottleSettings |
throttle()
A map containing method level throttling information for API stage in a usage plan.
|
GetUsagePlanResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String id()
The identifier of a UsagePlan resource.
public final String name()
The name of a usage plan.
public final String description()
The description of a usage plan.
public final boolean hasApiStages()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasApiStages() method.
public final ThrottleSettings throttle()
A map containing method level throttling information for API stage in a usage plan.
public final QuotaSettings quota()
The target maximum number of permitted requests per a given unit time interval.
public final String productCode()
The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public GetUsagePlanResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetUsagePlanResponse.Builder,GetUsagePlanResponse>toBuilder in class AwsResponsepublic static GetUsagePlanResponse.Builder builder()
public static Class<? extends GetUsagePlanResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.