Class ShardStoresRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.indices.ShardStoresRequest.Builder
All Implemented Interfaces:
ObjectBuilder<ShardStoresRequest>
Enclosing class:
ShardStoresRequest

public static class ShardStoresRequest.Builder
extends java.lang.Object
implements ObjectBuilder<ShardStoresRequest>
Builder for ShardStoresRequest.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • index

      public ShardStoresRequest.Builder index​(@Nullable java.util.List<java.lang.String> value)
      List of data streams, indices, and aliases used to limit the request.

      API name: index

    • index

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

      API name: index

    • addIndex

      public ShardStoresRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.
    • allowNoIndices

      public ShardStoresRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      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 ShardStoresRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      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

    • expandWildcards

      public ShardStoresRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      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

    • addExpandWildcards

      public ShardStoresRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed.
    • ignoreUnavailable

      public ShardStoresRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • status

      public ShardStoresRequest.Builder status​(@Nullable java.util.List<ShardStatus> value)
      List of shard health statuses used to limit the request.

      API name: status

    • status

      public ShardStoresRequest.Builder status​(ShardStatus... value)
      List of shard health statuses used to limit the request.

      API name: status

    • addStatus

      public ShardStoresRequest.Builder addStatus​(ShardStatus value)
      Add a value to status(List), creating the list if needed.
    • build

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