Interface ListKeysRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListKeysRequest.Builder,ListKeysRequest>, LocationRequest.Builder, SdkBuilder<ListKeysRequest.Builder,ListKeysRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListKeysRequest

@Mutable
@NotThreadSafe
public static interface ListKeysRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<ListKeysRequest.Builder,ListKeysRequest>

Method Summary

Modifier and Type	Method	Description
default ListKeysRequest.Builder	filter(Consumer<ApiKeyFilter.Builder> filter)	Optionally filter the list to only Active or Expired API keys.
ListKeysRequest.Builder	filter(ApiKeyFilter filter)	Optionally filter the list to only Active or Expired API keys.
ListKeysRequest.Builder	maxResults(Integer maxResults)	An optional limit for the number of resources returned in a single call.
ListKeysRequest.Builder	nextToken(String nextToken)	The pagination token specifying which page of results to return in the response.
ListKeysRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListKeysRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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.services.location.model.LocationRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

maxResults

ListKeysRequest.Builder maxResults(Integer maxResults)

An optional limit for the number of resources returned in a single call.

Default value: 100

Parameters:

maxResults - An optional limit for the number of resources returned in a single call.

Default value: 100

Returns:

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

nextToken

ListKeysRequest.Builder nextToken(String nextToken)

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Parameters:

nextToken - The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Returns:

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

filter

ListKeysRequest.Builder filter(ApiKeyFilter filter)

Optionally filter the list to only Active or Expired API keys.

Parameters:

filter - Optionally filter the list to only Active or Expired API keys.

Returns:

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

filter

default ListKeysRequest.Builder filter(Consumer<ApiKeyFilter.Builder> filter)

Optionally filter the list to only Active or Expired API keys.

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

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

Parameters:

filter - a consumer that will call methods on ApiKeyFilter.Builder

Returns:

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

See Also:

• filter(ApiKeyFilter)

overrideConfiguration

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

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