Package co.elastic.clients.elasticsearch._core

Class SearchShardsRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch._core.SearchShardsRequest.Builder
All Implemented Interfaces:
ObjectBuilder<SearchShardsRequest>
Enclosing class:
SearchShardsRequest
public static class SearchShardsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<SearchShardsRequest>
Builder for SearchShardsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

      public SearchShardsRequest.Builder index​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

      API name: index

    • index

      public SearchShardsRequest.Builder index​(java.lang.String... value)
      A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

      API name: index

    • addIndex

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

    • allowNoIndices

      public SearchShardsRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      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 SearchShardsRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • expandWildcards

      public SearchShardsRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • addExpandWildcards

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

    • ignoreUnavailable

      public SearchShardsRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • local

      public SearchShardsRequest.Builder local​(@Nullable java.lang.Boolean value)
      Return local information, do not retrieve the state from master node (default: false)

      API name: local

    • preference

      public SearchShardsRequest.Builder preference​(@Nullable java.lang.String value)
      Specify the node or shard the operation should be performed on (default: random)

      API name: preference

    • routing

      public SearchShardsRequest.Builder routing​(@Nullable java.lang.String value)
      Specific routing value

      API name: routing

    • build

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