software.amazon.awssdk.services.apigateway.model

Interface GetUsagePlanKeysRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetUsagePlanKeysRequest

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

Method Summary

Modifier and Type	Method and Description
GetUsagePlanKeysRequest.Builder	limit(Integer limit) The maximum number of returned results per page.
GetUsagePlanKeysRequest.Builder	nameQuery(String nameQuery) A query parameter specifying the name of the to-be-returned usage plan keys.
GetUsagePlanKeysRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetUsagePlanKeysRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetUsagePlanKeysRequest.Builder	position(String position) The current pagination position in the paged result set.
GetUsagePlanKeysRequest.Builder	usagePlanId(String usagePlanId) [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

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.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

usagePlanId

GetUsagePlanKeysRequest.Builder usagePlanId(String usagePlanId)

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Parameters:

usagePlanId - [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Returns:

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

position

GetUsagePlanKeysRequest.Builder position(String position)

The current pagination position in the paged result set.

Parameters:

position - The current pagination position in the paged result set.

Returns:

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

limit

GetUsagePlanKeysRequest.Builder limit(Integer limit)

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Parameters:

limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

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

nameQuery

GetUsagePlanKeysRequest.Builder nameQuery(String nameQuery)

A query parameter specifying the name of the to-be-returned usage plan keys.

Parameters:

nameQuery - A query parameter specifying the name of the to-be-returned usage plan keys.

Returns:

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

overrideConfiguration

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

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