Package org.opensearch.client.opensearch.core

Class SearchShardsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.SearchShardsRequest

public class SearchShardsRequest
extends RequestBase

Returns information about the indices and shards that a search request would be executed against.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._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 indices
java.lang.Boolean	local()	Return local information, do not retrieve the state from cluster-manager 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 value

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

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

Endpoint "search_shards".

Method Detail

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

public final java.util.List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

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 indices

API name: index

local

@Nullable
public final java.lang.Boolean local()

Return local information, do not retrieve the state from cluster-manager 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 value

API name: routing