case class DateRangeQuery(start: Option[String] = None, inclusiveStart: Option[Boolean] = None, end: Option[String] = None, inclusiveEnd: Option[Boolean] = None, dateTimeParser: Option[String] = 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 dates. At least one bound is required.

Datetimes can be provided as RFC3339 compliant strings in UTC timezone only, or more conveniently as an Instant.

Since

1.0.0

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

Instance Constructors

  1. new DateRangeQuery(start: Option[String] = None, inclusiveStart: Option[Boolean] = None, end: Option[String] = None, inclusiveEnd: Option[Boolean] = None, dateTimeParser: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def boost(boost: Double): DateRangeQuery

    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

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def dateTimeParser(dateTimeParser: String): DateRangeQuery

    The name of the Instant/time parser to use to interpret start and end.

    The name of the Instant/time parser to use to interpret start and end. Should not be modified when passing in Instant.

  8. def end(end: Instant): DateRangeQuery

    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.

  9. def end(end: Instant, inclusive: Boolean): DateRangeQuery

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

  10. def end(end: String): DateRangeQuery

    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.

  11. def end(end: String, inclusive: Boolean): DateRangeQuery

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

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def field(field: String): DateRangeQuery

    If specified, only this field will be matched.

    If specified, only this field will be matched.

    returns

    a copy of this, for chaining

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def start(start: Instant): DateRangeQuery

    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.

  21. def start(start: Instant, inclusive: Boolean): DateRangeQuery

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

  22. def start(start: String): DateRangeQuery

    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.

  23. def start(start: String, inclusive: Boolean): DateRangeQuery

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

  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String

    returns

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

    Definition Classes
    SearchQuery → AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SearchQuery

Inherited from AnyRef

Inherited from Any

Ungrouped