Package co.elastic.clients.elasticsearch.cat

Class AllocationRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.AllocationRequest

public class AllocationRequest
extends CatRequestBase

Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.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
final Bytes	bytes()	The unit used to display byte values.
final List<String>	nodeId()	Comma-separated list of node identifiers or names used to limit the returned information.
static AllocationRequest	of(Function<AllocationRequest.Builder,ObjectBuilder<AllocationRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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 unit used to display byte values.

API name: bytes

nodeId

public final List<String> nodeId()

Comma-separated list of node identifiers or names used to limit the returned information.

API name: node_id