Class SortProcessorDescriptor<T>

Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings and numbers will be sorted lexicographically.

Inheritance
object
DescriptorBase<SortProcessorDescriptor<T>, ISortProcessor>
ProcessorDescriptorBase<SortProcessorDescriptor<T>, ISortProcessor>
SortProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SortProcessorDescriptor<T> : ProcessorDescriptorBase<SortProcessorDescriptor<T>, ISortProcessor>, IDescriptor, ISortProcessor, IProcessor where T : class
Type Parameters
Name Description
T

Properties

| Edit this page View Source

Name

Declaration
protected override string Name { get; }
Property Value
Type Description
string
Overrides

Methods

| Edit this page View Source

Field(Field)

The field to be sorted

Declaration
public SortProcessorDescriptor<T> Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
SortProcessorDescriptor<T>
| Edit this page View Source

Field<TValue>(Expression<Func<T, TValue>>)

The field to be sorted

Declaration
public SortProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
SortProcessorDescriptor<T>
Type Parameters
Name Description
TValue
| Edit this page View Source

Order(SortOrder?)

The sort order to use. Default is ascending.

Declaration
public SortProcessorDescriptor<T> Order(SortOrder? order = SortOrder.Ascending)
Parameters
Type Name Description
SortOrder? order
Returns
Type Description
SortProcessorDescriptor<T>
| Edit this page View Source

TargetField(Field)

The field to assign the sorted value to, by default field is updated in-place

Declaration
public SortProcessorDescriptor<T> TargetField(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
SortProcessorDescriptor<T>
| Edit this page View Source

TargetField(Expression<Func<T, object>>)

The field to assign the sorted value to, by default field is updated in-place

Declaration
public SortProcessorDescriptor<T> TargetField(Expression<Func<T, object>> objectPath)
Parameters
Type Name Description
Expression<Func<T, object>> objectPath
Returns
Type Description
SortProcessorDescriptor<T>

Implements

Extension Methods