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
- Alphabetic
- By Inheritance
- TermRangeQuery
- Serializable
- Serializable
- Product
- Equals
- SearchQuery
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- 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
-
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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
-
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
-
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
-
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- returns
the String representation of the FTS query, which is its JSON representation without global parameters.
- Definition Classes
- SearchQuery → AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated