public class SearchRequestBuilder extends ActionRequestBuilder<SearchRequest,SearchResponse,SearchRequestBuilder>
action, client, request
Constructor and Description |
---|
SearchRequestBuilder(ElasticsearchClient client,
SearchAction action) |
Modifier and Type | Method and Description |
---|---|
SearchRequestBuilder |
addAggregation(AggregationBuilder aggregation)
Adds an aggregation to the search operation.
|
SearchRequestBuilder |
addAggregation(PipelineAggregationBuilder aggregation)
Adds an aggregation to the search operation.
|
SearchRequestBuilder |
addDocValueField(java.lang.String name)
Adds a docvalue based field to load and return.
|
SearchRequestBuilder |
addFieldDataField(java.lang.String name)
Deprecated.
Use
addDocValueField(String) instead. |
SearchRequestBuilder |
addIndexBoost(java.lang.String index,
float indexBoost)
Sets the boost a specific index will receive when the query is executed against it.
|
SearchRequestBuilder |
addRescorer(RescoreBuilder<?> rescorer)
Adds a new rescorer.
|
SearchRequestBuilder |
addRescorer(RescoreBuilder<?> rescorer,
int window)
Adds a new rescorer.
|
SearchRequestBuilder |
addScriptField(java.lang.String name,
Script script)
Adds a script based field to load and return.
|
SearchRequestBuilder |
addSort(SortBuilder sort)
Adds a generic sort builder.
|
SearchRequestBuilder |
addSort(java.lang.String field,
SortOrder order)
Adds a sort against the given field name and the sort ordering.
|
SearchRequestBuilder |
addStoredField(java.lang.String field)
Adds a stored field to load and return (note, it must be stored) as part of the search request.
|
SearchRequestBuilder |
clearRescorers()
Clears all rescorers from the builder.
|
SearchRequestBuilder |
fields(java.lang.String... fields)
Deprecated.
Use
storedFields(String...) instead. |
SearchRequestBuilder |
highlighter(HighlightBuilder highlightBuilder) |
SearchRequestBuilder |
searchAfter(java.lang.Object[] values)
Set the sort values that indicates which docs this request should "search after".
|
SearchRequestBuilder |
setExplain(boolean explain)
Should each
SearchHit be returned with an
explanation of the hit (ranking). |
SearchRequestBuilder |
setFetchSource(boolean fetch)
Indicates whether the response should contain the stored _source for every hit
|
SearchRequestBuilder |
setFetchSource(java.lang.String[] includes,
java.lang.String[] excludes)
Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard
elements.
|
SearchRequestBuilder |
setFetchSource(java.lang.String include,
java.lang.String exclude)
Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard
elements.
|
SearchRequestBuilder |
setFrom(int from)
From index to start the search from.
|
SearchRequestBuilder |
setIndices(java.lang.String... indices)
Sets the indices the search will be executed on.
|
SearchRequestBuilder |
setIndicesOptions(IndicesOptions indicesOptions)
Specifies what type of requested indices to ignore and wildcard indices expressions.
|
SearchRequestBuilder |
setMinScore(float minScore)
Sets the minimum score below which docs will be filtered out.
|
SearchRequestBuilder |
setPostFilter(QueryBuilder postFilter)
Sets a filter that will be executed after the query has been executed and only has affect on the search hits
(not aggregations).
|
SearchRequestBuilder |
setPreference(java.lang.String preference)
Sets the preference to execute the search.
|
SearchRequestBuilder |
setProfile(boolean profile)
Should the query be profiled.
|
SearchRequestBuilder |
setQuery(QueryBuilder queryBuilder)
Constructs a new search source builder with a search query.
|
SearchRequestBuilder |
setRequestCache(java.lang.Boolean requestCache)
Sets if this request should use the request cache or not, assuming that it can (for
example, if "now" is used, it will never be cached).
|
SearchRequestBuilder |
setRescorer(RescoreBuilder<?> rescorer)
Clears all rescorers on the builder and sets the first one.
|
SearchRequestBuilder |
setRescorer(RescoreBuilder rescorer,
int window)
Clears all rescorers on the builder and sets the first one.
|
SearchRequestBuilder |
setRouting(java.lang.String... routing)
The routing values to control the shards that the search will be executed on.
|
SearchRequestBuilder |
setRouting(java.lang.String routing)
A comma separated list of routing values to control the shards the search will be executed on.
|
SearchRequestBuilder |
setScroll(Scroll scroll)
If set, will enable scrolling of the search request.
|
SearchRequestBuilder |
setScroll(java.lang.String keepAlive)
If set, will enable scrolling of the search request for the specified timeout.
|
SearchRequestBuilder |
setScroll(TimeValue keepAlive)
If set, will enable scrolling of the search request for the specified timeout.
|
SearchRequestBuilder |
setSearchType(SearchType searchType)
The search type to execute, defaults to
SearchType.DEFAULT . |
SearchRequestBuilder |
setSearchType(java.lang.String searchType)
The a string representation search type to execute, defaults to
SearchType.DEFAULT . |
SearchRequestBuilder |
setSize(int size)
The number of search hits to return.
|
SearchRequestBuilder |
setSource(SearchSourceBuilder source)
Sets the source of the request as a SearchSourceBuilder.
|
SearchRequestBuilder |
setStats(java.util.List<java.lang.String> statsGroups)
The stats groups this request will be aggregated under.
|
SearchRequestBuilder |
setStats(java.lang.String... statsGroups)
The stats groups this request will be aggregated under.
|
SearchRequestBuilder |
setTerminateAfter(int terminateAfter)
An optional document count, upon collecting which the search
query will early terminate
|
SearchRequestBuilder |
setTimeout(TimeValue timeout)
An optional timeout to control how long search is allowed to take.
|
SearchRequestBuilder |
setTrackScores(boolean trackScores)
Applies when sorting, and controls if scores will be tracked as well.
|
SearchRequestBuilder |
setTypes(java.lang.String... types)
The document types to execute the search against.
|
SearchRequestBuilder |
setVersion(boolean version)
Should each
SearchHit be returned with its
version. |
SearchRequestBuilder |
slice(SliceBuilder builder) |
SearchRequestBuilder |
storedFields(java.lang.String... fields)
Adds stored fields to load and return (note, it must be stored) as part of the search request.
|
SearchRequestBuilder |
suggest(SuggestBuilder suggestBuilder)
Delegates to
SearchSourceBuilder.suggest(SuggestBuilder) |
java.lang.String |
toString() |
beforeExecute, execute, execute, get, get, get, request
public SearchRequestBuilder(ElasticsearchClient client, SearchAction action)
public SearchRequestBuilder setIndices(java.lang.String... indices)
public SearchRequestBuilder setTypes(java.lang.String... types)
public SearchRequestBuilder setSearchType(SearchType searchType)
SearchType.DEFAULT
.public SearchRequestBuilder setSearchType(java.lang.String searchType)
SearchType.DEFAULT
. Can be
one of "dfs_query_then_fetch"/"dfsQueryThenFetch", "dfs_query_and_fetch"/"dfsQueryAndFetch",
"query_then_fetch"/"queryThenFetch", and "query_and_fetch"/"queryAndFetch".public SearchRequestBuilder setScroll(Scroll scroll)
public SearchRequestBuilder setScroll(TimeValue keepAlive)
public SearchRequestBuilder setScroll(java.lang.String keepAlive)
public SearchRequestBuilder setTimeout(TimeValue timeout)
public SearchRequestBuilder setTerminateAfter(int terminateAfter)
public SearchRequestBuilder setRouting(java.lang.String routing)
public SearchRequestBuilder setRouting(java.lang.String... routing)
public SearchRequestBuilder setPreference(java.lang.String preference)
public SearchRequestBuilder setIndicesOptions(IndicesOptions indicesOptions)
For example indices that don't exist.
public SearchRequestBuilder setQuery(QueryBuilder queryBuilder)
QueryBuilders
public SearchRequestBuilder setPostFilter(QueryBuilder postFilter)
public SearchRequestBuilder setMinScore(float minScore)
public SearchRequestBuilder setFrom(int from)
public SearchRequestBuilder setSize(int size)
public SearchRequestBuilder setExplain(boolean explain)
SearchHit
be returned with an
explanation of the hit (ranking).public SearchRequestBuilder setVersion(boolean version)
SearchHit
be returned with its
version.public SearchRequestBuilder addIndexBoost(java.lang.String index, float indexBoost)
index
- The index to apply the boost againstindexBoost
- The boost to apply to the indexpublic SearchRequestBuilder setStats(java.lang.String... statsGroups)
public SearchRequestBuilder setStats(java.util.List<java.lang.String> statsGroups)
public SearchRequestBuilder setFetchSource(boolean fetch)
public SearchRequestBuilder setFetchSource(@Nullable java.lang.String include, @Nullable java.lang.String exclude)
include
- An optional include (optionally wildcarded) pattern to filter the returned _sourceexclude
- An optional exclude (optionally wildcarded) pattern to filter the returned _sourcepublic SearchRequestBuilder setFetchSource(@Nullable java.lang.String[] includes, @Nullable java.lang.String[] excludes)
includes
- An optional list of include (optionally wildcarded) pattern to filter the returned _sourceexcludes
- An optional list of exclude (optionally wildcarded) pattern to filter the returned _sourcepublic SearchRequestBuilder addDocValueField(java.lang.String name)
name
- The field to get from the docvaluepublic SearchRequestBuilder addStoredField(java.lang.String field)
@Deprecated public SearchRequestBuilder addFieldDataField(java.lang.String name)
addDocValueField(String)
instead.name
- The field to get from the field data cachepublic SearchRequestBuilder addScriptField(java.lang.String name, Script script)
name
- The name that will represent this value in the return hitscript
- The script to usepublic SearchRequestBuilder addSort(java.lang.String field, SortOrder order)
field
- The name of the fieldorder
- The sort orderingpublic SearchRequestBuilder addSort(SortBuilder sort)
SortBuilders
public SearchRequestBuilder searchAfter(java.lang.Object[] values)
public SearchRequestBuilder slice(SliceBuilder builder)
public SearchRequestBuilder setTrackScores(boolean trackScores)
@Deprecated public SearchRequestBuilder fields(java.lang.String... fields)
storedFields(String...)
instead.storedField("_none_")
.public SearchRequestBuilder storedFields(java.lang.String... fields)
storedField("_none_")
.public SearchRequestBuilder addAggregation(AggregationBuilder aggregation)
public SearchRequestBuilder addAggregation(PipelineAggregationBuilder aggregation)
public SearchRequestBuilder highlighter(HighlightBuilder highlightBuilder)
public SearchRequestBuilder suggest(SuggestBuilder suggestBuilder)
SearchSourceBuilder.suggest(SuggestBuilder)
public SearchRequestBuilder setRescorer(RescoreBuilder<?> rescorer)
addRescorer(org.elasticsearch.search.rescore.RescoreBuilder, int)
.rescorer
- rescorer configurationpublic SearchRequestBuilder setRescorer(RescoreBuilder rescorer, int window)
addRescorer(org.elasticsearch.search.rescore.RescoreBuilder, int)
.rescorer
- rescorer configurationwindow
- rescore windowpublic SearchRequestBuilder addRescorer(RescoreBuilder<?> rescorer)
rescorer
- rescorer configurationpublic SearchRequestBuilder addRescorer(RescoreBuilder<?> rescorer, int window)
rescorer
- rescorer configurationwindow
- rescore windowpublic SearchRequestBuilder clearRescorers()
public SearchRequestBuilder setSource(SearchSourceBuilder source)
public SearchRequestBuilder setRequestCache(java.lang.Boolean requestCache)
public SearchRequestBuilder setProfile(boolean profile)
false
public java.lang.String toString()
toString
in class java.lang.Object