Class MsearchTemplateRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<MsearchTemplateRequest.Builder>
co.elastic.clients.elasticsearch.core.MsearchTemplateRequest.Builder
- All Implemented Interfaces:
WithJson<MsearchTemplateRequest.Builder>
,ObjectBuilder<MsearchTemplateRequest>
- Enclosing class:
- MsearchTemplateRequest
public static class MsearchTemplateRequest.Builder
extends RequestBase.AbstractBuilder<MsearchTemplateRequest.Builder>
implements ObjectBuilder<MsearchTemplateRequest>
Builder for
MsearchTemplateRequest
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aMsearchTemplateRequest
.ccsMinimizeRoundtrips
(Boolean value) Iftrue
, network round-trips are minimized for cross-cluster search requests.Comma-separated list of data streams, indices, and aliases to search.Comma-separated list of data streams, indices, and aliases to search.maxConcurrentSearches
(Long value) Maximum number of concurrent searches the API can run.searchTemplates
(RequestItem value, RequestItem... values) Required - Request body.Required - Request body.searchTemplates
(List<RequestItem> list) Required - Request body.searchType
(SearchType value) The type of the search operation.protected MsearchTemplateRequest.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toindex
. -
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
Adds one or more values to
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.Adds all elements of
list
tosearchTemplates
. -
searchTemplates
public final MsearchTemplateRequest.Builder searchTemplates(RequestItem value, RequestItem... values) Required - Request body.Adds one or more values to
searchTemplates
. -
searchTemplates
public final MsearchTemplateRequest.Builder searchTemplates(Function<RequestItem.Builder, ObjectBuilder<RequestItem>> fn) Required - Request body.Adds a value to
searchTemplates
using a builder lambda. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<MsearchTemplateRequest.Builder>
-
build
Builds aMsearchTemplateRequest
.- Specified by:
build
in interfaceObjectBuilder<MsearchTemplateRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-