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

All Implemented Interfaces:

ToCopyableBuilder<ShardsRequest.Builder,ShardsRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class ShardsRequest
extends CatRequestBase
implements ToCopyableBuilder<ShardsRequest.Builder,ShardsRequest>

Lists the states of all primary and replica shards and how they are distributed.

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.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
protected void	applyQueryParameters(Map<String,String> params)
static ShardsRequest.Builder	builder()
final Bytes	bytes()	The units used to display byte values.
final Time	clusterManagerTimeout()	The amount of time allowed to establish a connection to the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final List<String>	index()	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final Time	masterTimeout()	Deprecated.
static ShardsRequest	of(Function<ShardsRequest.Builder,ObjectBuilder<ShardsRequest>> fn)
final TimeUnit	time()	Specifies the time units, for example, 5d or 7h.
ShardsRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

headers, sort

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

API name: bytes

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

index

@Nonnull
public final List<String> index()

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

API name: index

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

time

@Nullable
public final TimeUnit time()

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

API name: time

toBuilder

@Nonnull
public ShardsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ShardsRequest.Builder,ShardsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ShardsRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object