Class InnerHitsDescriptor<T>

Inheritance
object
DescriptorBase<InnerHitsDescriptor<T>, IInnerHits>
InnerHitsDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
[DataContract]
public class InnerHitsDescriptor<T> : DescriptorBase<InnerHitsDescriptor<T>, IInnerHits>, IDescriptor, IInnerHits where T : class
Type Parameters
Name Description
T

Methods

| Edit this page View Source

Collapse(Func<FieldCollapseDescriptor<T>, IFieldCollapse>)

Provides a second level of collapsing, NOTE: OpenSearch only supports collapsing up to two levels.

Declaration
public InnerHitsDescriptor<T> Collapse(Func<FieldCollapseDescriptor<T>, IFieldCollapse> collapseSelector)
Parameters
Type Name Description
Func<FieldCollapseDescriptor<T>, IFieldCollapse> collapseSelector
Returns
Type Description
InnerHitsDescriptor<T>
| Edit this page View Source

DocValueFields(Fields)

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

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

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

Explain(bool?)

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

From(int?)

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

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

Allow to highlight search results on one or more fields. The implementation uses the either lucene fast-vector-highlighter or highlighter.

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

IgnoreUnmapped(bool?)

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

Name(string)

Declaration
public InnerHitsDescriptor<T> Name(string name)
Parameters
Type Name Description
string name
Returns
Type Description
InnerHitsDescriptor<T>
| Edit this page View Source

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

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

Size(int?)

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

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

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

Source(bool)

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

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

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

Version(bool?)

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

Implements

Extension Methods