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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final SimpleEndpoint<MsearchTemplateRequest,
?> Endpoint "msearch_template
". -
Method Summary
Modifier and TypeMethodDescriptionIterator<?>
final Boolean
Iftrue
, 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.index()
Comma-separated list of data streams, indices, and aliases to search.final Long
Maximum number of concurrent searches the API can run.static MsearchTemplateRequest
final List<RequestItem>
Required - Request body.final 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
-
Field Details
-
_ENDPOINT
Endpoint "msearch_template
".
-
-
Method Details
-
of
public static MsearchTemplateRequest of(Function<MsearchTemplateRequest.Builder, ObjectBuilder<MsearchTemplateRequest>> fn) -
_serializables
- Specified by:
_serializables
in interfaceNdJsonpSerializable
-
ccsMinimizeRoundtrips
Iftrue
, network round-trips are minimized for cross-cluster search requests.API name:
ccs_minimize_roundtrips
-
index
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*
). To search all data streams and indices, omit this parameter or use*
.API name:
index
-
maxConcurrentSearches
Maximum number of concurrent searches the API can run.API name:
max_concurrent_searches
-
searchType
The type of the search operation. Available options:query_then_fetch
,dfs_query_then_fetch
.API name:
search_type
-
searchTemplates
Required - Request body. -
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createMsearchTemplateEndpoint
public static <TDocument> Endpoint<MsearchTemplateRequest,MsearchTemplateResponse<TDocument>, createMsearchTemplateEndpointErrorResponse> (JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "msearch_template
" endpoint.
-