Package org.opensearch.client.opensearch._global

Class SearchShardsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch._global.SearchShardsRequest

public final class SearchShardsRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<SearchShardsRequest,SearchShardsResponse,OpenSearchError>	ENDPOINT	Endpoint "search_shards".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SearchShardsRequest(SearchShardsRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	API name: allow_no_indices
jakarta.json.JsonValue	expandWildcards()	API name: expand_wildcards
java.lang.Boolean	ignoreUnavailable()	API name: ignore_unavailable
java.util.List<java.lang.String>	index()	API name: index
java.lang.Boolean	local()	API name: local
java.lang.String	preference()	API name: preference
jakarta.json.JsonValue	routing()	API name: routing

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<SearchShardsRequest,SearchShardsResponse,OpenSearchError> ENDPOINT

Endpoint "search_shards".

Constructor Details

SearchShardsRequest

protected SearchShardsRequest(SearchShardsRequest.Builder builder)

Method Details

index

@Nullable public java.util.List<java.lang.String> index()

API name: index

allowNoIndices

@Nullable public java.lang.Boolean allowNoIndices()

API name: allow_no_indices

expandWildcards

@Nullable public jakarta.json.JsonValue expandWildcards()

API name: expand_wildcards

ignoreUnavailable

@Nullable public java.lang.Boolean ignoreUnavailable()

API name: ignore_unavailable

local

@Nullable public java.lang.Boolean local()

API name: local

preference

@Nullable public java.lang.String preference()

API name: preference

routing

@Nullable public jakarta.json.JsonValue routing()

API name: routing