Class ShardsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.ShardsRequest
public class ShardsRequest extends CatRequestBase
Provides a detailed view of shard allocation on nodes.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ShardsRequest.Builder
Builder forShardsRequest
.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 Endpoint<ShardsRequest,ShardsResponse,ErrorResponse>
_ENDPOINT
Endpoint "cat.shards
". -
Method Summary
Modifier and Type Method Description Bytes
bytes()
The unit in which to display byte valuesjava.util.List<java.lang.String>
index()
A comma-separated list of index names to limit the returned informationstatic ShardsRequest
of(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "cat.shards
".
-
-
Method Details
-
of
public static ShardsRequest of(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn) -
bytes
The unit in which to display byte valuesAPI name:
bytes
-
index
public final java.util.List<java.lang.String> index()A comma-separated list of index names to limit the returned informationAPI name:
index
-