Package org.opensearch.client.opensearch.cat

Class ShardsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.ShardsRequest

public class ShardsRequest
extends CatRequestBase

Provides a detailed view of shard allocation on nodes.

Nested Class Summary

Nested Classes

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

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

CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>

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 Endpoint<ShardsRequest,ShardsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.shards".

Method Summary

Modifier and Type	Method	Description
Bytes	bytes()	The unit in which to display byte values
java.util.List<java.lang.String>	index()	A comma-separated list of index names to limit the returned information
static ShardsRequest	of(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

headers, queryParameters, sort

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<ShardsRequest,ShardsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.shards".

Method Detail

of

public static ShardsRequest of(java.util.function.Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)

bytes

@Nullable
public final Bytes bytes()

The unit in which to display byte values

API name: bytes

index

public final java.util.List<java.lang.String> index()

A comma-separated list of index names to limit the returned information

API name: index