NodesUsageRequest (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.nodes.NodesUsageRequest

```
public class NodesUsageRequest
extends RequestBase
```
Returns low-level information about REST actions usage on nodes.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class NodesUsageRequest.Builder
Builder for NodesUsageRequest.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
  RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type Field Description

static Endpoint<NodesUsageRequest,NodesUsageResponse,ErrorResponse> _ENDPOINT
Endpoint "nodes.usage".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<java.lang.String>`	`metric()`	Limit the information returned to the specified metrics
`java.util.List<java.lang.String>`	`nodeId()`	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
`static NodesUsageRequest`	`of(java.util.function.Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)`
`Time`	`timeout()`	Explicit operation timeout

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _ENDPOINT
```
public static final Endpoint<NodesUsageRequest,NodesUsageResponse,ErrorResponse> _ENDPOINT
```
    Endpoint "nodes.usage".
- Method Detail
  - of
```
public static NodesUsageRequest of(java.util.function.Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)
```
  - metric
```
public final java.util.List<java.lang.String> metric()
```
    Limit the information returned to the specified metrics
    API name: metric
  - nodeId
```
public final java.util.List<java.lang.String> nodeId()
```
    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
    API name: node_id
  - timeout
```
@Nullable
public final Time timeout()
```
    Explicit operation timeout
    API name: timeout