Package org.hibernate.search.backend.elasticsearch.search.query.dsl

Interface ElasticsearchSearchQueryOptionsStep<H,LOS>

All Superinterfaces:

ElasticsearchSearchFetchable<H>, ExtendedSearchFetchable<H,ElasticsearchSearchResult<H>,ElasticsearchSearchScroll<H>>, SearchFetchable<H>, SearchQueryFinalStep<H>, SearchQueryOptionsStep<ElasticsearchSearchQueryOptionsStep<H,LOS>,H,LOS,ElasticsearchSearchSortFactory,ElasticsearchSearchAggregationFactory>

public interface ElasticsearchSearchQueryOptionsStep<H,LOS>
extends SearchQueryOptionsStep<ElasticsearchSearchQueryOptionsStep<H,LOS>,H,LOS,ElasticsearchSearchSortFactory,ElasticsearchSearchAggregationFactory>, ElasticsearchSearchFetchable<H>

Method Summary

Modifier and Type	Method	Description
ElasticsearchSearchQueryOptionsStep<H,LOS>	requestTransformer(ElasticsearchSearchRequestTransformer transformer)	Set the ElasticsearchSearchRequestTransformer for this search query.
ElasticsearchSearchQuery<H>	toQuery()	Create a SearchQuery instance matching the definition given in the previous DSL steps.

Methods inherited from interface org.hibernate.search.engine.search.query.ExtendedSearchFetchable

fetch, fetch, fetchAll, scroll

Methods inherited from interface org.hibernate.search.engine.search.query.SearchFetchable

fetchAllHits, fetchHits, fetchHits, fetchSingleHit, fetchTotalHitCount

Methods inherited from interface org.hibernate.search.engine.search.query.dsl.SearchQueryOptionsStep

aggregation, aggregation, failAfter, highlighter, highlighter, highlighter, highlighter, loading, routing, routing, sort, sort, totalHitCountThreshold, truncateAfter

Method Details

requestTransformer

@Incubating
ElasticsearchSearchQueryOptionsStep<H,LOS> requestTransformer(ElasticsearchSearchRequestTransformer transformer)

Set the ElasticsearchSearchRequestTransformer for this search query.

WARNING: Direct changes to the request may conflict with Hibernate Search features and be supported differently by different versions of Elasticsearch. Thus they cannot be guaranteed to continue to work when upgrading Hibernate Search, even for micro upgrades (x.y.z to x.y.(z+1)). Use this at your own risk.

Parameters:

transformer - The search request transformer.

Returns:

this, for method chaining.

toQuery

ElasticsearchSearchQuery<H> toQuery()

Description copied from interface: SearchQueryFinalStep

Create a SearchQuery instance matching the definition given in the previous DSL steps.

Calling this method is generally not necessary as most query execution methods are also implemented by this DSL step, so for example .toQuery().fetch() can be replaced with simply .fetch().

Specified by:

toQuery in interface SearchQueryFinalStep<H>

Returns:

The SearchQuery resulting from the previous DSL steps.