Package org.opensearch.client.opensearch.indices

Class ShardStoresRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.ShardStoresRequest

All Implemented Interfaces:

ToCopyableBuilder<ShardStoresRequest.Builder,ShardStoresRequest>

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

Provides store information for shard copies of indexes.

Nested Class Summary

Nested Classes

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

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 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 indexes.
protected void	applyQueryParameters(Map<String,String> params)
static ShardStoresRequest.Builder	builder()
boolean	equals(Object o)
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
int	hashCode()
final Boolean	ignoreUnavailable()	If true, missing or closed indexes are not included in the response.
final List<String>	index()	Limits health reporting to a specific source.
static ShardStoresRequest	of(Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)
final List<ShardStoreStatus>	status()	A list of shard health statuses used to limit the request.
ShardStoresRequest.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._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<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 indexes. This behavior applies even if the request targets other open indexes.

API name: allow_no_indices

expandWildcards

@Nonnull
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 indexes are not included in the response.

API name: ignore_unavailable

index

@Nonnull
public final List<String> index()

Limits health reporting to a specific source. Can be a single source or a comma-separated list of sources (comprised of data streams, indexes, and aliases).

API name: index

status

@Nonnull
public final List<ShardStoreStatus> status()

A list of shard health statuses used to limit the request.

API name: status

toBuilder

@Nonnull
public ShardStoresRequest.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<ShardStoresRequest.Builder,ShardStoresRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ShardStoresRequest.Builder builder()

applyQueryParameters

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

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object