Package co.elastic.clients.elasticsearch.core

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MsearchTemplateRequest	build()	Builds a MsearchTemplateRequest.
final MsearchTemplateRequest.Builder	ccsMinimizeRoundtrips(Boolean value)	If true, network round-trips are minimized for cross-cluster search requests.
final MsearchTemplateRequest.Builder	index(String value, String... values)	A comma-separated list of data streams, indices, and aliases to search.
final MsearchTemplateRequest.Builder	index(List<String> list)	A comma-separated list of data streams, indices, and aliases to search.
final MsearchTemplateRequest.Builder	maxConcurrentSearches(Long value)	The maximum number of concurrent searches the API can run.
final MsearchTemplateRequest.Builder	projectRouting(String value)	Specifies a subset of projects to target for the search using project metadata tags in a subset of Lucene query syntax.
final MsearchTemplateRequest.Builder	searchTemplates(RequestItem value, RequestItem... values)	Required - Request body.
final MsearchTemplateRequest.Builder	searchTemplates(Function<RequestItem.Builder,ObjectBuilder<RequestItem>> fn)	Required - Request body.
final MsearchTemplateRequest.Builder	searchTemplates(List<RequestItem> list)	Required - Request body.
final MsearchTemplateRequest.Builder	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

ccsMinimizeRoundtrips

public final MsearchTemplateRequest.Builder ccsMinimizeRoundtrips(@Nullable
 Boolean value)

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

API name: ccs_minimize_roundtrips

index

public final MsearchTemplateRequest.Builder index(List<String> list)

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

Adds all elements of list to index.

index

public final MsearchTemplateRequest.Builder index(String value,
 String... values)

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

Adds one or more values to index.

maxConcurrentSearches

public final MsearchTemplateRequest.Builder maxConcurrentSearches(@Nullable
 Long value)

The maximum number of concurrent searches the API can run.

API name: max_concurrent_searches

projectRouting

public final MsearchTemplateRequest.Builder projectRouting(@Nullable
 String value)

Specifies a subset of projects to target for the search using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

API name: project_routing

searchType

public final MsearchTemplateRequest.Builder searchType(@Nullable
 SearchType value)

The type of the search operation.

API name: search_type

searchTemplates

public final MsearchTemplateRequest.Builder searchTemplates(List<RequestItem> list)

Required - Request body.

Adds all elements of list to searchTemplates.

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

protected MsearchTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<MsearchTemplateRequest.Builder>

build

public MsearchTemplateRequest build()

Builds a MsearchTemplateRequest.

Specified by:

build in interface ObjectBuilder<MsearchTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.