Packages

sealed trait SortByField extends Sort with HasFormat[SortByField] with HasMissing[SortByField] with HasMode[SortByField] with HasNumericType[SortByField] with HasOrder[SortByField] with HasUnmappedType[SortByField]

Linear Supertypes
HasUnmappedType[SortByField], HasOrder[SortByField], HasNumericType[SortByField], HasMode[SortByField], HasMissing[SortByField], HasFormat[SortByField], Sort, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SortByField
  2. HasUnmappedType
  3. HasOrder
  4. HasNumericType
  5. HasMode
  6. HasMissing
  7. HasFormat
  8. Sort
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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
  2. 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

    returns

    an instance of the zio.elasticsearch.query.sort.SortByField enriched with the missing parameter.

    Definition Classes
    HasMissing
  3. 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. The mode parameter controls how Elasticsearch selects a single value from a set of sorted documents. The default mode is Average.

    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
  4. 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. With numeric type it is possible to cast the values from one type to another.

    value

    the NumericType that should be used for sorting the field

    returns

    an instance of the zio.elasticsearch.query.sort.SortByField enriched with the numeric type parameter.

    Definition Classes
    HasNumericType
  5. 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

    returns

    an instance of the zio.elasticsearch.query.sort.Sort enriched with the sort order parameter.

    Definition Classes
    HasOrder
  6. 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

  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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from HasUnmappedType[SortByField]

Inherited from HasOrder[SortByField]

Inherited from HasNumericType[SortByField]

Inherited from HasMode[SortByField]

Inherited from HasMissing[SortByField]

Inherited from HasFormat[SortByField]

Inherited from Sort

Inherited from AnyRef

Inherited from Any

Ungrouped