Package software.amazon.awssdk.services.apigateway.model

Interface GetUsagePlanResponse.Builder

All Superinterfaces:

ApiGatewayResponse.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<GetUsagePlanResponse.Builder,GetUsagePlanResponse>, SdkBuilder<GetUsagePlanResponse.Builder,GetUsagePlanResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetUsagePlanResponse

public static interface GetUsagePlanResponse.Builder
extends ApiGatewayResponse.Builder, SdkPojo, CopyableBuilder<GetUsagePlanResponse.Builder,GetUsagePlanResponse>

Method Summary

Modifier and Type	Method	Description
GetUsagePlanResponse.Builder	apiStages(Collection<ApiStage> apiStages)	The associated API stages of a usage plan.
GetUsagePlanResponse.Builder	apiStages(Consumer<ApiStage.Builder>... apiStages)	The associated API stages of a usage plan.
GetUsagePlanResponse.Builder	apiStages(ApiStage... apiStages)	The associated API stages of a usage plan.
GetUsagePlanResponse.Builder	description(String description)	The description of a usage plan.
GetUsagePlanResponse.Builder	id(String id)	The identifier of a UsagePlan resource.
GetUsagePlanResponse.Builder	name(String name)	The name of a usage plan.
GetUsagePlanResponse.Builder	productCode(String productCode)	The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
default GetUsagePlanResponse.Builder	quota(Consumer<QuotaSettings.Builder> quota)	The target maximum number of permitted requests per a given unit time interval.
GetUsagePlanResponse.Builder	quota(QuotaSettings quota)	The target maximum number of permitted requests per a given unit time interval.
GetUsagePlanResponse.Builder	tags(Map<String,String> tags)	The collection of tags.
default GetUsagePlanResponse.Builder	throttle(Consumer<ThrottleSettings.Builder> throttle)	A map containing method level throttling information for API stage in a usage plan.
GetUsagePlanResponse.Builder	throttle(ThrottleSettings throttle)	A map containing method level throttling information for API stage in a usage plan.

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

build, responseMetadata, responseMetadata

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, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

id

GetUsagePlanResponse.Builder id(String id)

The identifier of a UsagePlan resource.

Parameters:

id - The identifier of a UsagePlan resource.

Returns:

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

name

GetUsagePlanResponse.Builder name(String name)

The name of a usage plan.

Parameters:

name - The name of a usage plan.

Returns:

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

description

GetUsagePlanResponse.Builder description(String description)

The description of a usage plan.

Parameters:

description - The description of a usage plan.

Returns:

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

apiStages

GetUsagePlanResponse.Builder apiStages(Collection<ApiStage> apiStages)

The associated API stages of a usage plan.

Parameters:

apiStages - The associated API stages of a usage plan.

Returns:

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

apiStages

GetUsagePlanResponse.Builder apiStages(ApiStage... apiStages)

The associated API stages of a usage plan.

Parameters:

apiStages - The associated API stages of a usage plan.

Returns:

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

apiStages

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

The associated API stages of a 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).

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)

throttle

GetUsagePlanResponse.Builder throttle(ThrottleSettings throttle)

A map containing method level throttling information for API stage in a usage plan.

Parameters:

throttle - A map containing method level throttling information for API stage in a usage plan.

Returns:

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

throttle

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

A map containing method level throttling information for API stage in a 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

GetUsagePlanResponse.Builder quota(QuotaSettings quota)

The target maximum number of permitted requests per a given unit time interval.

Parameters:

quota - The target maximum number of permitted requests per a given unit time interval.

Returns:

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

quota

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

The target maximum number of permitted requests per a given unit time interval.

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)

productCode

GetUsagePlanResponse.Builder productCode(String productCode)

The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

Parameters:

productCode - The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

Returns:

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

tags

GetUsagePlanResponse.Builder tags(Map<String,String> tags)

The collection of tags. Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

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