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(AbstractAggregationBuilder aggregation)
Adds an get to the search operation.
|
SearchRequestBuilder |
addField(String field)
Adds a field to load and return (note, it must be stored) as part of the search request.
|
SearchRequestBuilder |
addFieldDataField(String name)
Adds a field data based field to load and return.
|
SearchRequestBuilder |
addFields(String... fields)
Adds the fields to load and return as part of the search request.
|
SearchRequestBuilder |
addHighlightedField(HighlightBuilder.Field field)
Adds a highlighted field.
|
SearchRequestBuilder |
addHighlightedField(String name)
Adds a field to be highlighted with default fragment size of 100 characters, and
default number of fragments of 5.
|
SearchRequestBuilder |
addHighlightedField(String name,
int fragmentSize)
Adds a field to be highlighted with a provided fragment size (in characters), and
default number of fragments of 5.
|
SearchRequestBuilder |
addHighlightedField(String name,
int fragmentSize,
int numberOfFragments)
Adds a field to be highlighted with a provided fragment size (in characters), and
a provided (maximum) number of fragments.
|
SearchRequestBuilder |
addHighlightedField(String name,
int fragmentSize,
int numberOfFragments,
int fragmentOffset)
Adds a field to be highlighted with a provided fragment size (in characters),
a provided (maximum) number of fragments and an offset for the highlight.
|
SearchRequestBuilder |
addIndexBoost(String index,
float indexBoost)
Sets the boost a specific index will receive when the query is executeed against it.
|
SearchRequestBuilder |
addInnerHit(String name,
InnerHitsBuilder.InnerHit innerHit) |
SearchRequestBuilder |
addRescorer(RescoreBuilder.Rescorer rescorer)
Adds a new rescorer.
|
SearchRequestBuilder |
addRescorer(RescoreBuilder.Rescorer rescorer,
int window)
Adds a new rescorer.
|
SearchRequestBuilder |
addScriptField(String name,
Script script)
Adds a script based field to load and return.
|
SearchRequestBuilder |
addSort(SortBuilder sort)
Adds a generic sort builder.
|
SearchRequestBuilder |
addSort(String field,
SortOrder order)
Adds a sort against the given field name and the sort ordering.
|
SearchRequestBuilder |
addSuggestion(SuggestBuilder.SuggestionBuilder<?> suggestion)
|
protected SearchRequest |
beforeExecute(SearchRequest request)
A callback to additionally process the request before its executed
|
SearchRequestBuilder |
clearRescorers()
Clears all rescorers from the builder.
|
SearchSourceBuilder |
internalBuilder()
Returns the internal search source builder used to construct the request.
|
SearchRequestBuilder |
internalBuilder(SearchSourceBuilder sourceBuilder)
Sets the source builder to be used with this request.
|
SearchRequest |
request() |
SearchRequestBuilder |
setAggregations(byte[] aggregations)
Sets a raw (xcontent) binary representation of addAggregation to use.
|
SearchRequestBuilder |
setAggregations(byte[] aggregations,
int aggregationsOffset,
int aggregationsLength)
Sets a raw (xcontent) binary representation of addAggregation to use.
|
SearchRequestBuilder |
setAggregations(BytesReference aggregations)
Sets a raw (xcontent) binary representation of addAggregation to use.
|
SearchRequestBuilder |
setAggregations(Map aggregations)
Sets a raw (xcontent) binary representation of addAggregation to use.
|
SearchRequestBuilder |
setAggregations(XContentBuilder aggregations)
Sets a raw (xcontent) binary representation of addAggregation to use.
|
SearchRequestBuilder |
setExplain(boolean explain)
Should each
SearchHit be returned with an
explanation of the hit (ranking). |
SearchRequestBuilder |
setExtraSource(byte[] source)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setExtraSource(byte[] source,
int offset,
int length)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setExtraSource(BytesReference source)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setExtraSource(Map source) |
SearchRequestBuilder |
setExtraSource(String source)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setExtraSource(XContentBuilder builder)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setFetchSource(boolean fetch)
Indicates whether the response should contain the stored _source for every hit
|
SearchRequestBuilder |
setFetchSource(String[] includes,
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(String include,
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 |
setHighlighterBoundaryChars(char[] boundaryChars) |
SearchRequestBuilder |
setHighlighterBoundaryMaxScan(Integer boundaryMaxScan) |
SearchRequestBuilder |
setHighlighterEncoder(String encoder)
The encoder to set for highlighting
|
SearchRequestBuilder |
setHighlighterExplicitFieldOrder(boolean explicitFieldOrder)
Send the fields to be highlighted using a syntax that is specific about the order in which they should be highlighted.
|
SearchRequestBuilder |
setHighlighterFilter(Boolean highlightFilter) |
SearchRequestBuilder |
setHighlighterForceSource(Boolean forceSource)
Forces to highlight fields based on the source even if fields are stored separately.
|
SearchRequestBuilder |
setHighlighterFragmenter(String fragmenter) |
SearchRequestBuilder |
setHighlighterFragmentSize(Integer fragmentSize) |
SearchRequestBuilder |
setHighlighterNoMatchSize(Integer noMatchSize)
Sets the size of the fragment to return from the beginning of the field if there are no matches to
highlight and the field doesn't also define noMatchSize.
|
SearchRequestBuilder |
setHighlighterNumOfFragments(Integer numOfFragments) |
SearchRequestBuilder |
setHighlighterOptions(Map<String,Object> options) |
SearchRequestBuilder |
setHighlighterOrder(String order)
The order of fragments per field.
|
SearchRequestBuilder |
setHighlighterPhraseLimit(Integer phraseLimit)
Sets the maximum number of phrases the fvh will consider if the field doesn't also define phraseLimit.
|
SearchRequestBuilder |
setHighlighterPostTags(String... postTags)
Explicitly set the post tags that will be used for highlighting.
|
SearchRequestBuilder |
setHighlighterPreTags(String... preTags)
Explicitly set the pre tags that will be used for highlighting.
|
SearchRequestBuilder |
setHighlighterQuery(QueryBuilder highlightQuery)
Sets a query to be used for highlighting all fields instead of the search query.
|
SearchRequestBuilder |
setHighlighterRequireFieldMatch(boolean requireFieldMatch) |
SearchRequestBuilder |
setHighlighterTagsSchema(String schemaName)
Set a tag scheme that encapsulates a built in pre and post tags.
|
SearchRequestBuilder |
setHighlighterType(String type)
The highlighter type to use.
|
SearchRequestBuilder |
setIndices(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 |
setNoFields()
Sets no fields to be loaded, resulting in only id and type to be returned per field.
|
SearchRequestBuilder |
setPostFilter(byte[] postFilter)
Sets a filter on the query executed that only applies to the search query
(and not aggs for example).
|
SearchRequestBuilder |
setPostFilter(byte[] postFilter,
int postFilterOffset,
int postFilterLength)
Sets a filter on the query executed that only applies to the search query
(and not aggs for example).
|
SearchRequestBuilder |
setPostFilter(BytesReference postFilter)
Sets a filter on the query executed that only applies to the search query
(and not aggs for example).
|
SearchRequestBuilder |
setPostFilter(Map postFilter)
Sets a filter on the query executed that only applies to the search query
(and not aggs for example).
|
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 |
setPostFilter(String postFilter)
Sets a filter on the query executed that only applies to the search query
(and not aggs for example).
|
SearchRequestBuilder |
setPostFilter(XContentBuilder postFilter)
Sets a filter on the query executed that only applies to the search query
(and not aggs for example).
|
SearchRequestBuilder |
setPreference(String preference)
Sets the preference to execute the search.
|
SearchRequestBuilder |
setProfile(boolean profile)
Should the query be profiled.
|
SearchRequestBuilder |
setQuery(byte[] queryBinary)
Constructs a new search source builder with a raw search query.
|
SearchRequestBuilder |
setQuery(byte[] queryBinary,
int queryBinaryOffset,
int queryBinaryLength)
Constructs a new search source builder with a raw search query.
|
SearchRequestBuilder |
setQuery(BytesReference queryBinary)
Constructs a new search source builder with a raw search query.
|
SearchRequestBuilder |
setQuery(Map query)
Constructs a new search source builder with a raw search query.
|
SearchRequestBuilder |
setQuery(QueryBuilder queryBuilder)
Constructs a new search source builder with a search query.
|
SearchRequestBuilder |
setQuery(String query)
Constructs a new search source builder with a raw search query.
|
SearchRequestBuilder |
setQuery(XContentBuilder query)
Constructs a new search source builder with a raw search query.
|
SearchRequestBuilder |
setRequestCache(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 rescorer)
Clears all rescorers on the builder and sets the first one.
|
SearchRequestBuilder |
setRescorer(RescoreBuilder.Rescorer rescorer,
int window)
Clears all rescorers on the builder and sets the first one.
|
SearchRequestBuilder |
setRescoreWindow(int window)
Deprecated.
|
SearchRequestBuilder |
setRouting(String... routing)
The routing values to control the shards that the search will be executed on.
|
SearchRequestBuilder |
setRouting(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(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(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(byte[] source)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setSource(byte[] source,
int offset,
int length)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setSource(BytesReference source)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setSource(Map source)
Sets the source of the request as a map.
|
SearchRequestBuilder |
setSource(String source)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setSource(XContentBuilder builder)
Sets the source of the request as a json string.
|
SearchRequestBuilder |
setStats(String... statsGroups)
The stats groups this request will be aggregated under.
|
SearchRequestBuilder |
setSuggestText(String globalText)
Delegates to
SuggestBuilder.setText(String) . |
SearchRequestBuilder |
setTemplate(Template template)
template stuff
|
SearchRequestBuilder |
setTemplateName(String templateName)
Deprecated.
Use
setTemplate(Template) instead. |
SearchRequestBuilder |
setTemplateParams(Map<String,Object> templateParams)
Deprecated.
Use
setTemplate(Template) instead. |
SearchRequestBuilder |
setTemplateSource(BytesReference source) |
SearchRequestBuilder |
setTemplateSource(String source) |
SearchRequestBuilder |
setTemplateType(ScriptService.ScriptType templateType)
Deprecated.
Use
setTemplate(Template) instead. |
SearchRequestBuilder |
setTerminateAfter(int terminateAfter)
An optional document count, upon collecting which the search
query will early terminate
|
SearchRequestBuilder |
setTimeout(String timeout)
An optional timeout to control how long search is allowed to take.
|
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(String... types)
The document types to execute the search against.
|
SearchRequestBuilder |
setVersion(boolean version)
Should each
SearchHit be returned with its
version. |
String |
toString() |
public SearchRequestBuilder(ElasticsearchClient client, SearchAction action)
public SearchRequestBuilder setIndices(String... indices)
public SearchRequestBuilder setTypes(String... types)
public SearchRequestBuilder setSearchType(SearchType searchType)
SearchType.DEFAULT
.public SearchRequestBuilder setSearchType(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(String keepAlive)
public SearchRequestBuilder setTimeout(TimeValue timeout)
public SearchRequestBuilder setTimeout(String timeout)
public SearchRequestBuilder setTerminateAfter(int terminateAfter)
public SearchRequestBuilder setRouting(String routing)
public SearchRequestBuilder setRouting(String... routing)
public SearchRequestBuilder setPreference(String preference)
public SearchRequestBuilder setIndicesOptions(IndicesOptions indicesOptions)
For example indices that don't exist.
public SearchRequestBuilder setQuery(QueryBuilder queryBuilder)
QueryBuilders
public SearchRequestBuilder setQuery(String query)
public SearchRequestBuilder setQuery(BytesReference queryBinary)
public SearchRequestBuilder setQuery(byte[] queryBinary)
public SearchRequestBuilder setQuery(byte[] queryBinary, int queryBinaryOffset, int queryBinaryLength)
public SearchRequestBuilder setQuery(XContentBuilder query)
public SearchRequestBuilder setQuery(Map query)
public SearchRequestBuilder setPostFilter(QueryBuilder postFilter)
public SearchRequestBuilder setPostFilter(String postFilter)
public SearchRequestBuilder setPostFilter(BytesReference postFilter)
public SearchRequestBuilder setPostFilter(byte[] postFilter)
public SearchRequestBuilder setPostFilter(byte[] postFilter, int postFilterOffset, int postFilterLength)
public SearchRequestBuilder setPostFilter(XContentBuilder postFilter)
public SearchRequestBuilder setPostFilter(Map 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(String index, float indexBoost)
index
- The index to apply the boost againstindexBoost
- The boost to apply to the indexpublic SearchRequestBuilder setStats(String... statsGroups)
public SearchRequestBuilder setNoFields()
public SearchRequestBuilder setFetchSource(boolean fetch)
public SearchRequestBuilder setFetchSource(@Nullable String include, @Nullable 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 String[] includes, @Nullable 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 addField(String field)
public SearchRequestBuilder addFieldDataField(String name)
name
- The field to get from the field data cachepublic SearchRequestBuilder addScriptField(String name, Script script)
name
- The name that will represent this value in the return hitscript
- The script to usepublic SearchRequestBuilder addSort(String field, SortOrder order)
field
- The name of the fieldorder
- The sort orderingpublic SearchRequestBuilder addSort(SortBuilder sort)
SortBuilders
public SearchRequestBuilder setTrackScores(boolean trackScores)
public SearchRequestBuilder addFields(String... fields)
public SearchRequestBuilder addAggregation(AbstractAggregationBuilder aggregation)
public SearchRequestBuilder setAggregations(BytesReference aggregations)
public SearchRequestBuilder setAggregations(byte[] aggregations)
public SearchRequestBuilder setAggregations(byte[] aggregations, int aggregationsOffset, int aggregationsLength)
public SearchRequestBuilder setAggregations(XContentBuilder aggregations)
public SearchRequestBuilder setAggregations(Map aggregations)
public SearchRequestBuilder addHighlightedField(String name)
name
- The field to highlightpublic SearchRequestBuilder addHighlightedField(String name, int fragmentSize)
name
- The field to highlightfragmentSize
- The size of a fragment in characterspublic SearchRequestBuilder addHighlightedField(String name, int fragmentSize, int numberOfFragments)
name
- The field to highlightfragmentSize
- The size of a fragment in charactersnumberOfFragments
- The (maximum) number of fragmentspublic SearchRequestBuilder addHighlightedField(String name, int fragmentSize, int numberOfFragments, int fragmentOffset)
name
- The field to highlightfragmentSize
- The size of a fragment in charactersnumberOfFragments
- The (maximum) number of fragmentspublic SearchRequestBuilder addHighlightedField(HighlightBuilder.Field field)
public SearchRequestBuilder setHighlighterTagsSchema(String schemaName)
schemaName
- The tag scheme namepublic SearchRequestBuilder setHighlighterFragmentSize(Integer fragmentSize)
public SearchRequestBuilder setHighlighterNumOfFragments(Integer numOfFragments)
public SearchRequestBuilder setHighlighterFilter(Boolean highlightFilter)
public SearchRequestBuilder setHighlighterEncoder(String encoder)
public SearchRequestBuilder setHighlighterPreTags(String... preTags)
public SearchRequestBuilder setHighlighterPostTags(String... postTags)
public SearchRequestBuilder setHighlighterOrder(String order)
public SearchRequestBuilder setHighlighterRequireFieldMatch(boolean requireFieldMatch)
public SearchRequestBuilder setHighlighterBoundaryMaxScan(Integer boundaryMaxScan)
public SearchRequestBuilder setHighlighterBoundaryChars(char[] boundaryChars)
public SearchRequestBuilder setHighlighterType(String type)
public SearchRequestBuilder setHighlighterFragmenter(String fragmenter)
public SearchRequestBuilder setHighlighterQuery(QueryBuilder highlightQuery)
public SearchRequestBuilder setHighlighterNoMatchSize(Integer noMatchSize)
noMatchSize
- integer to set or null to leave out of request. default is null.public SearchRequestBuilder setHighlighterPhraseLimit(Integer phraseLimit)
public SearchRequestBuilder setHighlighterOptions(Map<String,Object> options)
public SearchRequestBuilder setHighlighterForceSource(Boolean forceSource)
public SearchRequestBuilder setHighlighterExplicitFieldOrder(boolean explicitFieldOrder)
public SearchRequestBuilder addInnerHit(String name, InnerHitsBuilder.InnerHit innerHit)
public SearchRequestBuilder setSuggestText(String globalText)
SuggestBuilder.setText(String)
.public SearchRequestBuilder addSuggestion(SuggestBuilder.SuggestionBuilder<?> suggestion)
public SearchRequestBuilder setRescorer(RescoreBuilder.Rescorer rescorer)
addRescorer(org.elasticsearch.search.rescore.RescoreBuilder.Rescorer, int)
.rescorer
- rescorer configurationpublic SearchRequestBuilder setRescorer(RescoreBuilder.Rescorer rescorer, int window)
addRescorer(org.elasticsearch.search.rescore.RescoreBuilder.Rescorer, int)
.rescorer
- rescorer configurationwindow
- rescore windowpublic SearchRequestBuilder addRescorer(RescoreBuilder.Rescorer rescorer)
rescorer
- rescorer configurationpublic SearchRequestBuilder addRescorer(RescoreBuilder.Rescorer rescorer, int window)
rescorer
- rescorer configurationwindow
- rescore windowpublic SearchRequestBuilder clearRescorers()
@Deprecated public SearchRequestBuilder setRescoreWindow(int window)
addRescorer(org.elasticsearch.search.rescore.RescoreBuilder.Rescorer, int)
instead.window
- rescore windowpublic SearchRequestBuilder setSource(String source)
setExtraSource(String)
.public SearchRequestBuilder setExtraSource(String source)
public SearchRequestBuilder setSource(BytesReference source)
setExtraSource(BytesReference)
.public SearchRequestBuilder setSource(byte[] source)
setExtraSource(byte[])
.public SearchRequestBuilder setExtraSource(BytesReference source)
public SearchRequestBuilder setExtraSource(byte[] source)
public SearchRequestBuilder setSource(byte[] source, int offset, int length)
setExtraSource(byte[])
.public SearchRequestBuilder setExtraSource(byte[] source, int offset, int length)
public SearchRequestBuilder setSource(XContentBuilder builder)
setExtraSource(byte[])
.public SearchRequestBuilder setExtraSource(XContentBuilder builder)
public SearchRequestBuilder setSource(Map source)
setExtraSource(java.util.Map)
.public SearchRequestBuilder setExtraSource(Map source)
public SearchRequestBuilder setTemplate(Template template)
@Deprecated public SearchRequestBuilder setTemplateName(String templateName)
setTemplate(Template)
instead.@Deprecated public SearchRequestBuilder setTemplateType(ScriptService.ScriptType templateType)
setTemplate(Template)
instead.@Deprecated public SearchRequestBuilder setTemplateParams(Map<String,Object> templateParams)
setTemplate(Template)
instead.public SearchRequestBuilder setTemplateSource(String source)
public SearchRequestBuilder setTemplateSource(BytesReference source)
public SearchRequestBuilder setRequestCache(Boolean requestCache)
public SearchRequestBuilder setProfile(boolean profile)
false
public SearchRequestBuilder internalBuilder(SearchSourceBuilder sourceBuilder)
public SearchSourceBuilder internalBuilder()
public SearchRequest request()
request
in class ActionRequestBuilder<SearchRequest,SearchResponse,SearchRequestBuilder>
protected SearchRequest beforeExecute(SearchRequest request)
ActionRequestBuilder
beforeExecute
in class ActionRequestBuilder<SearchRequest,SearchResponse,SearchRequestBuilder>
request
- RequestCopyright © 2009–2016. All rights reserved.