Interface INestedSort

Sort on a field inside one or more nested objects.

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public interface INestedSort

Properties

Filter

A filter that the inner objects inside the nested path should match with in order for its field values to be taken into account by sorting. A common pattern is to repeat the query/filter inside the nested filter or query. By default no nested filter is active.

Declaration

[DataMember(Name = "filter")]
QueryContainer Filter { get; set; }

Property Value

Type	Description
QueryContainer

MaxChildren

The maximum number of children to consider per root document when picking the sort value. Defaults to unlimited.

Declaration

[DataMember(Name = "max_children")]
int? MaxChildren { get; set; }

Property Value

Type	Description
int?

Nested

Same as top-level nested, but applies to another nested path within the current nested object.

Declaration

[DataMember(Name = "nested")]
INestedSort Nested { get; set; }

Property Value

Type	Description
INestedSort

Path

Defines on which nested object to sort. The actual sort field must be a direct field inside this nested object. When sorting by nested field, this field is mandatory.

Declaration

[DataMember(Name = "path")]
Field Path { get; set; }

Property Value

Type	Description
Field

Extension Methods

SuffixExtensions.Suffix(object, string)