Package org.opensearch.client.opensearch.cat

Class AllocationRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.AllocationRequest

All Implemented Interfaces:

ToCopyableBuilder<AllocationRequest.Builder,AllocationRequest>

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

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

Nested Class Summary

Nested Classes

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

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<AllocationRequest,AllocationResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.allocation".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static AllocationRequest.Builder	builder()
final Bytes	bytes()	The units used to display byte values.
final Time	clusterManagerTimeout()	A timeout for connection to the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Time	masterTimeout()	Deprecated.
final List<String>	nodeId()	A comma-separated list of node IDs or names used to limit the returned information.
static AllocationRequest	of(Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)
AllocationRequest.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<AllocationRequest,AllocationResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.allocation".

Method Details

of

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

bytes

@Nullable
public final Bytes bytes()

The units used to display byte values.

API name: bytes

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

A timeout for connection to the cluster manager node.

API name: cluster_manager_timeout

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

A timeout for connection to the cluster manager node.

API name: master_timeout

nodeId

@Nonnull
public final List<String> nodeId()

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

API name: node_id

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static AllocationRequest.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