Class TopHitsAggregationDescriptor<T>

Inheritance
object
DescriptorBase<TopHitsAggregationDescriptor<T>, ITopHitsAggregation>
MetricAggregationDescriptorBase<TopHitsAggregationDescriptor<T>, ITopHitsAggregation, T>
TopHitsAggregationDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class TopHitsAggregationDescriptor<T> : MetricAggregationDescriptorBase<TopHitsAggregationDescriptor<T>, ITopHitsAggregation, T>, IDescriptor, ITopHitsAggregation, IMetricAggregation, IAggregation where T : class
Type Parameters
Name Description
T

Methods

| Edit this page View Source

DocValueFields(Fields)

Declaration
public TopHitsAggregationDescriptor<T> DocValueFields(Fields fields)
Parameters
Type Name Description
Fields fields
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

DocValueFields(Func<FieldsDescriptor<T>, IPromise<Fields>>)

Declaration
public TopHitsAggregationDescriptor<T> DocValueFields(Func<FieldsDescriptor<T>, IPromise<Fields>> fields)
Parameters
Type Name Description
Func<FieldsDescriptor<T>, IPromise<Fields>> fields
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

Explain(bool?)

Declaration
public TopHitsAggregationDescriptor<T> Explain(bool? explain = true)
Parameters
Type Name Description
bool? explain
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

From(int?)

Declaration
public TopHitsAggregationDescriptor<T> From(int? from)
Parameters
Type Name Description
int? from
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

Highlight(Func<HighlightDescriptor<T>, IHighlight>)

Declaration
public TopHitsAggregationDescriptor<T> Highlight(Func<HighlightDescriptor<T>, IHighlight> highlightSelector)
Parameters
Type Name Description
Func<HighlightDescriptor<T>, IHighlight> highlightSelector
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

ScriptFields(Func<ScriptFieldsDescriptor, IPromise<IScriptFields>>)

Declaration
public TopHitsAggregationDescriptor<T> ScriptFields(Func<ScriptFieldsDescriptor, IPromise<IScriptFields>> scriptFieldsSelector)
Parameters
Type Name Description
Func<ScriptFieldsDescriptor, IPromise<IScriptFields>> scriptFieldsSelector
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

Size(int?)

Declaration
public TopHitsAggregationDescriptor<T> Size(int? size)
Parameters
Type Name Description
int? size
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

Sort(Func<SortDescriptor<T>, IPromise<IList<ISort>>>)

Declaration
public TopHitsAggregationDescriptor<T> Sort(Func<SortDescriptor<T>, IPromise<IList<ISort>>> sortSelector)
Parameters
Type Name Description
Func<SortDescriptor<T>, IPromise<IList<ISort>>> sortSelector
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

Source(Func<SourceFilterDescriptor<T>, ISourceFilter>)

Declaration
public TopHitsAggregationDescriptor<T> Source(Func<SourceFilterDescriptor<T>, ISourceFilter> selector)
Parameters
Type Name Description
Func<SourceFilterDescriptor<T>, ISourceFilter> selector
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

Source(bool?)

Declaration
public TopHitsAggregationDescriptor<T> Source(bool? enabled = true)
Parameters
Type Name Description
bool? enabled
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

StoredFields(Func<FieldsDescriptor<T>, IPromise<Fields>>)

Declaration
public TopHitsAggregationDescriptor<T> StoredFields(Func<FieldsDescriptor<T>, IPromise<Fields>> fields)
Parameters
Type Name Description
Func<FieldsDescriptor<T>, IPromise<Fields>> fields
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

TrackScores(bool?)

Declaration
public TopHitsAggregationDescriptor<T> TrackScores(bool? trackScores = true)
Parameters
Type Name Description
bool? trackScores
Returns
Type Description
TopHitsAggregationDescriptor<T>
| Edit this page View Source

Version(bool?)

Declaration
public TopHitsAggregationDescriptor<T> Version(bool? version = true)
Parameters
Type Name Description
bool? version
Returns
Type Description
TopHitsAggregationDescriptor<T>

Implements

Extension Methods