Package co.elastic.clients.elasticsearch.indices

Class ShardStoresRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ShardStoresRequest.Builder>
co.elastic.clients.elasticsearch.indices.ShardStoresRequest.Builder
All Implemented Interfaces:
WithJson<ShardStoresRequest.Builder>, ObjectBuilder<ShardStoresRequest>
Enclosing class:
ShardStoresRequest
public static class ShardStoresRequest.Builder extends RequestBase.AbstractBuilder<ShardStoresRequest.Builder> implements ObjectBuilder<ShardStoresRequest>
Builder for ShardStoresRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final ShardStoresRequest.Builder allowNoIndices(@Nullable Boolean value)
      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 ShardStoresRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final ShardStoresRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      public final ShardStoresRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      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 ShardStoresRequest.Builder index(List<String> list)
      List of data streams, indices, and aliases used to limit the request.

      API name: index

      Adds all elements of list to index.

    • index

      public final ShardStoresRequest.Builder index(String value, String... values)
      List of data streams, indices, and aliases used to limit the request.

      API name: index

      Adds one or more values to index.

    • status

      public final ShardStoresRequest.Builder status(List<ShardStoreStatus> list)
      List of shard health statuses used to limit the request.

      API name: status

      Adds all elements of list to status.

    • status

      public final ShardStoresRequest.Builder status(ShardStoreStatus value, ShardStoreStatus... values)
      List of shard health statuses used to limit the request.

      API name: status

      Adds one or more values to status.

    • self

      protected ShardStoresRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<ShardStoresRequest.Builder>

    • build

      public ShardStoresRequest build()
      Builds a ShardStoresRequest.
      Specified by:
      build in interface ObjectBuilder<ShardStoresRequest>
      Throws:
      NullPointerException - if some of the required fields are null.