public class NativeSearchQuery extends Object
https://www.elastic.co/guide/en/elasticsearch/reference/7.9/filter-search-results.html#post-filter
, if a
filter is needed that filters before aggregations are build, it must be included in the query constructor parameter.Modifier and Type | Field and Description |
---|---|
protected List<String> |
fields |
protected HighlightQuery |
highlightQuery |
protected Collection<String> |
ids |
protected org.elasticsearch.action.support.IndicesOptions |
indicesOptions |
protected Integer |
maxResults |
protected float |
minScore |
protected Pageable |
pageable |
protected String |
preference |
protected List<RescorerQuery> |
rescorerQueries |
protected String |
route |
protected org.elasticsearch.action.search.SearchType |
searchType |
protected Sort |
sort |
protected SourceFilter |
sourceFilter |
protected boolean |
trackScores |
DEFAULT_PAGE, DEFAULT_PAGE_SIZE
Constructor and Description |
---|
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query) |
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query,
org.elasticsearch.index.query.QueryBuilder filter) |
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query,
org.elasticsearch.index.query.QueryBuilder filter,
List<org.elasticsearch.search.sort.SortBuilder<?>> sorts) |
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query,
org.elasticsearch.index.query.QueryBuilder filter,
List<org.elasticsearch.search.sort.SortBuilder<?>> sorts,
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields) |
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query,
org.elasticsearch.index.query.QueryBuilder filter,
List<org.elasticsearch.search.sort.SortBuilder<?>> sorts,
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder highlightBuilder,
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields) |
Modifier and Type | Method and Description |
---|---|
void |
addAggregation(org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?> aggregationBuilder) |
void |
addFields(String... fields)
Add fields to be added as part of search request
|
void |
addRescorerQuery(RescorerQuery rescorerQuery)
Adds a
RescorerQuery . |
void |
addScriptField(ScriptField... scriptField) |
<T extends Query> |
addSort(Sort sort)
Add
Sort to query |
void |
addSourceFilter(SourceFilter sourceFilter)
Add source filter to be added as part of search request
|
List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> |
getAggregations() |
org.elasticsearch.search.collapse.CollapseBuilder |
getCollapseBuilder() |
List<org.elasticsearch.search.sort.SortBuilder<?>> |
getElasticsearchSorts() |
boolean |
getExplain() |
List<String> |
getFields()
Get fields to be returned as part of search request
|
org.elasticsearch.index.query.QueryBuilder |
getFilter() |
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder |
getHighlightBuilder() |
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] |
getHighlightFields() |
Optional<HighlightQuery> |
getHighlightQuery() |
Collection<String> |
getIds()
Get Ids
|
List<IndexBoost> |
getIndicesBoost() |
org.elasticsearch.action.support.IndicesOptions |
getIndicesOptions()
Get indices options
|
Integer |
getMaxResults()
return the max of results.
|
float |
getMinScore()
Get minimum score
|
Pageable |
getPageable()
Get page settings if defined
|
String |
getPreference()
Get preference
|
org.elasticsearch.index.query.QueryBuilder |
getQuery() |
List<RescorerQuery> |
getRescorerQueries()
get the list of
RescorerQuery s |
String |
getRoute()
Get route
|
List<ScriptField> |
getScriptFields() |
Duration |
getScrollTime()
For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete
queries.
|
List<Object> |
getSearchAfter() |
org.elasticsearch.script.mustache.SearchTemplateRequestBuilder |
getSearchTemplate() |
org.elasticsearch.action.search.SearchType |
getSearchType()
Type of search
|
Sort |
getSort() |
SourceFilter |
getSourceFilter()
Get SourceFilter to be returned to get include and exclude source fields as part of search request.
|
org.elasticsearch.common.unit.TimeValue |
getTimeout()
Get the query timeout.
|
boolean |
getTrackScores()
Get if scores will be computed and tracked, regardless of whether sorting on a field.
|
Boolean |
getTrackTotalHits()
Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh
documentation>
|
Integer |
getTrackTotalHitsUpTo()
Gets the maximum value up to which total hits are tracked.
|
boolean |
isLimiting() |
void |
setAggregations(List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> aggregations) |
void |
setCollapseBuilder(org.elasticsearch.search.collapse.CollapseBuilder collapseBuilder) |
void |
setExplain(boolean explain) |
void |
setHighlightQuery(HighlightQuery highlightQuery)
Sets the
HighlightQuery . |
void |
setIds(Collection<String> ids) |
void |
setIndicesBoost(List<IndexBoost> indicesBoost) |
void |
setIndicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions) |
void |
setMaxResults(Integer maxResults) |
void |
setMinScore(float minScore) |
<T extends Query> |
setPageable(Pageable pageable)
restrict result to entries on given page.
|
void |
setPreference(String preference)
Add preference filter to be added as part of search request
|
void |
setRescorerQueries(List<RescorerQuery> rescorerQueryList)
Sets the
RescorerQuery . |
void |
setRoute(String route) |
void |
setScriptFields(List<ScriptField> scriptFields) |
void |
setScrollTime(Duration scrollTime)
For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete
queries.
|
void |
setSearchAfter(List<Object> searchAfter)
Sets the setSearchAfter objects for this query.
|
void |
setSearchTemplate(org.elasticsearch.script.mustache.SearchTemplateRequestBuilder searchTemplate) |
void |
setSearchType(org.elasticsearch.action.search.SearchType searchType) |
void |
setTimeout(org.elasticsearch.common.unit.TimeValue timeout)
set the query timeout
|
void |
setTrackScores(boolean trackScores)
Configures whether to track scores.
|
void |
setTrackTotalHits(Boolean trackTotalHits)
Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh
documentation>
|
void |
setTrackTotalHitsUpTo(Integer trackTotalHitsUpTo)
Sets the maximum value up to which total hits are tracked.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
findAll, hasScrollTime
protected Pageable pageable
@Nullable protected SourceFilter sourceFilter
protected float minScore
@Nullable protected Collection<String> ids
protected org.elasticsearch.action.search.SearchType searchType
@Nullable protected org.elasticsearch.action.support.IndicesOptions indicesOptions
protected boolean trackScores
@Nullable protected HighlightQuery highlightQuery
protected List<RescorerQuery> rescorerQueries
public NativeSearchQuery(@Nullable org.elasticsearch.index.query.QueryBuilder query)
public NativeSearchQuery(@Nullable org.elasticsearch.index.query.QueryBuilder query, @Nullable org.elasticsearch.index.query.QueryBuilder filter)
public NativeSearchQuery(@Nullable org.elasticsearch.index.query.QueryBuilder query, @Nullable org.elasticsearch.index.query.QueryBuilder filter, @Nullable List<org.elasticsearch.search.sort.SortBuilder<?>> sorts)
public NativeSearchQuery(@Nullable org.elasticsearch.index.query.QueryBuilder query, @Nullable org.elasticsearch.index.query.QueryBuilder filter, @Nullable List<org.elasticsearch.search.sort.SortBuilder<?>> sorts, @Nullable org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields)
public NativeSearchQuery(@Nullable org.elasticsearch.index.query.QueryBuilder query, @Nullable org.elasticsearch.index.query.QueryBuilder filter, @Nullable List<org.elasticsearch.search.sort.SortBuilder<?>> sorts, @Nullable org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder highlightBuilder, @Nullable org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields)
@Nullable public org.elasticsearch.index.query.QueryBuilder getQuery()
@Nullable public org.elasticsearch.index.query.QueryBuilder getFilter()
@Nullable public List<org.elasticsearch.search.sort.SortBuilder<?>> getElasticsearchSorts()
@Nullable public org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder getHighlightBuilder()
@Nullable public org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] getHighlightFields()
public List<ScriptField> getScriptFields()
public void setScriptFields(List<ScriptField> scriptFields)
public void addScriptField(ScriptField... scriptField)
@Nullable public org.elasticsearch.search.collapse.CollapseBuilder getCollapseBuilder()
public void setCollapseBuilder(org.elasticsearch.search.collapse.CollapseBuilder collapseBuilder)
@Nullable public List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> getAggregations()
public void addAggregation(org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?> aggregationBuilder)
public void setAggregations(List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> aggregations)
@Nullable public List<IndexBoost> getIndicesBoost()
public void setIndicesBoost(List<IndexBoost> indicesBoost)
@Nullable public org.elasticsearch.script.mustache.SearchTemplateRequestBuilder getSearchTemplate()
public void setSearchTemplate(@Nullable org.elasticsearch.script.mustache.SearchTemplateRequestBuilder searchTemplate)
public Pageable getPageable()
Query
getPageable
in interface Query
public final <T extends Query> T setPageable(Pageable pageable)
Query
setPageable
in interface Query
public void addFields(String... fields)
Query
public List<String> getFields()
Query
public void addSourceFilter(SourceFilter sourceFilter)
Query
addSourceFilter
in interface Query
@Nullable public SourceFilter getSourceFilter()
Query
getSourceFilter
in interface Query
public final <T extends Query> T addSort(Sort sort)
Query
Sort
to querypublic float getMinScore()
Query
getMinScore
in interface Query
public void setMinScore(float minScore)
@Nullable public Collection<String> getIds()
Query
public void setIds(Collection<String> ids)
public void setRoute(String route)
public void setSearchType(org.elasticsearch.action.search.SearchType searchType)
public org.elasticsearch.action.search.SearchType getSearchType()
Query
getSearchType
in interface Query
@Nullable public org.elasticsearch.action.support.IndicesOptions getIndicesOptions()
Query
getIndicesOptions
in interface Query
public void setIndicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions)
public boolean getTrackScores()
Query
getTrackScores
in interface Query
public void setTrackScores(boolean trackScores)
trackScores
- @Nullable public String getPreference()
Query
getPreference
in interface Query
public void setPreference(String preference)
Query
setPreference
in interface Query
public boolean isLimiting()
isLimiting
in interface Query
@Nullable public Integer getMaxResults()
Query
Query.isLimiting()
returns true.getMaxResults
in interface Query
public void setMaxResults(Integer maxResults)
public void setHighlightQuery(HighlightQuery highlightQuery)
Query
HighlightQuery
.setHighlightQuery
in interface Query
highlightQuery
- the query to setpublic Optional<HighlightQuery> getHighlightQuery()
getHighlightQuery
in interface Query
HighlightQuery
.public void setTrackTotalHits(@Nullable Boolean trackTotalHits)
Query
setTrackTotalHits
in interface Query
trackTotalHits
- the value to set.@Nullable public Boolean getTrackTotalHits()
Query
getTrackTotalHits
in interface Query
public void setTrackTotalHitsUpTo(@Nullable Integer trackTotalHitsUpTo)
Query
setTrackTotalHitsUpTo
in interface Query
trackTotalHitsUpTo
- max limit for trackTotalHits@Nullable public Integer getTrackTotalHitsUpTo()
Query
getTrackTotalHitsUpTo
in interface Query
@Nullable public Duration getScrollTime()
Query
Query.hasScrollTime()
returns true.getScrollTime
in interface Query
public void setScrollTime(@Nullable Duration scrollTime)
Query
setScrollTime
in interface Query
scrollTime
- the scrolltime settings@Nullable public org.elasticsearch.common.unit.TimeValue getTimeout()
Query
getTimeout
in interface Query
public void setTimeout(@Nullable org.elasticsearch.common.unit.TimeValue timeout)
timeout
- public boolean getExplain()
getExplain
in interface Query
public void setExplain(boolean explain)
explain
- the explain flag on the query.public void setSearchAfter(@Nullable List<Object> searchAfter)
Query
setSearchAfter
in interface Query
searchAfter
- the setSearchAfter objects. These are obtained with SearchHit.getSortValues()
from a
search result.@Nullable public List<Object> getSearchAfter()
getSearchAfter
in interface Query
public void addRescorerQuery(RescorerQuery rescorerQuery)
Query
RescorerQuery
.addRescorerQuery
in interface Query
rescorerQuery
- the query to add to the list of rescorer queries, must not be nullpublic void setRescorerQueries(List<RescorerQuery> rescorerQueryList)
Query
RescorerQuery
.setRescorerQueries
in interface Query
rescorerQueryList
- list of rescorer queries set, must not be null.public List<RescorerQuery> getRescorerQueries()
Query
RescorerQuery
sgetRescorerQueries
in interface Query
Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.