Package co.elastic.clients.elasticsearch.core

Class MsearchTemplateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.MsearchTemplateRequest

All Implemented Interfaces:

JsonpSerializable, NdJsonpSerializable

public class MsearchTemplateRequest
extends RequestBase
implements NdJsonpSerializable, JsonpSerializable

Runs multiple templated searches with a single request.

See Also:

API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static SimpleEndpoint<MsearchTemplateRequest,?>	_ENDPOINT	Endpoint "msearch_template".

Method Summary

Modifier and Type	Method	Description
java.util.Iterator<?>	_serializables()
java.lang.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.
java.util.List<java.lang.String>	index()	A comma-separated list of index names to use as default
java.lang.Long	maxConcurrentSearches()	Controls the maximum number of concurrent searches the multi search api will execute
static MsearchTemplateRequest	of(java.util.function.Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn)
java.util.List<RequestItem>	searchTemplates()	Required - Request body.
SearchType	searchType()	Search operation type
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final SimpleEndpoint<MsearchTemplateRequest,?> _ENDPOINT

Endpoint "msearch_template".

Method Details

of

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

_serializables

public java.util.Iterator<?> _serializables()

Specified by:

_serializables in interface NdJsonpSerializable

ccsMinimizeRoundtrips

@Nullable
public final java.lang.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 java.util.List<java.lang.String> index()

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

API name: index

maxConcurrentSearches

@Nullable
public final java.lang.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 java.util.List<RequestItem> searchTemplates()

Required - Request body.

serialize

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

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createMsearchTemplateEndpoint

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

Create an "msearch_template" endpoint.