Package org.opensearch.client.opensearch.cat

Class NodesRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.NodesRequest

All Implemented Interfaces:

ToCopyableBuilder<NodesRequest.Builder,NodesRequest>

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

Returns basic statistics about the performance of cluster nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodesRequest.Builder	Builder for NodesRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<NodesRequest,NodesResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.nodes".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static NodesRequest.Builder	builder()
final Bytes	bytes()	The units used to display byte values.
final Time	clusterManagerTimeout()	The amount of time allowed to establish a connection to the cluster manager node.
boolean	equals(Object o)
final Boolean	fullId()	When true, returns the full node ID.
int	hashCode()
final Time	masterTimeout()	Deprecated.
static NodesRequest	of(Function<NodesRequest.Builder,ObjectBuilder<NodesRequest>> fn)
final TimeUnit	time()	Specifies the time units, for example, 5d or 7h.
NodesRequest.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.cat.CatRequestBase

headers, sort

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<NodesRequest,NodesResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.nodes".

Method Details

of

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

bytes

@Nullable
public final Bytes bytes()

The units used to display byte values.

API name: bytes

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

fullId

@Nullable
public final Boolean fullId()

When true, returns the full node ID. When false, returns the shortened node ID.

API name: full_id

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

time

@Nullable
public final TimeUnit time()

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

API name: time

toBuilder

@Nonnull
public NodesRequest.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<NodesRequest.Builder,NodesRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static NodesRequest.Builder builder()

applyQueryParameters

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

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object