Package org.opensearch.client.opensearch.core

Class MsearchTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.MsearchTemplateRequest

All Implemented Interfaces:

JsonpSerializable, NdJsonpSerializable

public class MsearchTemplateRequest
extends RequestBase
implements NdJsonpSerializable, JsonpSerializable

Allows to execute several search template operations in one request.

Nested Class Summary

Nested Classes

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

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 final SimpleEndpoint<MsearchTemplateRequest,?>	_ENDPOINT	Endpoint "msearch_template".

Method Summary

Modifier and Type	Method	Description
Iterator<?>	_serializables()
final Boolean	ccsMinimizeRoundtrips()	Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
static <TDocument> Endpoint<MsearchTemplateRequest,MsearchTemplateResponse<TDocument>,ErrorResponse>	createMsearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "msearch_template" endpoint.
final List<String>	index()	A comma-separated list of index names to use as default
final Long	maxConcurrentSearches()	Controls the maximum number of concurrent searches the multi search api will execute
static MsearchTemplateRequest	of(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn)
final List<RequestItem>	searchTemplates()	Required - Request body.
final SearchType	searchType()	Search operation type
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
MsearchTemplateRequest.Builder	toBuilder()

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

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final SimpleEndpoint<MsearchTemplateRequest,?> _ENDPOINT

Endpoint "msearch_template".

Method Details

of

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

_serializables

public Iterator<?> _serializables()

Specified by:

_serializables in interface NdJsonpSerializable

ccsMinimizeRoundtrips

@Nullable
public final Boolean ccsMinimizeRoundtrips()

Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

API name: ccs_minimize_roundtrips

index

public final List<String> index()

A comma-separated list of index names to use as default

API name: index

maxConcurrentSearches

@Nullable
public final Long maxConcurrentSearches()

Controls the maximum number of concurrent searches the multi search api will execute

API name: max_concurrent_searches

searchType

@Nullable
public final SearchType searchType()

Search operation type

API name: search_type

searchTemplates

public final List<RequestItem> searchTemplates()

Required - Request body.

API name: _value_body

serialize

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

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

toBuilder

public MsearchTemplateRequest.Builder toBuilder()

createMsearchTemplateEndpoint

public static <TDocument>
Endpoint<MsearchTemplateRequest,MsearchTemplateResponse<TDocument>,ErrorResponse> createMsearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "msearch_template" endpoint.