com.arakelian.elastic.model.search

Interface Search

All Superinterfaces:

java.io.Serializable

@Value.Immutable(copy=false)
public interface Search
extends java.io.Serializable

Method Summary

Modifier and Type	Method and Description
default java.util.List<Aggregation>	getAggregations()
java.lang.Integer	getBatchedReduceSize()
default java.util.List<java.lang.String>	getFields()
java.lang.Integer	getFrom()
Highlighter.Highlight	getHighlight()
java.lang.String	getPreference()
Query	getQuery()
java.lang.String	getScroll()
java.lang.String	getScrollId()
SearchType	getSearchType()
java.lang.Integer	getSize()
default java.util.List<Sort>	getSorts()
SourceFilter	getSourceFilter()
java.lang.Integer	getTerminateAfter() Returns the maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
java.lang.String	getTimeout() Returns the explicit operation timeout, e.g.
java.lang.Boolean	isAllowPartialSearchResults() Returns true if an error should be returned if there is a partial search failure or timeout
java.lang.Boolean	isExplain()
java.lang.Boolean	isRequestCache() Returns true to enable caching of search results for requests where size is 0, ie aggregations and suggestions (no top hits returned).
java.lang.Boolean	isTrackScores() Returns true to calculate and return scores even if they are not used for sorting
java.lang.Boolean	isTrackTotalHits() Returns true if the number of documents that match the query should be tracked
java.lang.Boolean	isVersion()

Method Detail

getAggregations

@Value.Default
default java.util.List<Aggregation> getAggregations()

getBatchedReduceSize

java.lang.Integer getBatchedReduceSize()

getFields

@Value.Default
default java.util.List<java.lang.String> getFields()

getFrom

java.lang.Integer getFrom()

getHighlight

Highlighter.Highlight getHighlight()

getPreference

java.lang.String getPreference()

getQuery

Query getQuery()

getScroll

java.lang.String getScroll()

getScrollId

java.lang.String getScrollId()

getSearchType

SearchType getSearchType()

getSize

java.lang.Integer getSize()

getSorts

@Value.Default
default java.util.List<Sort> getSorts()

getSourceFilter

SourceFilter getSourceFilter()

getTerminateAfter

java.lang.Integer getTerminateAfter()

Returns the maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. If set, the response will have a boolean field terminated_early to indicate whether the query execution has actually terminated_early.

Returns:

the maximum number of documents to collect for each shard

getTimeout

java.lang.String getTimeout()

Returns the explicit operation timeout, e.g. "20s"

Returns:

the explicit operation timeout

isAllowPartialSearchResults

java.lang.Boolean isAllowPartialSearchResults()

Returns true if an error should be returned if there is a partial search failure or timeout

Returns:

true if an error should be returned if there is a partial search failure or timeout

isExplain

java.lang.Boolean isExplain()

isRequestCache

java.lang.Boolean isRequestCache()

Returns true to enable caching of search results for requests where size is 0, ie aggregations and suggestions (no top hits returned).

Returns:

true to enable caching of search results

isTrackScores

java.lang.Boolean isTrackScores()

Returns true to calculate and return scores even if they are not used for sorting

Returns:

true to calculate and return scores even if they are not used for sorting

isTrackTotalHits

java.lang.Boolean isTrackTotalHits()

Returns true if the number of documents that match the query should be tracked

Returns:

true if the number of documents that match the query should be tracked

isVersion

java.lang.Boolean isVersion()