Package org.opensearch.client.opensearch.core

Class SearchShardsRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<SearchShardsRequest.Builder>
org.opensearch.client.opensearch.core.SearchShardsRequest.Builder
All Implemented Interfaces:
CopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>, MutableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>, ObjectBuilder<SearchShardsRequest>
Enclosing class:
SearchShardsRequest
public static class SearchShardsRequest.Builder extends RequestBase.AbstractBuilder<SearchShardsRequest.Builder> implements CopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>
Builder for SearchShardsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public SearchShardsRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>
      Returns:
      a new builder instance.

    • self

      @Nonnull protected SearchShardsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<SearchShardsRequest.Builder>

    • allowNoIndices

      @Nonnull public final SearchShardsRequest.Builder allowNoIndices(@Nullable Boolean value)
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • expandWildcards

      @Nonnull public final SearchShardsRequest.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. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      @Nonnull public final SearchShardsRequest.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. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      @Nonnull public final SearchShardsRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • index

      @Nonnull public final SearchShardsRequest.Builder index(List<String> list)
      Returns the indexes and shards that a search request would be executed against.

      API name: index

      Adds all elements of list to index.

    • index

      @Nonnull public final SearchShardsRequest.Builder index(String value, String... values)
      Returns the indexes and shards that a search request would be executed against.

      API name: index

      Adds one or more values to index.

    • local

      @Nonnull public final SearchShardsRequest.Builder local(@Nullable Boolean value)
      If true, the request retrieves information from the local node only.

      API name: local

    • preference

      @Nonnull public final SearchShardsRequest.Builder preference(@Nullable String value)
      Specifies the node or shard the operation should be performed on. Random by default.

      API name: preference

    • routing

      @Nonnull public final SearchShardsRequest.Builder routing(List<String> list)
      Custom value used to route operations to a specific shard.

      API name: routing

      Adds all elements of list to routing.

    • routing

      @Nonnull public final SearchShardsRequest.Builder routing(String value, String... values)
      Custom value used to route operations to a specific shard.

      API name: routing

      Adds one or more values to routing.

    • build

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