public static interface UsagePlan.Builder extends CopyableBuilder<UsagePlan.Builder,UsagePlan>
Modifier and Type | Method and Description |
---|---|
UsagePlan.Builder |
apiStages(ApiStage... apiStages)
The associated API stages of a usage plan.
|
UsagePlan.Builder |
apiStages(Collection<ApiStage> apiStages)
The associated API stages of a usage plan.
|
UsagePlan.Builder |
apiStages(Consumer<ApiStage.Builder>... apiStages)
The associated API stages of a usage plan.
|
UsagePlan.Builder |
description(String description)
The description of a usage plan.
|
UsagePlan.Builder |
id(String id)
The identifier of a UsagePlan resource.
|
UsagePlan.Builder |
name(String name)
The name of a usage plan.
|
UsagePlan.Builder |
productCode(String productCode)
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
|
default UsagePlan.Builder |
quota(Consumer<QuotaSettings.Builder> quota)
The maximum number of permitted requests per a given unit time interval.
|
UsagePlan.Builder |
quota(QuotaSettings quota)
The maximum number of permitted requests per a given unit time interval.
|
default UsagePlan.Builder |
throttle(Consumer<ThrottleSettings.Builder> throttle)
The request throttle limits of a usage plan.
|
UsagePlan.Builder |
throttle(ThrottleSettings throttle)
The request throttle limits of a usage plan.
|
copy
applyMutation, build
UsagePlan.Builder id(String id)
The identifier of a UsagePlan resource.
id
- The identifier of a UsagePlan resource.UsagePlan.Builder name(String name)
The name of a usage plan.
name
- The name of a usage plan.UsagePlan.Builder description(String description)
The description of a usage plan.
description
- The description of a usage plan.UsagePlan.Builder apiStages(Collection<ApiStage> apiStages)
The associated API stages of a usage plan.
apiStages
- The associated API stages of a usage plan.UsagePlan.Builder apiStages(ApiStage... apiStages)
The associated API stages of a usage plan.
apiStages
- The associated API stages of a usage plan.UsagePlan.Builder apiStages(Consumer<ApiStage.Builder>... apiStages)
The associated API stages of a usage plan.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #apiStages(List)
.apiStages
- a consumer that will call methods on List.Builder
#apiStages(List)
UsagePlan.Builder throttle(ThrottleSettings throttle)
The request throttle limits of a usage plan.
throttle
- The request throttle limits of a usage plan.default UsagePlan.Builder throttle(Consumer<ThrottleSettings.Builder> throttle)
The request throttle limits of a usage plan.
This is a convenience that creates an instance of theThrottleSettings.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)
.throttle
- a consumer that will call methods on ThrottleSettings.Builder
throttle(ThrottleSettings)
UsagePlan.Builder quota(QuotaSettings quota)
The maximum number of permitted requests per a given unit time interval.
quota
- The maximum number of permitted requests per a given unit time interval.default UsagePlan.Builder quota(Consumer<QuotaSettings.Builder> quota)
The maximum number of permitted requests per a given unit time interval.
This is a convenience that creates an instance of theQuotaSettings.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)
.quota
- a consumer that will call methods on QuotaSettings.Builder
quota(QuotaSettings)
UsagePlan.Builder productCode(String productCode)
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
productCode
- The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS
Marketplace.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.