Package org.springframework.data.elasticsearch.core.query

Class NativeSearchQueryBuilder

java.lang.Object

org.springframework.data.elasticsearch.core.query.BaseQueryBuilder<NativeSearchQuery,NativeSearchQueryBuilder>

org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder

public class NativeSearchQueryBuilder
extends BaseQueryBuilder<NativeSearchQuery,NativeSearchQueryBuilder>

NativeSearchQuery

Author:

Rizwan Idrees, Mohsin Husen, Artur Konczak, Mark Paluch, Alen Turkovic, Sascha Woo, Jean-Baptiste Nizet, Martin Choraine, Farid Azaza, Peter-Josef Meisch, Peer Mueller, vdisk, owen.qq

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	storedFields

Fields inherited from class org.springframework.data.elasticsearch.core.query.BaseQueryBuilder

highlightQuery, indicesOptions

Constructor Summary

Constructors

Constructor	Description
NativeSearchQueryBuilder()

Method Summary

Modifier and Type	Method	Description
NativeSearchQueryBuilder	addAggregation(org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?> aggregationBuilder)	Deprecated. use withAggregations(AbstractAggregationBuilder...) instead.
NativeSearchQueryBuilder	addAggregation(org.elasticsearch.search.aggregations.PipelineAggregationBuilder pipelineAggregationBuilder)	Deprecated. use withPipelineAggregations(PipelineAggregationBuilder...) instead.
NativeSearchQuery	build()
NativeSearchQueryBuilder	withAggregations(Collection<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> aggregationBuilders)
NativeSearchQueryBuilder	withAggregations(org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>... aggregationBuilders)
NativeSearchQueryBuilder	withCollapseBuilder(org.elasticsearch.search.collapse.CollapseBuilder collapseBuilder)
NativeSearchQueryBuilder	withCollapseField(String collapseField)
NativeSearchQueryBuilder	withFilter(org.elasticsearch.index.query.QueryBuilder filterBuilder)
NativeSearchQueryBuilder	withHighlightBuilder(org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder highlightBuilder)
NativeSearchQueryBuilder	withHighlightFields(Collection<org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field> highlightFields)
NativeSearchQueryBuilder	withHighlightFields(org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field... highlightFields)
NativeSearchQueryBuilder	withIndicesOptions(IndicesOptions indicesOptions)
NativeSearchQueryBuilder	withPipelineAggregations(Collection<org.elasticsearch.search.aggregations.PipelineAggregationBuilder> pipelineAggregationBuilders)
NativeSearchQueryBuilder	withPipelineAggregations(org.elasticsearch.search.aggregations.PipelineAggregationBuilder... pipelineAggregationBuilders)
NativeSearchQueryBuilder	withQuery(org.elasticsearch.index.query.QueryBuilder queryBuilder)
NativeSearchQueryBuilder	withRescorerQuery(RescorerQuery rescorerQuery)
NativeSearchQueryBuilder	withScriptField(ScriptField scriptField)
NativeSearchQueryBuilder	withSearchAfter(List<Object> searchAfter)
NativeSearchQueryBuilder	withSearchTemplate(org.elasticsearch.script.mustache.SearchTemplateRequestBuilder searchTemplateBuilder)
NativeSearchQueryBuilder	withSearchType(org.elasticsearch.action.search.SearchType searchType)
NativeSearchQueryBuilder	withSort(org.elasticsearch.search.sort.SortBuilder<?> sortBuilder)	Deprecated. use withSorts(SortBuilder...) instead.
NativeSearchQueryBuilder	withSorts(Collection<org.elasticsearch.search.sort.SortBuilder<?>> sortBuilders)
NativeSearchQueryBuilder	withSorts(org.elasticsearch.search.sort.SortBuilder<?>... sortBuilders)
NativeSearchQueryBuilder	withStoredFields(String... storedFields)
NativeSearchQueryBuilder	withStoredFields(Collection<String> storedFields)
NativeSearchQueryBuilder	withSuggestBuilder(org.elasticsearch.search.suggest.SuggestBuilder suggestBuilder)
NativeSearchQueryBuilder	withTimeout(Duration timeout)
NativeSearchQueryBuilder	withTrackTotalHits(Boolean trackTotalHits)

Methods inherited from class org.springframework.data.elasticsearch.core.query.BaseQueryBuilder

getFields, getHighlightQuery, getIds, getIndicesBoost, getIndicesOptions, getMaxResults, getMinScore, getPageable, getPreference, getRoute, getSort, getSourceFilter, getTrackScores, withFields, withFields, withHighlightQuery, withIds, withIds, withIndicesBoost, withIndicesBoost, withMaxResults, withMinScore, withPageable, withPreference, withRoute, withSort, withSourceFilter, withTrackScores

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

storedFields

@Nullable
protected List<String> storedFields

Constructor Details

NativeSearchQueryBuilder

public NativeSearchQueryBuilder()

Method Details

withQuery

public NativeSearchQueryBuilder withQuery(org.elasticsearch.index.query.QueryBuilder queryBuilder)

withFilter

public NativeSearchQueryBuilder withFilter(org.elasticsearch.index.query.QueryBuilder filterBuilder)

withSort

@Deprecated
public NativeSearchQueryBuilder withSort(org.elasticsearch.search.sort.SortBuilder<?> sortBuilder)

Deprecated.

use withSorts(SortBuilder...) instead.

withSorts

public NativeSearchQueryBuilder withSorts(Collection<org.elasticsearch.search.sort.SortBuilder<?>> sortBuilders)

Since:

4.3

withSorts

public NativeSearchQueryBuilder withSorts(org.elasticsearch.search.sort.SortBuilder<?>... sortBuilders)

Since:

4.3

withScriptField

public NativeSearchQueryBuilder withScriptField(ScriptField scriptField)

withCollapseField

public NativeSearchQueryBuilder withCollapseField(String collapseField)

withCollapseBuilder

public NativeSearchQueryBuilder withCollapseBuilder(@Nullable
 org.elasticsearch.search.collapse.CollapseBuilder collapseBuilder)

Since:

4.3

addAggregation

@Deprecated
public NativeSearchQueryBuilder addAggregation(org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?> aggregationBuilder)

Deprecated.

use withAggregations(AbstractAggregationBuilder...) instead.

withAggregations

public NativeSearchQueryBuilder withAggregations(Collection<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> aggregationBuilders)

Since:

4.3

withAggregations

public NativeSearchQueryBuilder withAggregations(org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>... aggregationBuilders)

Since:

4.3

addAggregation

@Deprecated
public NativeSearchQueryBuilder addAggregation(org.elasticsearch.search.aggregations.PipelineAggregationBuilder pipelineAggregationBuilder)

Deprecated.

use withPipelineAggregations(PipelineAggregationBuilder...) instead.

withPipelineAggregations

public NativeSearchQueryBuilder withPipelineAggregations(Collection<org.elasticsearch.search.aggregations.PipelineAggregationBuilder> pipelineAggregationBuilders)

Since:

4.3

withPipelineAggregations

public NativeSearchQueryBuilder withPipelineAggregations(org.elasticsearch.search.aggregations.PipelineAggregationBuilder... pipelineAggregationBuilders)

Since:

4.3

withHighlightBuilder

public NativeSearchQueryBuilder withHighlightBuilder(org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder highlightBuilder)

withHighlightFields

public NativeSearchQueryBuilder withHighlightFields(org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field... highlightFields)

withHighlightFields

public NativeSearchQueryBuilder withHighlightFields(Collection<org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field> highlightFields)

Since:

4.3

withSearchTemplate

public NativeSearchQueryBuilder withSearchTemplate(org.elasticsearch.script.mustache.SearchTemplateRequestBuilder searchTemplateBuilder)

withStoredFields

public NativeSearchQueryBuilder withStoredFields(Collection<String> storedFields)

withStoredFields

public NativeSearchQueryBuilder withStoredFields(String... storedFields)

withSearchType

public NativeSearchQueryBuilder withSearchType(org.elasticsearch.action.search.SearchType searchType)

withIndicesOptions

public NativeSearchQueryBuilder withIndicesOptions(IndicesOptions indicesOptions)

Overrides:

withIndicesOptions in class BaseQueryBuilder<NativeSearchQuery,NativeSearchQueryBuilder>

withTrackTotalHits

public NativeSearchQueryBuilder withTrackTotalHits(Boolean trackTotalHits)

Since:

4.2

withTimeout

public NativeSearchQueryBuilder withTimeout(Duration timeout)

withRescorerQuery

public NativeSearchQueryBuilder withRescorerQuery(RescorerQuery rescorerQuery)

withSuggestBuilder

public NativeSearchQueryBuilder withSuggestBuilder(org.elasticsearch.search.suggest.SuggestBuilder suggestBuilder)

Since:

4.3

withSearchAfter

public NativeSearchQueryBuilder withSearchAfter(List<Object> searchAfter)

build

public NativeSearchQuery build()

Specified by:

build in class BaseQueryBuilder<NativeSearchQuery,NativeSearchQueryBuilder>