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
Whether to ignore if a wildcard indices expression resolves into no concrete indices.final List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)index()
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesfinal Boolean
local()
Return local information, do not retrieve the state from master node (default: false)static SearchShardsRequest
final String
Specify the node or shard the operation should be performed on (default: random)final String
routing()
Specific routing valueMethods 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
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
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
index
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
local
Return local information, do not retrieve the state from master node (default: false)API name:
local
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
routing
Specific routing valueAPI name:
routing
-