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

All Implemented Interfaces:

ElasticsearchCatRequest, ElasticsearchCommonRequest

public final class ShardsRequest
extends CatRequestBase

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

Constructor Summary

Constructors

Constructor	Description
ShardsRequest(ShardsRequest.Builder builder)
ShardsRequest(java.util.function.Function<ShardsRequest.Builder,ShardsRequest.Builder> fn)

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

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<ShardsRequest,ShardsResponse,ElasticsearchError> ENDPOINT

Endpoint "cat.shards".

Constructor Details

ShardsRequest

public ShardsRequest(ShardsRequest.Builder builder)

ShardsRequest

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

Method Details

index

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

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

API name: index

bytes

@Nullable
public Bytes bytes()

The unit in which to display byte values

API name: bytes