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 forSearchShardsRequest
.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 Endpoint<SearchShardsRequest,SearchShardsResponse,ErrorResponse>
_ENDPOINT
Endpoint "search_shards
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
Whether to ignore if a wildcard indices expression resolves into no concrete indices.java.util.List<ExpandWildcard>
expandWildcards()
Whether to expand wildcard expression to concrete indices that are open, closed or both.java.lang.Boolean
ignoreUnavailable()
Whether specified concrete indices should be ignored when unavailable (missing or closed)java.util.List<java.lang.String>
index()
A comma-separated list of index names to search; use_all
or empty string to perform the operation on all indicesjava.lang.Boolean
local()
Return local information, do not retrieve the state from master node (default: false)static SearchShardsRequest
of(java.util.function.Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)
java.lang.String
preference()
Specify the node or shard the operation should be performed on (default: random)java.lang.String
routing()
Specific routing valueMethods 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
Endpoint "search_shards
".
-
-
Method Details
-
of
public static SearchShardsRequest of(java.util.function.Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn) -
allowNoIndices
@Nullable public final java.lang.Boolean 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
public final java.util.List<java.lang.String> 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
@Nullable public final java.lang.Boolean local()Return local information, do not retrieve the state from master node (default: false)API name:
local
-
preference
@Nullable public final java.lang.String preference()Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
routing
@Nullable public final java.lang.String routing()Specific routing valueAPI name:
routing
-