Class SearchShardsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.SearchShardsRequest
Returns information about the indices and shards that a search request would
be executed against.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<SearchShardsRequest,
SearchShardsResponse, ErrorResponse> Endpoint "search_shards
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final List<ExpandWildcard>
Type of index that wildcard patterns can match.final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.index()
Returns the indices and shards that a search request would be executed against.final Boolean
local()
Iftrue
, the request retrieves information from the local node only.static SearchShardsRequest
final String
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
-
Field Details
-
_ENDPOINT
Endpoint "search_shards
".
-
-
Method Details
-
of
public static SearchShardsRequest of(Function<SearchShardsRequest.Builder, ObjectBuilder<SearchShardsRequest>> fn) -
allowNoIndices
Iffalse
, 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 targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.API name:
allow_no_indices
-
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 asopen,hidden
. Valid values are:all
,open
,closed
,hidden
,none
.API name:
expand_wildcards
-
index
Returns the indices and shards that a search request would be executed against.API name:
index
-
local
Iftrue
, the request retrieves information from the local node only.API name:
local
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-