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
Get index shard stores.

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

The index shard stores API returns the following information:

  • The node on which each replica shard exists.
  • The allocation ID for each replica shard.
  • A unique ID for each replica shard.
  • Any errors encountered while opening the shard index or from an earlier failure.

By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      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 false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      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

    • rebuild

      public ShardStoresRequest.Builder rebuild()
      Returns:
      New ShardStoresRequest.Builder initialized with field values of this instance