Interface SearchRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchRequest.Builder,SearchRequest>, GlueRequest.Builder, SdkBuilder<SearchRequest.Builder,SearchRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchRequest

@Mutable
@NotThreadSafe
public static interface SearchRequest.Builder
extends GlueRequest.Builder, SdkPojo, CopyableBuilder<SearchRequest.Builder,SearchRequest>

Method Summary

Modifier and Type	Method	Description
default SearchRequest.Builder	filterClause(Consumer<SearchFilterClause.Builder> filterClause)	The filter clause to apply to the search.
SearchRequest.Builder	filterClause(SearchFilterClause filterClause)	The filter clause to apply to the search.
SearchRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in the response.
SearchRequest.Builder	nextToken(String nextToken)	A continuation token, if this is a continuation call.
SearchRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SearchRequest.Builder	searchText(String searchText)	The text to search for.
default SearchRequest.Builder	sort(Consumer<SearchSort.Builder> sort)	The sort criteria for the search results.
SearchRequest.Builder	sort(SearchSort sort)	The sort criteria for the search results.

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.glue.model.GlueRequest.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

searchText

SearchRequest.Builder searchText(String searchText)

The text to search for. At least one of searchText or filterClause must be provided.

Parameters:

searchText - The text to search for. At least one of searchText or filterClause must be provided.

Returns:

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

maxResults

SearchRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in the response.

Parameters:

maxResults - The maximum number of results to return in the response.

Returns:

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

nextToken

SearchRequest.Builder nextToken(String nextToken)

A continuation token, if this is a continuation call.

Parameters:

nextToken - A continuation token, if this is a continuation call.

Returns:

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

sort

SearchRequest.Builder sort(SearchSort sort)

The sort criteria for the search results.

Parameters:

sort - The sort criteria for the search results.

Returns:

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

sort

default SearchRequest.Builder sort(Consumer<SearchSort.Builder> sort)

The sort criteria for the search results.

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

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

Parameters:

sort - a consumer that will call methods on SearchSort.Builder

Returns:

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

See Also:

• sort(SearchSort)

filterClause

SearchRequest.Builder filterClause(SearchFilterClause filterClause)

The filter clause to apply to the search. Supports nested AND/OR logic with attribute-level and map-level filters.

Parameters:

filterClause - The filter clause to apply to the search. Supports nested AND/OR logic with attribute-level and map-level filters.

Returns:

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

filterClause

default SearchRequest.Builder filterClause(Consumer<SearchFilterClause.Builder> filterClause)

The filter clause to apply to the search. Supports nested AND/OR logic with attribute-level and map-level filters.

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

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

Parameters:

filterClause - a consumer that will call methods on SearchFilterClause.Builder

Returns:

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

See Also:

• filterClause(SearchFilterClause)

overrideConfiguration

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

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