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:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchShardsRequest.Builder	Builder for SearchShardsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<SearchShardsRequest,SearchShardsResponse,ErrorResponse>	_ENDPOINT	Endpoint "search_shards".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
final Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a missing or closed index.
final List<String>	index()	Returns the indices and shards that a search request would be executed against.
final Boolean	local()	If true, the request retrieves information from the local node only.
static SearchShardsRequest	of(Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)
final String	preference()	Specifies the node or shard the operation should be performed on.
final String	routing()	Custom value used to route operations to a specific shard.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<SearchShardsRequest,SearchShardsResponse,ErrorResponse> _ENDPOINT

Endpoint "search_shards".

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 indices. This behavior applies even if the request targets other open indices. 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

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

public final List<String> index()

Returns the indices 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

@Nullable
public final String routing()

Custom value used to route operations to a specific shard.

API name: routing