Search Results for

    Show / Hide Table of Contents

    Class SortDescriptorBase<TDescriptor, TInterface, T>

    Inheritance
    object
    DescriptorBase<TDescriptor, TInterface>
    SortDescriptorBase<TDescriptor, TInterface, T>
    FieldSortDescriptor<T>
    GeoDistanceSortDescriptor<T>
    ScriptSortDescriptor<T>
    Implements
    IDescriptor
    ISort
    Inherited Members
    DescriptorBase<TDescriptor, TInterface>.Self
    DescriptorBase<TDescriptor, TInterface>.Assign<TValue>(TValue, Action<TInterface, TValue>)
    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 abstract class SortDescriptorBase<TDescriptor, TInterface, T> : DescriptorBase<TDescriptor, TInterface>, IDescriptor, ISort where TDescriptor : SortDescriptorBase<TDescriptor, TInterface, T>, TInterface, ISort where TInterface : class, ISort where T : class
    Type Parameters
    Name Description
    TDescriptor
    TInterface
    T

    Properties

    | Edit this page View Source

    SortKey

    The field on which to sort

    Declaration
    protected abstract Field SortKey { get; }
    Property Value
    Type Description
    Field

    Methods

    | Edit this page View Source

    Ascending()

    Sorts by ascending sort order

    Declaration
    public virtual TDescriptor Ascending()
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Descending()

    Sorts by descending sort order

    Declaration
    public virtual TDescriptor Descending()
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Missing(object)

    Specifies how documents which are missing the sort field should be treated.

    Declaration
    public virtual TDescriptor Missing(object value)
    Parameters
    Type Name Description
    object value
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    MissingFirst()

    Specifies that documents which are missing the sort field should be ordered first

    Declaration
    public virtual TDescriptor MissingFirst()
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    MissingLast()

    Specifies that documents which are missing the sort field should be ordered last

    Declaration
    public virtual TDescriptor MissingLast()
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Mode(SortMode?)

    Controls what collection value is picked for sorting a document when the field is a collection

    Declaration
    public virtual TDescriptor Mode(SortMode? mode)
    Parameters
    Type Name Description
    SortMode? mode
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Nested(Func<NestedSortDescriptor<T>, INestedSort>)

    Specifies the path and filter to apply when sorting on a nested field

    Declaration
    public virtual TDescriptor Nested(Func<NestedSortDescriptor<T>, INestedSort> selector)
    Parameters
    Type Name Description
    Func<NestedSortDescriptor<T>, INestedSort> selector
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    NumericType(NumericType?)

    Set a single resolution for the sort

    Declaration
    public virtual TDescriptor NumericType(NumericType? numericType)
    Parameters
    Type Name Description
    NumericType? numericType
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Order(SortOrder?)

    Controls the order of sorting

    Declaration
    public virtual TDescriptor Order(SortOrder? order)
    Parameters
    Type Name Description
    SortOrder? order
    Returns
    Type Description
    TDescriptor

    Implements

    IDescriptor
    ISort

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • SortKey
    • Methods
      • Ascending()
      • Descending()
      • Missing(object)
      • MissingFirst()
      • MissingLast()
      • Mode(SortMode?)
      • Nested(Func<NestedSortDescriptor<T>, INestedSort>)
      • NumericType(NumericType?)
      • Order(SortOrder?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX