Package co.elastic.clients.elasticsearch.indices

Class ShardStoresRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ShardStoresRequest

public class ShardStoresRequest
extends RequestBase

Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream’s backing indices.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<ShardStoresRequest,ShardStoresResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.shard_stores".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
final Boolean	ignoreUnavailable()	If true, missing or closed indices are not included in the response.
final List<String>	index()	List of data streams, indices, and aliases used to limit the request.
static ShardStoresRequest	of(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)
final List<ShardStoreStatus>	status()	List of shard health statuses used to limit the request.

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<ShardStoresRequest,ShardStoresResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.shard_stores".

Method Details

of

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

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

API name: allow_no_indices

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

If true, missing or closed indices are not included in the response.

API name: ignore_unavailable

index

public final List<String> index()

List of data streams, indices, and aliases used to limit the request.

API name: index

status

public final List<ShardStoreStatus> status()

List of shard health statuses used to limit the request.

API name: status