CreateUsagePlanResponse (AWS Java SDK :: Services :: Amazon API Gateway 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
    - - software.amazon.awssdk.services.apigateway.model.CreateUsagePlanResponse

All Implemented Interfaces:

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

Create and Use Usage Plans

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateUsagePlanResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateUsagePlanResponse.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 CreateUsagePlanResponse.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()` Returns true if the ApiStages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateUsagePlanResponse.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The collection of tags.
`ThrottleSettings`	`throttle()` The request throttle limits of a usage plan.
`CreateUsagePlanResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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()
```
    Returns true if the ApiStages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasApiStages() to see if a value was sent in this field.
    
    Returns:
    
    The associated API stages of a usage plan.
  - throttle
```
public final ThrottleSettings throttle()
```
    The request throttle limits of a usage plan.
    
    Returns:
    
    The request throttle limits of a usage plan.
  - quota
```
public final QuotaSettings quota()
```
    The maximum number of permitted requests per a given unit time interval.
    
    Returns:
    
    The maximum number of permitted requests per a given unit time interval.
  - productCode
```
public final String productCode()
```
    The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    
    Returns:
    
    The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - toBuilder
```
public CreateUsagePlanResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateUsagePlanResponse.Builder,CreateUsagePlanResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static CreateUsagePlanResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateUsagePlanResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateUsagePlanResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

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