software.amazon.awssdk.services.apigateway.model

Class CreateUsagePlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.CreateUsagePlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>

@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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateUsagePlanRequest.Builder

Method Summary

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)
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	name() The name of the usage plan.
QuotaSettings	quota() The quota of the usage plan.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUsagePlanRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The key-value map of strings.
ThrottleSettings	throttle() The throttling limits of the usage plan.
CreateUsagePlanRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

The name of the usage plan.

Returns:

The name of the usage plan.

description

public final String description()

The description of the usage plan.

Returns:

The description of the 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 the 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 the usage plan.

throttle

public final ThrottleSettings throttle()

The throttling limits of the usage plan.

Returns:

The throttling limits of the usage plan.

quota

public final QuotaSettings quota()

The quota of the usage plan.

Returns:

The quota of the usage plan.

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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

toBuilder

public CreateUsagePlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static CreateUsagePlanRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUsagePlanRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo