SearchDefinition

Instance Constructors

new SearchDefinition(indexesTypes: IndexesAndTypes, aggs: Seq[AggregationDefinition] = Nil, explain: Option[Boolean] = None, fetchContext: Option[FetchSourceContext] = None, from: Option[Int] = None, indicesOptions: Option[IndicesOptions] = None, inners: Seq[InnerHitDefinition] = Nil, indexBoosts: Seq[(String, Double)] = Nil, keepAlive: Option[String] = None, highlight: Option[Highlight] = None, minScore: Option[Double] = None, pref: Option[String] = None, query: Option[QueryDefinition] = None, postFilter: Option[QueryDefinition] = None, requestCache: Option[Boolean] = None, rescorers: Seq[RescoreDefinition] = Nil, scriptFields: Seq[ScriptFieldDefinition] = Nil, sorts: Seq[SortDefinition] = Nil, storedFields: Seq[String] = Nil, suggs: Seq[SuggestionDefinition] = Nil, size: Option[Int] = None, routing: Option[String] = None, stats: Seq[String] = Nil, searchType: Option[SearchType] = None, searchAfter: Seq[Any] = Nil, trackScores: Option[Boolean] = None, terminateAfter: Option[Int] = None, timeout: Option[Duration] = None, version: 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: AggregationDefinition, rest: AggregationDefinition*): SearchDefinition
def aggregations(aggs: Iterable[AggregationDefinition]): SearchDefinition
def aggs(iterable: Iterable[AggregationDefinition]): SearchDefinition
def aggs(first: AggregationDefinition, rest: AggregationDefinition*): SearchDefinition
val aggs: Seq[AggregationDefinition]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bool(block: ⇒ BoolQueryDefinition): SearchDefinition
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def explain(enabled: Boolean): SearchDefinition
val explain: Option[Boolean]
def extraSource(json: String): SearchDefinition

Sets the source of the request as a json string.
Sets the source of the request as a json string. Allows setting other parameters. Unlike rawQuery, setExtraSource is parsed at the "root" level Query must be valid json beginning with '{' and ending with '}'. Field names must be double quoted.
Example:
```
search in "*" types("users", "tweets") limit 5 extraSource {
"""{ "query": { "prefix": { "bands": { "prefix": "coldplay", "boost": 5.0, "rewrite": "yes" } } } }"""
} searchType SearchType.Scan
```
def fetchContext(context: FetchSourceContext): SearchDefinition
val fetchContext: Option[FetchSourceContext]
def fetchSource(fetch: Boolean): SearchDefinition
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def from(i: Int): SearchDefinition
val from: Option[Int]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val highlight: Option[Highlight]
def highlighting(options: HighlightOptionsDefinition, fields: Iterable[HighlightFieldDefinition]): SearchDefinition
def highlighting(options: HighlightOptionsDefinition, first: HighlightFieldDefinition, rest: HighlightFieldDefinition*): SearchDefinition
def highlighting(fields: Iterable[HighlightFieldDefinition]): SearchDefinition
def highlighting(first: HighlightFieldDefinition, rest: HighlightFieldDefinition*): SearchDefinition
def indexBoost(tuples: (String, Double)*): SearchDefinition
def indexBoost(map: Map[String, Double]): SearchDefinition
val indexBoosts: Seq[(String, Double)]
val indexesTypes: IndexesAndTypes
def indicesOptions(options: IndicesOptions): SearchDefinition
val indicesOptions: Option[IndicesOptions]
def inner(inners: Iterable[InnerHitDefinition]): SearchDefinition
def inner(first: InnerHitDefinition, rest: InnerHitDefinition*): SearchDefinition
val inners: Seq[InnerHitDefinition]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val keepAlive: Option[String]
def limit(i: Int): SearchDefinition
def matchAllQuery(): SearchDefinition
def minScore(min: Double): SearchDefinition
val minScore: Option[Double]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def postFilter(block: ⇒ QueryDefinition): SearchDefinition
val postFilter: Option[QueryDefinition]
val pref: Option[String]
def preference(pref: String): SearchDefinition
def preference(pref: org.elasticsearch.cluster.routing.Preference): SearchDefinition
def prefix(name: String, value: Any): SearchDefinition
def query(q: QueryDefinition): SearchDefinition
def query(string: String): SearchDefinition

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

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): SearchDefinition
def regexQuery(tuple: (String, String)): SearchDefinition
def requestCache(requestCache: Boolean): SearchDefinition
val requestCache: Option[Boolean]
def rescore(rescorers: Iterable[RescoreDefinition]): SearchDefinition
def rescore(first: RescoreDefinition, rest: RescoreDefinition*): SearchDefinition
val rescorers: Seq[RescoreDefinition]
def routing(r: String): SearchDefinition
val routing: Option[String]
val scriptFields: Seq[ScriptFieldDefinition]
def scriptfields(fields: Iterable[ScriptFieldDefinition]): SearchDefinition
def scriptfields(fields: ScriptFieldDefinition*): SearchDefinition

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 ScriptFieldDefinition instances
returns
this, an instance of SearchDefinition
def scroll(keepAlive: String): SearchDefinition
def searchAfter(values: Seq[Any]): SearchDefinition
val searchAfter: Seq[Any]
def searchType(searchType: SearchType): SearchDefinition
val searchType: Option[SearchType]
def size(i: Int): SearchDefinition
val size: Option[Int]
def sortBy(sorts: Iterable[SortDefinition]): SearchDefinition
def sortBy(sorts: SortDefinition*): SearchDefinition
val sorts: Seq[SortDefinition]
def source(json: String): SearchDefinition

Sets the source of the request as a json string.
Sets the source of the request as a json string. Note, setting anything other than the search type will cause this source to be overridden, consider using #setExtraSource(String).
Unlike rawQuery, setExtraSource is parsed at the "root" level Query must be valid json beginning with '{' and ending with '}'. Field names must be double quoted.
Example:
```
search in "*" types("users", "tweets") limit 5 extraSource {
"""{ "query": { "prefix": { "bands": { "prefix": "coldplay", "boost": 5.0, "rewrite": "yes" } } } }"""
} searchType SearchType.Scan
```
def sourceExclude(excludes: Iterable[String]): SearchDefinition
def sourceExclude(first: String, rest: String*): SearchDefinition
def sourceFiltering(includes: Iterable[String], excludes: Iterable[String]): SearchDefinition
def sourceInclude(includes: Iterable[String]): SearchDefinition
def sourceInclude(first: String, rest: String*): SearchDefinition
def start(i: Int): SearchDefinition
def stats(groups: String*): SearchDefinition
val stats: Seq[String]
def storedFields(fields: Iterable[String]): SearchDefinition
def storedFields(first: String, rest: String*): SearchDefinition
val storedFields: Seq[String]
def suggestion(sugg: SuggestionDefinition): SearchDefinition
def suggestions(suggs: Iterable[SuggestionDefinition]): SearchDefinition
def suggestions(first: SuggestionDefinition, rest: SuggestionDefinition*): SearchDefinition

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

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

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.
val terminateAfter: Option[Int]
def timeout(duration: FiniteDuration): SearchDefinition
val timeout: Option[Duration]
def trackScores(enabled: Boolean): SearchDefinition
val trackScores: Option[Boolean]
def types(types: Iterable[String]): SearchDefinition
def types(first: String, rest: String*): SearchDefinition
def version(version: Boolean): SearchDefinition
val version: Option[Boolean]
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def fields(fields: String*): SearchDefinition

Annotations
@deprecated
Deprecated
(Since version 5.0.0) Renamed to storedFields
def matchAll(): SearchDefinition

Annotations
@deprecated
Deprecated
(Since version 5.2.0) Use matchAllQuery()
def preference(pref: Preference): SearchDefinition

Annotations
@deprecated
Deprecated
(Since version 5.2.0) Use the elasticsearch enum rather than the elastic4s one
def regex(tuple: (String, String)): SearchDefinition

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

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

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

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: AggregationDefinition, rest: AggregationDefinition*): SearchDefinition

def aggregations(aggs: Iterable[AggregationDefinition]): SearchDefinition

def aggs(iterable: Iterable[AggregationDefinition]): SearchDefinition

def aggs(first: AggregationDefinition, rest: AggregationDefinition*): SearchDefinition

val aggs: Seq[AggregationDefinition]

final def asInstanceOf[T0]: T0

def bool(block: ⇒ BoolQueryDefinition): SearchDefinition

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def explain(enabled: Boolean): SearchDefinition

val explain: Option[Boolean]

def extraSource(json: String): SearchDefinition

def fetchContext(context: FetchSourceContext): SearchDefinition

val fetchContext: Option[FetchSourceContext]

def fetchSource(fetch: Boolean): SearchDefinition

def finalize(): Unit

def from(i: Int): SearchDefinition

val from: Option[Int]

final def getClass(): Class[_]

val highlight: Option[Highlight]

def highlighting(options: HighlightOptionsDefinition, fields: Iterable[HighlightFieldDefinition]): SearchDefinition

def highlighting(options: HighlightOptionsDefinition, first: HighlightFieldDefinition, rest: HighlightFieldDefinition*): SearchDefinition

def highlighting(fields: Iterable[HighlightFieldDefinition]): SearchDefinition

def highlighting(first: HighlightFieldDefinition, rest: HighlightFieldDefinition*): SearchDefinition

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

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

val indexBoosts: Seq[(String, Double)]

val indexesTypes: IndexesAndTypes

def indicesOptions(options: IndicesOptions): SearchDefinition

val indicesOptions: Option[IndicesOptions]

def inner(inners: Iterable[InnerHitDefinition]): SearchDefinition

def inner(first: InnerHitDefinition, rest: InnerHitDefinition*): SearchDefinition

val inners: Seq[InnerHitDefinition]

final def isInstanceOf[T0]: Boolean

val keepAlive: Option[String]

def limit(i: Int): SearchDefinition

def matchAllQuery(): SearchDefinition

def minScore(min: Double): SearchDefinition

val minScore: Option[Double]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def postFilter(block: ⇒ QueryDefinition): SearchDefinition

val postFilter: Option[QueryDefinition]

val pref: Option[String]

def preference(pref: String): SearchDefinition

def preference(pref: org.elasticsearch.cluster.routing.Preference): SearchDefinition

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

def query(q: QueryDefinition): SearchDefinition

def query(string: String): SearchDefinition

val query: Option[QueryDefinition]

def rawQuery(json: String): SearchDefinition

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

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

def requestCache(requestCache: Boolean): SearchDefinition

val requestCache: Option[Boolean]

def rescore(rescorers: Iterable[RescoreDefinition]): SearchDefinition

def rescore(first: RescoreDefinition, rest: RescoreDefinition*): SearchDefinition

val rescorers: Seq[RescoreDefinition]

def routing(r: String): SearchDefinition

val routing: Option[String]

val scriptFields: Seq[ScriptFieldDefinition]

def scriptfields(fields: Iterable[ScriptFieldDefinition]): SearchDefinition

def scriptfields(fields: ScriptFieldDefinition*): SearchDefinition

def scroll(keepAlive: String): SearchDefinition

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

val searchAfter: Seq[Any]

def searchType(searchType: SearchType): SearchDefinition

val searchType: Option[SearchType]

def size(i: Int): SearchDefinition

val size: Option[Int]

def sortBy(sorts: Iterable[SortDefinition]): SearchDefinition

def sortBy(sorts: SortDefinition*): SearchDefinition