UsagePlan (AWS Java SDK :: Services :: Amazon API Gateway 2.20.133 API)

java.lang.Object
- software.amazon.awssdk.services.apigateway.model.UsagePlan

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UsagePlan.Builder,UsagePlan>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class UsagePlan
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UsagePlan.Builder,UsagePlan>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UsagePlan.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UsagePlan.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ApiStage>`	`apiStages()` The associated API stages of a usage plan.
`static UsagePlan.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 UsagePlan.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.
`UsagePlan.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - id
```
public final String id()
```
    The identifier of a UsagePlan resource.
    
    Returns:
    
    The identifier of a UsagePlan resource.
  - name
```
public final String name()
```
    The name of a usage plan.
    
    Returns:
    
    The name of a usage plan.
  - description
```
public final String description()
```
    The description of a usage plan.
    
    Returns:
    
    The description of a usage plan.
  - hasApiStages
```
public final boolean hasApiStages()
```
    For responses, this returns true if the service returned a value for the ApiStages property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - apiStages
```
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.
    
    Returns:
    
    The associated API stages of a usage plan.
  - throttle
```
public final ThrottleSettings throttle()
```
    A map containing method level throttling information for API stage in a usage plan.
    
    Returns:
    
    A map containing method level throttling information for API stage in a usage plan.
  - quota
```
public final QuotaSettings quota()
```
    The target maximum number of permitted requests per a given unit time interval.
    
    Returns:
    
    The target maximum number of permitted requests per a given unit time interval.
  - productCode
```
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.
    
    Returns:
    
    The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - tags
```
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.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - toBuilder
```
public UsagePlan.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UsagePlan.Builder,UsagePlan>
  - builder
```
public static UsagePlan.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UsagePlan.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UsagePlan

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

name

description

hasApiStages

apiStages

throttle

quota

productCode

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields