Class SortingSettings

Inheritance

object

SortingSettings

Implements

ISortingSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class SortingSettings : ISortingSettings

Properties

Fields

The list of fields used to sort the index. Only boolean, numeric, date and keyword fields with doc_values are allowed here.

Declaration

public Fields Fields { get; set; }

Property Value

Type	Description
Fields

Missing

The missing parameter specifies how docs which are missing the field should be treated. The missing value can have the following values: Last: Documents without value for the field are sorted last. First: Documents without value for the field are sorted first.

Declaration

public IndexSortMissing[] Missing { get; set; }

Property Value

Type	Description
IndexSortMissing[]

Mode

The mode option controls what value, from a multi-value field, is picked to sort the document. The mode option can have the following values: Minimum: Pick the lowest value. Maximum: Pick the highest value.

Declaration

public IndexSortMode[] Mode { get; set; }

Property Value

Type	Description
IndexSortMode[]

Order

The sort order to use for each field. The order option can have the following values: Ascending and Descending.

Declaration

public IndexSortOrder[] Order { get; set; }

Property Value

Type	Description
IndexSortOrder[]

Implements

ISortingSettings

Extension Methods

SuffixExtensions.Suffix(object, string)