SearchRequest

Instance Constructors

new SearchRequest(indexesTypes: IndexesAndTypes, aggs: Seq[AbstractAggregation] = Nil, collapse: Option[CollapseRequest] = None, fields: Fields = Fields(), fetchContext: Option[FetchSourceContext] = None, control: Control = Control(), scoring: Scoring = Scoring(), indicesOptions: Option[IndicesOptionsRequest] = None, inners: Seq[InnerHit] = Nil, indexBoosts: Seq[(String, Double)] = Nil, keepAlive: Option[String] = None, highlight: Option[Highlight] = None, query: Option[Query] = None, postFilter: Option[Query] = None, requestCache: Option[Boolean] = None, sorts: Seq[Sort] = Nil, suggestions: Suggestions = Suggestions(), windowing: Windowing = Windowing(), meta: Meta = Meta(), searchType: Option[SearchType] = None, searchAfter: Seq[Any] = Nil, version: Option[Boolean] = None, profile: Option[Boolean] = None, source: Option[String] = None, trackHits: Option[Boolean] = None, typedKeys: Option[Boolean] = None, restTotalHitsAsInt: Option[Boolean] = None, seqNoPrimaryTerm: Option[Boolean] = None)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def aggregations(first: AbstractAggregation, rest: AbstractAggregation*): SearchRequest
def aggregations(aggs: Iterable[AbstractAggregation]): SearchRequest
def aggs(iterable: Iterable[AbstractAggregation]): SearchRequest
def aggs(first: AbstractAggregation, rest: AbstractAggregation*): SearchRequest
val aggs: Seq[AbstractAggregation]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bool(block: ⇒ BoolQuery): SearchRequest
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def collapse(collapse: CollapseRequest): SearchRequest
val collapse: Option[CollapseRequest]
val control: Control
def docValues(_fields: Seq[String]): SearchRequest
def docValues(first: String, rest: String*): SearchRequest
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def explain(enabled: Boolean): SearchRequest
def fetchContext(context: FetchSourceContext): SearchRequest
val fetchContext: Option[FetchSourceContext]
def fetchSource(fetch: Boolean): SearchRequest
val fields: Fields
def from(i: Int): SearchRequest
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def globalSuggestionText(text: String): SearchRequest
val highlight: Option[Highlight]
def highlighting(options: HighlightOptions, fields: Iterable[HighlightField]): SearchRequest
def highlighting(options: HighlightOptions, first: HighlightField, rest: HighlightField*): SearchRequest
def highlighting(fields: Iterable[HighlightField]): SearchRequest
def highlighting(first: HighlightField, rest: HighlightField*): SearchRequest
def indexBoost(tuples: (String, Double)*): SearchRequest
def indexBoost(map: Map[String, Double]): SearchRequest
val indexBoosts: Seq[(String, Double)]
val indexesTypes: IndexesAndTypes
def indicesOptions(options: IndicesOptionsRequest): SearchRequest
val indicesOptions: Option[IndicesOptionsRequest]
def inner(inners: Iterable[InnerHit]): SearchRequest
def inner(first: InnerHit, rest: InnerHit*): SearchRequest
val inners: Seq[InnerHit]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def keepAlive(duration: FiniteDuration): SearchRequest
def keepAlive(keepAlive: String): SearchRequest
val keepAlive: Option[String]
def limit(i: Int): SearchRequest
def matchAllQuery(): SearchRequest
def matchQuery(field: String, value: Any): SearchRequest
val meta: Meta
def minScore(min: Double): SearchRequest
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def postFilter(block: ⇒ Query): SearchRequest
val postFilter: Option[Query]
def preference(pref: String): SearchRequest
def preference(pref: Preference): SearchRequest
def prefix(name: String, value: Any): SearchRequest
val profile: Option[Boolean]
def query(q: Query): SearchRequest
def query(string: String): SearchRequest

Adds a single string query to this search
Adds a single string query to this search
string
the query string
val query: Option[Query]
def rawQuery(json: String): SearchRequest

Expects a query in json format and sets the query of the search request.
Expects a query in json format and sets the query of the search request. i.e. underneath a "query" field if referencing HTTP API Query must be valid json beginning with '{' and ending with '}'. Field names must be double quoted.
Example:
```
search in "*" types("users", "tweets") limit 5 rawQuery {
"""{ "prefix": { "bands": { "prefix": "coldplay", "boost": 5.0, "rewrite": "yes" } } }"""
} searchType SearchType.Scan
```
def regexQuery(field: String, value: String): SearchRequest
def regexQuery(tuple: (String, String)): SearchRequest
def requestCache(requestCache: Boolean): SearchRequest
val requestCache: Option[Boolean]
def rescore(rescorers: Iterable[Rescore]): SearchRequest
def rescore(first: Rescore, rest: Rescore*): SearchRequest
def restTotalHitsAsInt(restTotalHitsAsInt: Boolean): SearchRequest
val restTotalHitsAsInt: Option[Boolean]
def routing(r: String): SearchRequest
val scoring: Scoring
def scriptfields(_fields: Iterable[ScriptField]): SearchRequest
def scriptfields(fields: ScriptField*): SearchRequest

This method introduces zero or more script field definitions into the search construction
This method introduces zero or more script field definitions into the search construction
fields
zero or more ScriptField instances
returns
this, an instance of SearchRequest
def scroll(duration: FiniteDuration): SearchRequest
def scroll(keepAlive: String): SearchRequest
def searchAfter(values: Seq[Any]): SearchRequest
val searchAfter: Seq[Any]
def searchType(searchType: SearchType): SearchRequest
val searchType: Option[SearchType]
def seqNoPrimaryTerm(enabled: Boolean): SearchRequest
val seqNoPrimaryTerm: Option[Boolean]
def size(i: Int): SearchRequest
def slice(id: Int, max: Int): SearchRequest
def sortBy(sorts: Iterable[Sort]): SearchRequest
def sortBy(sorts: Sort*): SearchRequest
def sortByFieldAsc(name: String): SearchRequest
def sortByFieldDesc(name: String): SearchRequest
val sorts: Seq[Sort]
def source(json: String): SearchRequest

Sets the source of the request as a json string.
Sets the source of the request as a json string. Note, if you use this method any other body-level settings will be ignored.
HTTP query-parameter settings can still be used, eg limit, routing, search type etc.
Unlike rawQuery, source is parsed at the "root" level Query must be valid json beginning with '{' and ending with '}'. Field names must be double quoted.
NOTE: This method only works with the HTTP client.
Example:
```
search in "*" types("users", "tweets") limit 5 source {
"""{ "query": { "prefix": { "bands": { "prefix": "coldplay", "boost": 5.0, "rewrite": "yes" } } } }"""
} searchType SearchType.Scan
```
val source: Option[String]
def sourceExclude(excludes: Iterable[String]): SearchRequest
def sourceExclude(first: String, rest: String*): SearchRequest
def sourceFiltering(includes: Iterable[String], excludes: Iterable[String]): SearchRequest
def sourceInclude(includes: Iterable[String]): SearchRequest
def sourceInclude(first: String, rest: String*): SearchRequest
def start(i: Int): SearchRequest
def stats(groups: String*): SearchRequest
def storedFields(_fields: Iterable[String]): SearchRequest
def storedFields(first: String, rest: String*): SearchRequest
def suggestion(sugg: Suggestion): SearchRequest
def suggestions(suggs: Iterable[Suggestion]): SearchRequest
def suggestions(first: Suggestion, rest: Suggestion*): SearchRequest

Adds a new suggestion to the search request, which can be looked up in the response using the name provided.
val suggestions: Suggestions
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def termQuery(field: String, value: Any): SearchRequest
def termQuery(tuple: (String, Any)): SearchRequest
def terminateAfter(terminateAfter: Int): SearchRequest

The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
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. Defaults to no.
def timeout(timeout: FiniteDuration): SearchRequest
val trackHits: Option[Boolean]
def trackScores(enabled: Boolean): SearchRequest
def trackTotalHits(value: Boolean): SearchRequest
def typedKeys(enabled: Boolean): SearchRequest
val typedKeys: Option[Boolean]
def types(types: Iterable[String]): SearchRequest
def types(first: String, rest: String*): SearchRequest
def version(version: Boolean): SearchRequest
val version: Option[Boolean]
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val windowing: Windowing

Deprecated Value Members

def fields(fields: String*): SearchRequest

Annotations
@deprecated
Deprecated
(Since version 5.0.0) Renamed to storedFields
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.
def matchAll(): SearchRequest

Annotations
@deprecated
Deprecated
(Since version 5.2.0) Use matchAllQuery()
def regex(tuple: (String, String)): SearchRequest

Annotations
@deprecated
Deprecated
(Since version 5.0.0) use regexQuery(...)
def sort(sorts: Sort*): SearchRequest

Annotations
@deprecated
Deprecated
(Since version 5.0.0) use sortBy
def term(field: String, value: Any): SearchRequest

Annotations
@deprecated
Deprecated
(Since version 5.0.0) use termQuery()
def term(tuple: (String, Any)): SearchRequest

Annotations
@deprecated
Deprecated
(Since version 5.0.0) use termQuery()

Related Doc: package searches

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def aggregations(first: AbstractAggregation, rest: AbstractAggregation*): SearchRequest

def aggregations(aggs: Iterable[AbstractAggregation]): SearchRequest

def aggs(iterable: Iterable[AbstractAggregation]): SearchRequest

def aggs(first: AbstractAggregation, rest: AbstractAggregation*): SearchRequest

val aggs: Seq[AbstractAggregation]

final def asInstanceOf[T0]: T0

def bool(block: ⇒ BoolQuery): SearchRequest

def clone(): AnyRef

def collapse(collapse: CollapseRequest): SearchRequest

val collapse: Option[CollapseRequest]

val control: Control

def docValues(_fields: Seq[String]): SearchRequest

def docValues(first: String, rest: String*): SearchRequest

final def eq(arg0: AnyRef): Boolean

def explain(enabled: Boolean): SearchRequest

def fetchContext(context: FetchSourceContext): SearchRequest

val fetchContext: Option[FetchSourceContext]

def fetchSource(fetch: Boolean): SearchRequest

val fields: Fields

def from(i: Int): SearchRequest

final def getClass(): Class[_]

def globalSuggestionText(text: String): SearchRequest

val highlight: Option[Highlight]

def highlighting(options: HighlightOptions, fields: Iterable[HighlightField]): SearchRequest

def highlighting(options: HighlightOptions, first: HighlightField, rest: HighlightField*): SearchRequest

def highlighting(fields: Iterable[HighlightField]): SearchRequest

def highlighting(first: HighlightField, rest: HighlightField*): SearchRequest

def indexBoost(tuples: (String, Double)*): SearchRequest

def indexBoost(map: Map[String, Double]): SearchRequest

val indexBoosts: Seq[(String, Double)]

val indexesTypes: IndexesAndTypes

def indicesOptions(options: IndicesOptionsRequest): SearchRequest

val indicesOptions: Option[IndicesOptionsRequest]

def inner(inners: Iterable[InnerHit]): SearchRequest

def inner(first: InnerHit, rest: InnerHit*): SearchRequest

val inners: Seq[InnerHit]

final def isInstanceOf[T0]: Boolean

def keepAlive(duration: FiniteDuration): SearchRequest

def keepAlive(keepAlive: String): SearchRequest

val keepAlive: Option[String]

def limit(i: Int): SearchRequest

def matchAllQuery(): SearchRequest

def matchQuery(field: String, value: Any): SearchRequest

val meta: Meta

def minScore(min: Double): SearchRequest

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def postFilter(block: ⇒ Query): SearchRequest

val postFilter: Option[Query]

def preference(pref: String): SearchRequest

def preference(pref: Preference): SearchRequest

def prefix(name: String, value: Any): SearchRequest

val profile: Option[Boolean]

def query(q: Query): SearchRequest

def query(string: String): SearchRequest

val query: Option[Query]

def rawQuery(json: String): SearchRequest

def regexQuery(field: String, value: String): SearchRequest

def regexQuery(tuple: (String, String)): SearchRequest

def requestCache(requestCache: Boolean): SearchRequest

val requestCache: Option[Boolean]

def rescore(rescorers: Iterable[Rescore]): SearchRequest

def rescore(first: Rescore, rest: Rescore*): SearchRequest

def restTotalHitsAsInt(restTotalHitsAsInt: Boolean): SearchRequest

val restTotalHitsAsInt: Option[Boolean]

def routing(r: String): SearchRequest

val scoring: Scoring

def scriptfields(_fields: Iterable[ScriptField]): SearchRequest

def scriptfields(fields: ScriptField*): SearchRequest

def scroll(duration: FiniteDuration): SearchRequest

def scroll(keepAlive: String): SearchRequest

def searchAfter(values: Seq[Any]): SearchRequest