Class NestedPropertyDescriptor<TParent, TChild>

A specialised version of the IObjectProperty datatype that allows arrays of objects to be indexed in a way that they can be queried independently of each other, using nested queries and aggregations.

Inheritance
object
DescriptorBase<NestedPropertyDescriptor<TParent, TChild>, INestedProperty>
PropertyDescriptorBase<NestedPropertyDescriptor<TParent, TChild>, INestedProperty, TParent>
CorePropertyDescriptorBase<NestedPropertyDescriptor<TParent, TChild>, INestedProperty, TParent>
ObjectPropertyDescriptorBase<NestedPropertyDescriptor<TParent, TChild>, INestedProperty, TParent, TChild>
NestedPropertyDescriptor<TParent, TChild>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class NestedPropertyDescriptor<TParent, TChild> : ObjectPropertyDescriptorBase<NestedPropertyDescriptor<TParent, TChild>, INestedProperty, TParent, TChild>, IDescriptor, INestedProperty, IObjectProperty, ICoreProperty, IProperty, IFieldMapping where TParent : class where TChild : class
Type Parameters
Name Description
TParent
TChild

Constructors

| Edit this page View Source

NestedPropertyDescriptor()

Declaration
public NestedPropertyDescriptor()

Methods

| Edit this page View Source

IncludeInParent(bool?)

Whether to also index nested objects as flattened values on the parent document.

Declaration
public NestedPropertyDescriptor<TParent, TChild> IncludeInParent(bool? includeInParent = true)
Parameters
Type Name Description
bool? includeInParent
Returns
Type Description
NestedPropertyDescriptor<TParent, TChild>
| Edit this page View Source

IncludeInRoot(bool?)

Whether to also index nested objects as flattened values on the root document.

Declaration
public NestedPropertyDescriptor<TParent, TChild> IncludeInRoot(bool? includeInRoot = true)
Parameters
Type Name Description
bool? includeInRoot
Returns
Type Description
NestedPropertyDescriptor<TParent, TChild>

Implements

Extension Methods