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 forMsearchTemplateRequest
.-
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 SimpleEndpoint<MsearchTemplateRequest,?>
_ENDPOINT
Endpoint "msearch_template
".
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 executionstatic <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 defaultjava.lang.Long
maxConcurrentSearches()
Controls the maximum number of concurrent searches the multi search api will executestatic MsearchTemplateRequest
of(java.util.function.Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn)
java.util.List<RequestItem>
searchTemplates()
Required - Request body.SearchType
searchType()
Search operation typevoid
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this value to JSON.MsearchTemplateRequest.Builder
toBuilder()
-
-
-
Field Detail
-
_ENDPOINT
public static final SimpleEndpoint<MsearchTemplateRequest,?> _ENDPOINT
Endpoint "msearch_template
".
-
-
Method Detail
-
of
public static MsearchTemplateRequest of(java.util.function.Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn)
-
_serializables
public java.util.Iterator<?> _serializables()
- Specified by:
_serializables
in interfaceNdJsonpSerializable
-
ccsMinimizeRoundtrips
@Nullable public final java.lang.Boolean ccsMinimizeRoundtrips()
Indicates whether network round-trips should be minimized as part of cross-cluster search requests executionAPI name:
ccs_minimize_roundtrips
-
index
public final java.util.List<java.lang.String> index()
A comma-separated list of index names to use as defaultAPI name:
index
-
maxConcurrentSearches
@Nullable public final java.lang.Long maxConcurrentSearches()
Controls the maximum number of concurrent searches the multi search api will executeAPI name:
max_concurrent_searches
-
searchType
@Nullable public final SearchType searchType()
Search operation typeAPI name:
search_type
-
searchTemplates
public final java.util.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 interfaceJsonpSerializable
-
toBuilder
public MsearchTemplateRequest.Builder toBuilder()
-
createMsearchTemplateEndpoint
public static <TDocument> Endpoint<MsearchTemplateRequest,MsearchTemplateResponse<TDocument>,ErrorResponse> createMsearchTemplateEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
Create an "msearch_template
" endpoint.
-
-