Package co.elastic.clients.elasticsearch.core

Class SearchShardsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.SearchShardsRequest
public class SearchShardsRequest extends RequestBase
Returns information about the indices and shards that a search request would be executed against.
See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      API name: allow_no_indices

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • index

      public final List<String> index()
      A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

      API name: index

    • local

      @Nullable public final Boolean local()
      Return local information, do not retrieve the state from master node (default: false)

      API name: local

    • preference

      @Nullable public final String preference()
      Specify the node or shard the operation should be performed on (default: random)

      API name: preference

    • routing

      @Nullable public final String routing()
      Specific routing value

      API name: routing