Class GetSearchRelevanceStatsDescriptor

Descriptor for GetStats

Inheritance
object
RequestBase<GetStatsRequestParameters>
RequestDescriptorBase<GetSearchRelevanceStatsDescriptor, GetStatsRequestParameters, IGetSearchRelevanceStatsRequest>
GetSearchRelevanceStatsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetSearchRelevanceStatsDescriptor : RequestDescriptorBase<GetSearchRelevanceStatsDescriptor, GetStatsRequestParameters, IGetSearchRelevanceStatsRequest>, IDescriptor, IGetSearchRelevanceStatsRequest, IRequest<GetStatsRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetSearchRelevanceStatsDescriptor()

/_plugins/_search_relevance/stats

Declaration
public GetSearchRelevanceStatsDescriptor()
| Edit this page View Source

GetSearchRelevanceStatsDescriptor(Name)

/_plugins/_search_relevance/stats/{stat}

Declaration
public GetSearchRelevanceStatsDescriptor(Name stat)
Parameters
Type Name Description
Name stat

Optional, accepts null

Methods

| Edit this page View Source

FlatStatPaths(string)

Requests flattened stat paths as keys.

Declaration
public GetSearchRelevanceStatsDescriptor FlatStatPaths(string flatstatpaths)
Parameters
Type Name Description
string flatstatpaths
Returns
Type Description
GetSearchRelevanceStatsDescriptor
| Edit this page View Source

IncludeAllNodes(string)

Whether to include all nodes.

Declaration
public GetSearchRelevanceStatsDescriptor IncludeAllNodes(string includeallnodes)
Parameters
Type Name Description
string includeallnodes
Returns
Type Description
GetSearchRelevanceStatsDescriptor
| Edit this page View Source

IncludeIndividualNodes(string)

Whether to include individual nodes.

Declaration
public GetSearchRelevanceStatsDescriptor IncludeIndividualNodes(string includeindividualnodes)
Parameters
Type Name Description
string includeindividualnodes
Returns
Type Description
GetSearchRelevanceStatsDescriptor
| Edit this page View Source

IncludeInfo(string)

Whether to include info.

Declaration
public GetSearchRelevanceStatsDescriptor IncludeInfo(string includeinfo)
Parameters
Type Name Description
string includeinfo
Returns
Type Description
GetSearchRelevanceStatsDescriptor
| Edit this page View Source

IncludeMetadata(string)

Whether to include metadata.

Declaration
public GetSearchRelevanceStatsDescriptor IncludeMetadata(string includemetadata)
Parameters
Type Name Description
string includemetadata
Returns
Type Description
GetSearchRelevanceStatsDescriptor
| Edit this page View Source

Stat(Name)

The statistic to return.

Declaration
public GetSearchRelevanceStatsDescriptor Stat(Name stat)
Parameters
Type Name Description
Name stat
Returns
Type Description
GetSearchRelevanceStatsDescriptor

Implements

Extension Methods