ShardStoresRequest (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.indices.ShardStoresRequest

```
public class ShardStoresRequest
extends RequestBase
```
Provides store information for shard copies of indices.

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 Endpoint<ShardStoresRequest,ShardStoresResponse,ErrorResponse> _ENDPOINT
Endpoint "indices.shard_stores".

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _ENDPOINT
```
public static final Endpoint<ShardStoresRequest,ShardStoresResponse,ErrorResponse> _ENDPOINT
```
    Endpoint "indices.shard_stores".
- Method Detail
  - of
```
public static ShardStoresRequest of(java.util.function.Function<ShardStoresRequest.Builder,ObjectBuilder<ShardStoresRequest>> fn)
```
  - allowNoIndices
```
@Nullable
public final java.lang.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 java.util.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 java.lang.Boolean ignoreUnavailable()
```
    If true, missing or closed indices are not included in the response.
    API name: ignore_unavailable
  - index
```
public final java.util.List<java.lang.String> index()
```
    List of data streams, indices, and aliases used to limit the request.
    API name: index
  - status
```
public final java.util.List<ShardStoreStatus> status()
```
    List of shard health statuses used to limit the request.
    API name: status