sealed trait SortByField extends Sort with HasFormat[SortByField] with HasMissing[SortByField] with HasMode[SortByField] with HasNumericType[SortByField] with HasOrder[SortByField] with HasUnmappedType[SortByField]
- Alphabetic
- By Inheritance
- SortByField
- HasUnmappedType
- HasOrder
- HasNumericType
- HasMode
- HasMissing
- HasFormat
- Sort
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def format(value: String): SortByField
Sets the date format for the zio.elasticsearch.query.sort.SortByField.
Sets the date format for the zio.elasticsearch.query.sort.SortByField. This method is only applicable to fields of type
date
.- value
the
date
format to set- returns
an instance of the zio.elasticsearch.query.sort.SortByField enriched with the
format
parameter.
- Definition Classes
- HasFormat
- abstract def missing(value: Missing): SortByField
Sets the value to use when a document is missing a value for the field being sorted.
Sets the value to use when a document is missing a value for the field being sorted.
- value
the
missing
value behaviour- Missing.First: treated as first
- Missing.Last: treated as last
- returns
an instance of the zio.elasticsearch.query.sort.SortByField enriched with the
missing
parameter.
- Definition Classes
- HasMissing
- abstract def mode(value: SortMode): SortByField
Sets the
mode
parameter for the zio.elasticsearch.query.sort.Sort.Sets the
mode
parameter for the zio.elasticsearch.query.sort.Sort. Themode
parameter controls how Elasticsearch selects a single value from a set of sorted documents. The defaultmode
isAverage
.- 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
mode
parameter.
- Definition Classes
- HasMode
- abstract def numericType(value: NumericType): SortByField
Sets the
numeric type
that should be used for sorting the field.Sets the
numeric type
that should be used for sorting the field. Withnumeric type
it is possible to cast the values from one type to another.- value
the NumericType that should be used for sorting the field
- NumericType.Date: converts values to Date
- NumericType.DateNanos: converts values to DateNanos
- NumericType.Double: converts values to Double
- NumericType.Long: converts values to Long
- returns
an instance of the zio.elasticsearch.query.sort.SortByField enriched with the
numeric type
parameter.
- Definition Classes
- HasNumericType
- abstract def order(value: SortOrder): SortByField
Sets the
sort order
of the field.Sets the
sort order
of 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 order
parameter.
- Definition Classes
- HasOrder
- abstract def unmappedType(value: String): SortByField
Sets the
unmapped type
which is used when the mapped field doesn't exist in the index.Sets the
unmapped type
which is used when the mapped field doesn't exist in the index.- value
the type to use when the mapped field doesn't exist in the index
- returns
an instance of the zio.elasticsearch.query.sort.SortByField enriched with the
unmapped type
parameter.
- Definition Classes
- HasUnmappedType
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])