Class NodesInfoDescriptor

Descriptor for Info

https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

Inheritance
object
RequestBase<NodesInfoRequestParameters>
RequestDescriptorBase<NodesInfoDescriptor, NodesInfoRequestParameters, INodesInfoRequest>
NodesInfoDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class NodesInfoDescriptor : RequestDescriptorBase<NodesInfoDescriptor, NodesInfoRequestParameters, INodesInfoRequest>, IDescriptor, INodesInfoRequest, IRequest<NodesInfoRequestParameters>, IRequest

Constructors

| Edit this page View Source

NodesInfoDescriptor()

/_nodes

Declaration
public NodesInfoDescriptor()
| Edit this page View Source

NodesInfoDescriptor(Metrics)

/_nodes/{metric}

Declaration
public NodesInfoDescriptor(Metrics metric)
Parameters
Type Name Description
Metrics metric

Optional, accepts null
| Edit this page View Source

NodesInfoDescriptor(NodeIds)

/_nodes/{node_id}

Declaration
public NodesInfoDescriptor(NodeIds nodeId)
Parameters
Type Name Description
NodeIds nodeId

Optional, accepts null
| Edit this page View Source

NodesInfoDescriptor(NodeIds, Metrics)

/_nodes/{node_id}/{metric}

Declaration
public NodesInfoDescriptor(NodeIds nodeId, Metrics metric)
Parameters
Type Name Description
NodeIds nodeId

Optional, accepts null
Metrics metric

Optional, accepts null

Methods

| Edit this page View Source

FlatSettings(bool?)

When true, returns settings in flat format.

Declaration
public NodesInfoDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
NodesInfoDescriptor
| Edit this page View Source

Metric(Metrics)

Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

Declaration
public NodesInfoDescriptor Metric(Metrics metric)
Parameters
Type Name Description
Metrics metric
Returns
Type Description
NodesInfoDescriptor
| Edit this page View Source

NodeId(NodeIds)

A comma-separated list of node IDs or names used to limit returned information.

Declaration
public NodesInfoDescriptor NodeId(NodeIds nodeId)
Parameters
Type Name Description
NodeIds nodeId
Returns
Type Description
NodesInfoDescriptor
| Edit this page View Source

Timeout(Time)

The amount of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
public NodesInfoDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
NodesInfoDescriptor

Implements

Extension Methods