Class

com.sksamuel.elastic4s.searches

SearchDefinition

Related Doc: package searches

Permalink

case class SearchDefinition(indexesTypes: IndexesAndTypes) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchDefinition
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SearchDefinition(indexesTypes: IndexesAndTypes)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val _builder: SearchRequestBuilder

    Permalink
  5. def aggregations(first: AggregationDefinition, rest: AggregationDefinition*): SearchDefinition

    Permalink
  6. def aggregations(iterable: Iterable[AggregationDefinition]): SearchDefinition

    Permalink
  7. def aggs(iterable: Iterable[AggregationDefinition]): SearchDefinition

    Permalink
  8. def aggs(first: AggregationDefinition, rest: AggregationDefinition*): SearchDefinition

    Permalink
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def bool(block: ⇒ BoolQueryDefinition): SearchDefinition

    Permalink
  11. def build: SearchRequest

    Permalink
  12. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  14. def explain(enabled: Boolean): SearchDefinition

    Permalink
  15. def extraSource(json: String): SearchDefinition

    Permalink

    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
  16. def fetchSource(fetch: Boolean): SearchDefinition

    Permalink
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def from(i: Int): SearchDefinition

    Permalink
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def highlighting(options: HighlightOptionsDefinition, fields: Iterable[HighlightFieldDefinition]): SearchDefinition

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

    Permalink
  22. def highlighting(fields: Iterable[HighlightFieldDefinition]): SearchDefinition

    Permalink
  23. def highlighting(first: HighlightFieldDefinition, rest: HighlightFieldDefinition*): SearchDefinition

    Permalink
  24. def indexBoost(tuples: (String, Double)*): SearchDefinition

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

    Permalink
  26. val indexesTypes: IndexesAndTypes

    Permalink
  27. def indicesOptions(options: IndicesOptions): SearchDefinition

    Permalink
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def limit(i: Int): SearchDefinition

    Permalink
  30. def matchAll(): SearchDefinition

    Permalink

    Adds a match all query to this search definition

  31. def minScore(min: Double): SearchDefinition.this.type

    Permalink
  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. def postFilter(block: ⇒ QueryDefinition): SearchDefinition.this.type

    Permalink
  36. def preference(pref: String): SearchDefinition

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

    Permalink
  38. def preference(pref: Preference): SearchDefinition

    Permalink
  39. def prefix(tuple: (String, Any)): SearchDefinition

    Permalink

    Adds a single prefix query to this search

    Adds a single prefix query to this search

    tuple

    - the field and prefix value

    returns

    this

  40. def query(block: ⇒ QueryDefinition): SearchDefinition

    Permalink
  41. def query(string: String): SearchDefinition

    Permalink

    Adds a single string query to this search

    Adds a single string query to this search

    string

    the query string

  42. def query2(block: ⇒ QueryBuilder): SearchDefinition

    Permalink
  43. def range(field: String): SearchDefinition

    Permalink
  44. def rawQuery(json: String): SearchDefinition

    Permalink

    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
  45. def regexQuery(field: String, value: Any): SearchDefinition

    Permalink
  46. def regexQuery(tuple: (String, Any)): SearchDefinition

    Permalink
  47. def requestCache(requestCache: Boolean): SearchDefinition.this.type

    Permalink
  48. def rescore(rescorers: RescoreDefinition*): SearchDefinition

    Permalink
  49. def routing(r: String): SearchDefinition

    Permalink
  50. def scriptfields(defs: Iterable[ScriptFieldDefinition]): SearchDefinition.this.type

    Permalink
  51. def scriptfields(defs: ScriptFieldDefinition*): SearchDefinition.this.type

    Permalink

    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

    defs

    zero or more ScriptFieldDefinition instances

    returns

    this, an instance of SearchDefinition

  52. def scroll(keepAlive: String): SearchDefinition

    Permalink
  53. def searchType(searchType: SearchType): SearchDefinition

    Permalink
  54. def size(i: Int): SearchDefinition

    Permalink
  55. def sortBy(sorts: Iterable[SortDefinition[_]]): SearchDefinition

    Permalink
  56. def sortBy(sorts: SortDefinition[_]*): SearchDefinition

    Permalink
  57. def source(json: String): SearchDefinition

    Permalink

    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
  58. def sourceExclude(excludes: Iterable[String]): SearchDefinition.this.type

    Permalink
  59. def sourceExclude(first: String, rest: String*): SearchDefinition.this.type

    Permalink
  60. def sourceFiltering(includes: Iterable[String], excludes: Iterable[String]): SearchDefinition.this.type

    Permalink
  61. def sourceInclude(includes: Iterable[String]): SearchDefinition.this.type

    Permalink
  62. def sourceInclude(first: String, rest: String*): SearchDefinition.this.type

    Permalink
  63. def start(i: Int): SearchDefinition

    Permalink
  64. def stats(groups: String*): SearchDefinition.this.type

    Permalink
  65. def storedFields(fields: Iterable[String]): SearchDefinition

    Permalink
  66. def storedFields(first: String, rest: String*): SearchDefinition

    Permalink
  67. var suggest: SuggestBuilder

    Permalink
  68. def suggestion(suggestion: SuggestionDefinition): SearchDefinition

    Permalink
  69. def suggestions(suggs: Iterable[SuggestionDefinition]): SearchDefinition

    Permalink
  70. def suggestions(first: SuggestionDefinition, rest: SuggestionDefinition*): SearchDefinition

    Permalink

    Adds a new suggestion to the search request, which can be looked up in the response using the name provided.

  71. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  72. def termQuery(field: String, value: Any): SearchDefinition

    Permalink
  73. def termQuery(tuple: (String, Any)): SearchDefinition

    Permalink
  74. def terminateAfter(terminateAfter: Int): SearchDefinition

    Permalink
  75. def timeout(duration: FiniteDuration): SearchDefinition.this.type

    Permalink
  76. def toString(): String

    Permalink
    Definition Classes
    SearchDefinition → AnyRef → Any
  77. def trackScores(enabled: Boolean): SearchDefinition

    Permalink
  78. def types(types: String*): SearchDefinition

    Permalink
  79. def version(enabled: Boolean): SearchDefinition

    Permalink
  80. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def fields(fields: String*): SearchDefinition

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.0) Renamed to storedFields

  2. def fuzzy(tuple: (String, Any)): SearchDefinition

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.0) Set fuzzy query using query(fuzzyQuery(...)) syntax

  3. def regex(tuple: (String, Any)): SearchDefinition

    Permalink

    Adds a single regex query to this search

    Adds a single regex query to this search

    tuple

    - the field and regex value

    returns

    this

    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.0) use regexQuery(...)

  4. def sort(sorts: SortDefinition[_]*): SearchDefinition

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.0) use sortBy

  5. def term(field: String, value: Any): SearchDefinition

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.0) use termQuery()

  6. def term(tuple: (String, Any)): SearchDefinition

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.0) use termQuery()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped