Class MsearchTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch._core.MsearchTemplateRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class MsearchTemplateRequest extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MsearchTemplateRequest.Builder
Builder forMsearchTemplateRequest
.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 JsonpDeserializer<MsearchTemplateRequest>
_DESERIALIZER
-
Constructor Summary
Constructors Constructor Description MsearchTemplateRequest(MsearchTemplateRequest.Builder builder)
MsearchTemplateRequest(java.util.function.Function<MsearchTemplateRequest.Builder,MsearchTemplateRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
ccsMinimizeRoundtrips()
Indicates whether network round-trips should be minimized as part of cross-cluster search requests executionstatic <TDocument>
Endpoint<MsearchTemplateRequest,MsearchTemplateResponse<TDocument>,ElasticsearchError>createMsearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
Create an "msearch_template
" endpoint.protected static JsonpDeserializer<MsearchTemplateRequest>
createMsearchTemplateRequestDeserializer()
java.util.List<java.lang.String>
index()
A comma-separated list of index names to use as defaultjava.lang.Long
maxConcurrentSearches()
Controls the maximum number of concurrent searches the multi search api will executejava.util.List<TemplateItem>
searchTemplates()
Required - Request body.SearchType
searchType()
Search operation typevoid
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this value to JSON.java.util.List<java.lang.String>
type()
A comma-separated list of document types to use as defaultjava.lang.Boolean
typedKeys()
Specify whether aggregation and suggester names should be prefixed by their respective types in the responseMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
-
-
Constructor Details
-
MsearchTemplateRequest
-
MsearchTemplateRequest
public MsearchTemplateRequest(java.util.function.Function<MsearchTemplateRequest.Builder,MsearchTemplateRequest.Builder> fn)
-
-
Method Details
-
index
@Nullable public java.util.List<java.lang.String> index()A comma-separated list of index names to use as defaultAPI name:
index
-
type
@Nullable public java.util.List<java.lang.String> type()A comma-separated list of document types to use as defaultAPI name:
type
-
ccsMinimizeRoundtrips
@Nullable public java.lang.Boolean ccsMinimizeRoundtrips()Indicates whether network round-trips should be minimized as part of cross-cluster search requests executionAPI name:
ccs_minimize_roundtrips
-
maxConcurrentSearches
@Nullable public java.lang.Long maxConcurrentSearches()Controls the maximum number of concurrent searches the multi search api will executeAPI name:
max_concurrent_searches
-
searchType
Search operation typeAPI name:
search_type
-
typedKeys
@Nullable public java.lang.Boolean typedKeys()Specify whether aggregation and suggester names should be prefixed by their respective types in the responseAPI name:
typed_keys
-
searchTemplates
Required - Request body.API name:
_value_body
-
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createMsearchTemplateRequestDeserializer
protected static JsonpDeserializer<MsearchTemplateRequest> createMsearchTemplateRequestDeserializer() -
createMsearchTemplateEndpoint
public static <TDocument> Endpoint<MsearchTemplateRequest,MsearchTemplateResponse<TDocument>,ElasticsearchError> createMsearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)Create an "msearch_template
" endpoint.
-