Interface ListKeysRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListKeysRequest.Builder,,ListKeysRequest> LocationRequest.Builder,SdkBuilder<ListKeysRequest.Builder,,ListKeysRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ListKeysRequest
public static interface ListKeysRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<ListKeysRequest.Builder,ListKeysRequest>
-
Method Summary
Modifier and TypeMethodDescriptiondefault ListKeysRequest.Builderfilter(Consumer<ApiKeyFilter.Builder> filter) Optionally filter the list to onlyActiveorExpiredAPI keys.filter(ApiKeyFilter filter) Optionally filter the list to onlyActiveorExpiredAPI keys.maxResults(Integer maxResults) An optional limit for the number of resources returned in a single call.The pagination token specifying which page of results to return in the response.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
Optionally filter the list to only
ActiveorExpiredAPI keys.- Parameters:
filter- Optionally filter the list to onlyActiveorExpiredAPI keys.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filter
Optionally filter the list to only
This is a convenience method that creates an instance of theActiveorExpiredAPI keys.ApiKeyFilter.Builderavoiding the need to create one manually viaApiKeyFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilter(ApiKeyFilter).- Parameters:
filter- a consumer that will call methods onApiKeyFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListKeysRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-