Interface SearchRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SearchRequest.Builder,,SearchRequest> GlueRequest.Builder,SdkBuilder<SearchRequest.Builder,,SearchRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
SearchRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault SearchRequest.BuilderfilterClause(Consumer<SearchFilterClause.Builder> filterClause) The filter clause to apply to the search.filterClause(SearchFilterClause filterClause) The filter clause to apply to the search.maxResults(Integer maxResults) The maximum number of results to return in the response.A continuation token, if this is a continuation call.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.searchText(String searchText) The text to search for.default SearchRequest.Buildersort(Consumer<SearchSort.Builder> sort) The sort criteria for the search results.sort(SearchSort sort) The sort criteria for the search results.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.glue.model.GlueRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
searchText
The text to search for. At least one of
searchTextorfilterClausemust be provided.- Parameters:
searchText- The text to search for. At least one ofsearchTextorfilterClausemust be provided.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
The sort criteria for the search results.
This is a convenience method that creates an instance of theSearchSort.Builderavoiding the need to create one manually viaSearchSort.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosort(SearchSort).- Parameters:
sort- a consumer that will call methods onSearchSort.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theSearchFilterClause.Builderavoiding the need to create one manually viaSearchFilterClause.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilterClause(SearchFilterClause).- Parameters:
filterClause- a consumer that will call methods onSearchFilterClause.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
SearchRequest.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.
-