Class AggregateSortBy

Sort by predicate for an aggregation.

Inheritance

System.Object

AggregateSortBy

Implements

IAggregationPredicate

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Redis.OM.Aggregation.AggregationPredicates

Assembly: Redis.OM.dll

Syntax

public class AggregateSortBy : IAggregationPredicate

Constructors

| Improve this Doc View Source

AggregateSortBy(String, SortDirection, Nullable<Int32>)

Initializes a new instance of the AggregateSortBy class.

Declaration

public AggregateSortBy(string property, SortDirection direction, int? max = null)

Parameters

Type	Name	Description
System.String	property	property to sort by.
SortDirection	direction	direction to sort by.
System.Nullable<System.Int32>	max	maximum number of records to pull.

Properties

| Improve this Doc View Source

Direction

Gets or sets direction to sort.

Declaration

public SortDirection Direction { get; set; }

Property Value

Type	Description
SortDirection

| Improve this Doc View Source

Max

Gets or sets maximum number of elements.

Declaration

public int? Max { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

Property

Gets or sets property to sort by.

Declaration

public string Property { get; set; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

Serialize()

Serializes the predicate.

Declaration

public IEnumerable<string> Serialize()

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	An array of string arguments for an aggregation.

Implements

IAggregationPredicate