case class TermRangeQuery(min: Option[String] = None, inclusiveMin: Option[Boolean] = None, max: Option[String] = None, inclusiveMax: Option[Boolean] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable

An FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.

At least one of min and max must be provided.

Since

1.0.0

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

Instance Constructors

  1. new TermRangeQuery(min: Option[String] = None, inclusiveMin: Option[Boolean] = None, max: Option[String] = None, inclusiveMax: Option[Boolean] = None, field: Option[String] = None, boost: Option[Double] = None)

Value Members

  1. def boost(boost: Double): TermRangeQuery

    The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight (with a boost between 0 and 1)

    The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight (with a boost between 0 and 1)

    boost

    the boost parameter, which must be >= 0

    returns

    a copy of this, for chaining

  2. def field(field: String): TermRangeQuery

    If specified, only this field will be matched.

    If specified, only this field will be matched.

    returns

    a copy of this, for chaining

  3. def max(max: String): TermRangeQuery

    Sets the upper boundary of the range.

    Sets the upper boundary of the range. The upper boundary is considered exclusive by default on the server side.

    returns

    a copy of this, for chaining

  4. def max(max: String, inclusive: Boolean): TermRangeQuery

    Sets the upper boundary of the range, inclusive or not depending on the second parameter.

    Sets the upper boundary of the range, inclusive or not depending on the second parameter.

    returns

    a copy of this, for chaining

  5. def min(min: String): TermRangeQuery

    Sets the lower boundary of the range.

    Sets the lower boundary of the range. The lower boundary is considered inclusive by default on the server side.

    returns

    a copy of this, for chaining

  6. def min(min: String, inclusive: Boolean): TermRangeQuery

    Sets the lower boundary of the range, inclusive or not depending on the second parameter.

    Sets the lower boundary of the range, inclusive or not depending on the second parameter.

    returns

    a copy of this, for chaining

  7. def toString(): String

    returns

    the String representation of the FTS query, which is its JSON representation without global parameters.

    Definition Classes
    SearchQuery → AnyRef → Any