Interface CreateUsagePlanRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>, SdkBuilder<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateUsagePlanRequest

public static interface CreateUsagePlanRequest.Builder
extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateUsagePlanRequest.Builder,CreateUsagePlanRequest>

Method Summary

Modifier and Type	Method	Description
CreateUsagePlanRequest.Builder	apiStages(Collection<ApiStage> apiStages)	The associated API stages of the usage plan.
CreateUsagePlanRequest.Builder	apiStages(Consumer<ApiStage.Builder>... apiStages)	The associated API stages of the usage plan.
CreateUsagePlanRequest.Builder	apiStages(ApiStage... apiStages)	The associated API stages of the usage plan.
CreateUsagePlanRequest.Builder	description(String description)	The description of the usage plan.
CreateUsagePlanRequest.Builder	name(String name)	The name of the usage plan.
CreateUsagePlanRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateUsagePlanRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateUsagePlanRequest.Builder	quota(Consumer<QuotaSettings.Builder> quota)	The quota of the usage plan.
CreateUsagePlanRequest.Builder	quota(QuotaSettings quota)	The quota of the usage plan.
CreateUsagePlanRequest.Builder	tags(Map<String,String> tags)	The key-value map of strings.
default CreateUsagePlanRequest.Builder	throttle(Consumer<ThrottleSettings.Builder> throttle)	The throttling limits of the usage plan.
CreateUsagePlanRequest.Builder	throttle(ThrottleSettings throttle)	The throttling limits of the usage plan.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

name

CreateUsagePlanRequest.Builder name(String name)

The name of the usage plan.

Parameters:

name - The name of the usage plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateUsagePlanRequest.Builder description(String description)

The description of the usage plan.

Parameters:

description - The description of the usage plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiStages

CreateUsagePlanRequest.Builder apiStages(Collection<ApiStage> apiStages)

The associated API stages of the usage plan.

Parameters:

apiStages - The associated API stages of the usage plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiStages

CreateUsagePlanRequest.Builder apiStages(ApiStage... apiStages)

The associated API stages of the usage plan.

Parameters:

apiStages - The associated API stages of the usage plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiStages

CreateUsagePlanRequest.Builder apiStages(Consumer<ApiStage.Builder>... apiStages)

The associated API stages of the usage plan.

This is a convenience method that creates an instance of the ApiStage.Builder avoiding the need to create one manually via ApiStage.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to apiStages(List<ApiStage>).

Parameters:

apiStages - a consumer that will call methods on ApiStage.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• apiStages(java.util.Collection<ApiStage>)

throttle

CreateUsagePlanRequest.Builder throttle(ThrottleSettings throttle)

The throttling limits of the usage plan.

Parameters:

throttle - The throttling limits of the usage plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

throttle

default CreateUsagePlanRequest.Builder throttle(Consumer<ThrottleSettings.Builder> throttle)

The throttling limits of the usage plan.

This is a convenience method that creates an instance of the ThrottleSettings.Builder avoiding the need to create one manually via ThrottleSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to throttle(ThrottleSettings).

Parameters:

throttle - a consumer that will call methods on ThrottleSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• throttle(ThrottleSettings)

quota

CreateUsagePlanRequest.Builder quota(QuotaSettings quota)

The quota of the usage plan.

Parameters:

quota - The quota of the usage plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

quota

default CreateUsagePlanRequest.Builder quota(Consumer<QuotaSettings.Builder> quota)

The quota of the usage plan.

This is a convenience method that creates an instance of the QuotaSettings.Builder avoiding the need to create one manually via QuotaSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to quota(QuotaSettings).

Parameters:

quota - a consumer that will call methods on QuotaSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• quota(QuotaSettings)

tags

CreateUsagePlanRequest.Builder tags(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateUsagePlanRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateUsagePlanRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.