sealed trait SortByScript extends Sort with HasMode[SortByScript] with HasOrder[SortByScript]
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- SortByScript
- HasOrder
- HasMode
- Sort
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Abstract Value Members
- abstract def mode(value: SortMode): SortByScript
Sets the
modeparameter for the zio.elasticsearch.query.sort.Sort.Sets the
modeparameter for the zio.elasticsearch.query.sort.Sort. Themodeparameter controls how Elasticsearch selects a single value from a set of sorted documents. The defaultmodeisAverage.- value
the SortMode used to pick a value among the sorted set of documents:
- SortMode.Avg: uses the average of all values as sort value. Only applicable for number based array fields
- SortMode.Max: picks the highest value
- SortMode.Median: uses the median of all values as sort value. Only applicable for number based array fields
- SortMode.Min: picks the lowest value
- SortMode.Sum: uses the sum of all values as sort value. Only applicable for number based array fields
- returns
an instance of the zio.elasticsearch.query.sort.Sort enriched with the
modeparameter.
- Definition Classes
- HasMode
- abstract def order(value: SortOrder): SortByScript
Sets the
sort orderof the field.Sets the
sort orderof the field.- value
the SortOrder of the field
- SortOrder.Asc: sets ascending sorting order
- SortOrder.Desc: sets descending sorting order
- returns
an instance of the zio.elasticsearch.query.sort.Sort enriched with the
sort orderparameter.
- Definition Classes
- HasOrder
Concrete 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])