Class CompositeAggregationSourceDescriptorBase<TDescriptor, TInterface, T>

A values source for ICompositeAggregation

Inheritance
object
DescriptorBase<TDescriptor, TInterface>
CompositeAggregationSourceDescriptorBase<TDescriptor, TInterface, T>
DateHistogramCompositeAggregationSourceDescriptor<T>
GeoTileGridCompositeAggregationSourceDescriptor<T>
HistogramCompositeAggregationSourceDescriptor<T>
TermsCompositeAggregationSourceDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public abstract class CompositeAggregationSourceDescriptorBase<TDescriptor, TInterface, T> : DescriptorBase<TDescriptor, TInterface>, IDescriptor, ICompositeAggregationSource where TDescriptor : CompositeAggregationSourceDescriptorBase<TDescriptor, TInterface, T>, TInterface where TInterface : class, ICompositeAggregationSource
Type Parameters
Name Description
TDescriptor
TInterface
T

Constructors

| Edit this page View Source

CompositeAggregationSourceDescriptorBase(string, string)

Declaration
protected CompositeAggregationSourceDescriptorBase(string name, string sourceType)
Parameters
Type Name Description
string name
string sourceType

Methods

| Edit this page View Source

Field(Field)

The field from which to extract value

Declaration
public TDescriptor Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
TDescriptor
| Edit this page View Source

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

The field from which to extract value

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

MissingBucket(bool?)

By default documents without a value for a given source are ignored. It is possible to include them in the response as null by setting this to true

Declaration
public TDescriptor MissingBucket(bool? includeMissing = true)
Parameters
Type Name Description
bool? includeMissing
Returns
Type Description
TDescriptor
| Edit this page View Source

Order(SortOrder?)

Defines the direction of sorting for each value source. Defaults to Ascending

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

Implements

Extension Methods