Package org.opensearch.client.opensearch.core

Class SearchShardsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.core.SearchShardsRequest
All Implemented Interfaces:
ToCopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class SearchShardsRequest extends RequestBase implements ToCopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>
Returns information about the indexes and shards that a search request would be executed against.

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      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 List<ExpandWildcard> expandWildcards()
      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

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • index

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

      API name: index

    • local

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

      API name: local

    • preference

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

      API name: preference

    • routing

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

      API name: routing

    • toBuilder

      @Nonnull public SearchShardsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static SearchShardsRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object