Package org.opensearch.client.opensearch.nodes

Class NodesUsageRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.nodes.NodesUsageRequest

All Implemented Interfaces:

ToCopyableBuilder<NodesUsageRequest.Builder,NodesUsageRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class NodesUsageRequest
extends RequestBase
implements ToCopyableBuilder<NodesUsageRequest.Builder,NodesUsageRequest>

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 final Endpoint<NodesUsageRequest,NodesUsageResponse,ErrorResponse>	_ENDPOINT	Endpoint "nodes.usage".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static NodesUsageRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<NodesUsageMetric>	metric()	Limits the information returned to the specific metrics.
final List<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(Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)
final Time	timeout()	Period to wait for a response.
NodesUsageRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<NodesUsageRequest,NodesUsageResponse,ErrorResponse> _ENDPOINT

Endpoint "nodes.usage".

Method Details

of

public static NodesUsageRequest of(Function<NodesUsageRequest.Builder,ObjectBuilder<NodesUsageRequest>> fn)

metric

@Nonnull
public final List<NodesUsageMetric> metric()

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

API name: metric

nodeId

@Nonnull
public final List<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()

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

API name: timeout

toBuilder

@Nonnull
public NodesUsageRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<NodesUsageRequest.Builder,NodesUsageRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static NodesUsageRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object