Class NodesUsageDescriptor

Descriptor for Usage

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<NodesUsageRequestParameters>
RequestDescriptorBase<NodesUsageDescriptor, NodesUsageRequestParameters, INodesUsageRequest>
NodesUsageDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class NodesUsageDescriptor : RequestDescriptorBase<NodesUsageDescriptor, NodesUsageRequestParameters, INodesUsageRequest>, IDescriptor, INodesUsageRequest, IRequest<NodesUsageRequestParameters>, IRequest

Constructors

| Edit this page View Source

NodesUsageDescriptor()

/_nodes/usage

Declaration
public NodesUsageDescriptor()
| Edit this page View Source

NodesUsageDescriptor(Metrics)

/_nodes/usage/{metric}

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

Optional, accepts null
| Edit this page View Source

NodesUsageDescriptor(NodeIds)

/_nodes/{node_id}/usage

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

Optional, accepts null
| Edit this page View Source

NodesUsageDescriptor(NodeIds, Metrics)

/_nodes/{node_id}/usage/{metric}

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

Optional, accepts null
Metrics metric

Optional, accepts null

Methods

| Edit this page View Source

Metric(Metrics)

Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

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

NodeId(NodeIds)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

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

Timeout(Time)

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

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

Implements

Extension Methods