Interface ListCollectionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListCollectionsRequest.Builder,ListCollectionsRequest>, OpenSearchServerlessRequest.Builder, SdkBuilder<ListCollectionsRequest.Builder,ListCollectionsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListCollectionsRequest

@Mutable
@NotThreadSafe
public static interface ListCollectionsRequest.Builder
extends OpenSearchServerlessRequest.Builder, SdkPojo, CopyableBuilder<ListCollectionsRequest.Builder,ListCollectionsRequest>

Method Summary

Modifier and Type	Method	Description
default ListCollectionsRequest.Builder	collectionFilters(Consumer<CollectionFilters.Builder> collectionFilters)	A list of filter names and values that you can use for requests.
ListCollectionsRequest.Builder	collectionFilters(CollectionFilters collectionFilters)	A list of filter names and values that you can use for requests.
ListCollectionsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return.
ListCollectionsRequest.Builder	nextToken(String nextToken)	If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.
ListCollectionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListCollectionsRequest.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.opensearchserverless.model.OpenSearchServerlessRequest.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

collectionFilters

ListCollectionsRequest.Builder collectionFilters(CollectionFilters collectionFilters)

A list of filter names and values that you can use for requests.

Parameters:

collectionFilters - A list of filter names and values that you can use for requests.

Returns:

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

collectionFilters

default ListCollectionsRequest.Builder collectionFilters(Consumer<CollectionFilters.Builder> collectionFilters)

A list of filter names and values that you can use for requests.

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

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

Parameters:

collectionFilters - a consumer that will call methods on CollectionFilters.Builder

Returns:

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

See Also:

• collectionFilters(CollectionFilters)

nextToken

ListCollectionsRequest.Builder nextToken(String nextToken)

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

Parameters:

nextToken - If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

Returns:

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

maxResults

ListCollectionsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

Parameters:

maxResults - The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

Returns:

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

overrideConfiguration

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

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