Interface CreateUsagePlanRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateUsagePlanRequest.Builder,
,CreateUsagePlanRequest> SdkBuilder<CreateUsagePlanRequest.Builder,
,CreateUsagePlanRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateUsagePlanRequest
-
Method Summary
Modifier and TypeMethodDescriptionapiStages
(Collection<ApiStage> apiStages) The associated API stages of the usage plan.apiStages
(Consumer<ApiStage.Builder>... apiStages) The associated API stages of the usage plan.The associated API stages of the usage plan.description
(String description) The description of the usage plan.The name of the usage plan.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreateUsagePlanRequest.Builder
quota
(Consumer<QuotaSettings.Builder> quota) The quota of the usage plan.quota
(QuotaSettings quota) The quota of the usage plan.The key-value map of strings.default CreateUsagePlanRequest.Builder
throttle
(Consumer<ThrottleSettings.Builder> throttle) The throttling limits of the usage plan.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
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
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
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
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
The associated API stages of the usage plan.
This is a convenience method that creates an instance of theApiStage.Builder
avoiding the need to create one manually viaApiStage.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toapiStages(List<ApiStage>)
.- Parameters:
apiStages
- a consumer that will call methods onApiStage.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The throttling limits of the usage plan.
This is a convenience method that creates an instance of theThrottleSettings.Builder
avoiding the need to create one manually viaThrottleSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tothrottle(ThrottleSettings)
.- Parameters:
throttle
- a consumer that will call methods onThrottleSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The quota of the usage plan.
This is a convenience method that creates an instance of theQuotaSettings.Builder
avoiding the need to create one manually viaQuotaSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toquota(QuotaSettings)
.- Parameters:
quota
- a consumer that will call methods onQuotaSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 withaws:
. 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-