Package org.opensearch.client.opensearch.core.msearch

Class MultisearchHeader

java.lang.Object

org.opensearch.client.opensearch.core.msearch.MultisearchHeader

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class MultisearchHeader
extends Object
implements PlainJsonSerializable

Contains parameters used to limit or change the subsequent search body request.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<MultisearchHeader>	_DESERIALIZER	Json deserializer for MultisearchHeader

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	API name: allow_no_indices
final List<ExpandWildcard>	expandWildcards()	API name: expand_wildcards
final Boolean	ignoreUnavailable()	API name: ignore_unavailable
final List<String>	index()	API name: index
static MultisearchHeader	of(Function<MultisearchHeader.Builder,ObjectBuilder<MultisearchHeader>> fn)
final String	preference()	API name: preference
final Boolean	requestCache()	API name: request_cache
final String	routing()	API name: routing
final SearchType	searchType()	API name: search_type
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	setupMultisearchHeaderDeserializer(ObjectDeserializer<MultisearchHeader.Builder> op)

Methods inherited from class java.lang.Object

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

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

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<MultisearchHeader> _DESERIALIZER

Json deserializer for MultisearchHeader

Method Details

of

public static MultisearchHeader of(Function<MultisearchHeader.Builder,ObjectBuilder<MultisearchHeader>> fn)

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

API name: allow_no_indices

expandWildcards

public final List<ExpandWildcard> expandWildcards()

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

API name: ignore_unavailable

index

public final List<String> index()

API name: index

preference

@Nullable
public final String preference()

API name: preference

requestCache

@Nullable
public final Boolean requestCache()

API name: request_cache

routing

@Nullable
public final String routing()

API name: routing

searchType

@Nullable
public final SearchType searchType()

API name: search_type

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)

setupMultisearchHeaderDeserializer

protected static void setupMultisearchHeaderDeserializer(ObjectDeserializer<MultisearchHeader.Builder> op)