Package org.opensearch.client.opensearch.core

Class SearchShardsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.SearchShardsRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class SearchShardsRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>

Returns information about the indexes 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 JsonpDeserializer<SearchShardsRequest>	_DESERIALIZER	Json deserializer for SearchShardsRequest
static Endpoint<SearchShardsRequest,SearchShardsResponse,ErrorResponse>	_ENDPOINT	Endpoint "search_shards".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.
protected void	applyQueryParameters(java.util.Map<java.lang.String,java.lang.String> params)
static SearchShardsRequest.Builder	builder()
boolean	equals(java.lang.Object o)
java.util.List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
int	hashCode()
java.lang.Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a missing or closed index.
java.util.List<java.lang.String>	index()	Returns the indexes and shards that a search request would be executed against.
java.lang.Boolean	local()	If true, the request retrieves information from the local node only.
static SearchShardsRequest	of(java.util.function.Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)
java.lang.String	preference()	Specifies the node or shard the operation should be performed on.
java.lang.String	routing()	A custom value used to route operations to a specific shard.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSearchShardsRequestDeserializer(ObjectDeserializer<SearchShardsRequest.Builder> op)
SlicedScroll	slice()	API name: slice
SearchShardsRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<SearchShardsRequest> _DESERIALIZER

Json deserializer for SearchShardsRequest

_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()

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

API name: allow_no_indices

expandWildcards

@Nonnull
public final java.util.List<ExpandWildcard> 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 as open,hidden. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

ignoreUnavailable

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

If false, the request returns an error if it targets a missing or closed index.

API name: ignore_unavailable

index

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

Returns the indexes and shards that a search request would be executed against.

API name: index

local

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

If true, the request retrieves information from the local node only.

API name: local

preference

@Nullable
public final java.lang.String preference()

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

routing

@Nullable
public final java.lang.String routing()

A custom value used to route operations to a specific shard.

API name: routing

slice

@Nullable
public final SlicedScroll slice()

API name: slice

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

toBuilder

@Nonnull
public SearchShardsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SearchShardsRequest.Builder,SearchShardsRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static SearchShardsRequest.Builder builder()

setupSearchShardsRequestDeserializer

protected static void setupSearchShardsRequestDeserializer(ObjectDeserializer<SearchShardsRequest.Builder> op)

applyQueryParameters

protected void applyQueryParameters(@Nonnull
                                    java.util.Map<java.lang.String,java.lang.String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object