Package co.elastic.clients.elasticsearch.cat

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

Get shard information.

Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. 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	ShardsRequest.Builder	Builder for ShardsRequest.

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

Method Summary

Modifier and Type	Method	Description
final Bytes	bytes()	The unit used to display byte values.
final List<String>	h()	List of columns to appear in the response.
final List<String>	index()	A comma-separated list of data streams, indices, and aliases used to limit the request.
final Time	masterTimeout()	The period to wait for a connection to the master node.
static ShardsRequest	of(Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)
final List<String>	s()	A comma-separated list of column names or aliases that determines the sort order.
final TimeUnit	time()	The unit used to display time values.

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<ShardsRequest,ShardsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.shards".

Method Details

of

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

bytes

@Nullable
public final Bytes bytes()

The unit used to display byte values.

API name: bytes

h

public final List<String> h()

List of columns to appear in the response. Supports simple wildcards.

API name: h

index

public final List<String> index()

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

API name: index

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for a connection to the master node.

API name: master_timeout

s

public final List<String> s()

A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

API name: s

time

@Nullable
public final TimeUnit time()

The unit used to display time values.

API name: time