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

Run multiple templated searches.

Run multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to preserve newlines. For example:

 $ cat requests
 { "index": "my-index" }
 { "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }}
 { "index": "my-other-index" }
 { "id": "my-other-search-template", "params": { "query_type": "match_all" }}

 $ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo
 
 

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

Method Summary

Modifier and Type	Method	Description
Iterator<?>	_serializables()
final Boolean	ccsMinimizeRoundtrips()	If true, network round-trips are minimized for cross-cluster search requests.
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 data streams, indices, and aliases to search.
final Long	maxConcurrentSearches()	The maximum number of concurrent searches the API can run.
static MsearchTemplateRequest	of(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn)
final List<RequestItem>	searchTemplates()	Required - Request body.
final SearchType	searchType()	The type of the search operation.
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(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn)

_serializables

public Iterator<?> _serializables()

Specified by:

_serializables in interface NdJsonpSerializable

ccsMinimizeRoundtrips

@Nullable
public final Boolean ccsMinimizeRoundtrips()

If true, network round-trips are minimized for cross-cluster search requests.

API name: ccs_minimize_roundtrips

index

public final List<String> index()

A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (*). To search all data streams and indices, omit this parameter or use *.

API name: index

maxConcurrentSearches

@Nullable
public final Long maxConcurrentSearches()

The maximum number of concurrent searches the API can run.

API name: max_concurrent_searches

searchType

@Nullable
public final SearchType searchType()

The type of the search operation.

API name: search_type

searchTemplates

public final 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.