Class GetNodeStatsDescriptor

Descriptor for GetNodeStats

Inheritance
object
RequestBase<GetNodeStatsRequestParameters>
RequestDescriptorBase<GetNodeStatsDescriptor, GetNodeStatsRequestParameters, IGetNodeStatsRequest>
GetNodeStatsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetNodeStatsDescriptor : RequestDescriptorBase<GetNodeStatsDescriptor, GetNodeStatsRequestParameters, IGetNodeStatsRequest>, IDescriptor, IGetNodeStatsRequest, IRequest<GetNodeStatsRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetNodeStatsDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected GetNodeStatsDescriptor()
| Edit this page View Source

GetNodeStatsDescriptor(Name)

/_plugins/_search_relevance/{node_id}/stats

Declaration
public GetNodeStatsDescriptor(Name nodeId)
Parameters
Type Name Description
Name nodeId

this parameter is required
| Edit this page View Source

GetNodeStatsDescriptor(Name, Name)

/_plugins/_search_relevance/{node_id}/stats/{stat}

Declaration
public GetNodeStatsDescriptor(Name nodeId, Name stat)
Parameters
Type Name Description
Name nodeId

this parameter is required
Name stat

Optional, accepts null

Methods

| Edit this page View Source

FlatStatPaths(string)

Requests flattened stat paths as keys.

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

IncludeAllNodes(string)

Whether to include all nodes.

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

IncludeIndividualNodes(string)

Whether to include individual nodes.

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

IncludeInfo(string)

Whether to include info.

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

IncludeMetadata(string)

Whether to include metadata.

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

Stat(Name)

The statistic to return.

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

Implements

Extension Methods