Package co.elastic.clients.elasticsearch.core.msearch_template

Class TemplateConfig.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<TemplateConfig.Builder>

co.elastic.clients.elasticsearch.core.msearch_template.TemplateConfig.Builder

All Implemented Interfaces:

WithJson<TemplateConfig.Builder>, ObjectBuilder<TemplateConfig>

Enclosing class:

TemplateConfig

public static class TemplateConfig.Builder
extends WithJsonObjectBuilderBase<TemplateConfig.Builder>
implements ObjectBuilder<TemplateConfig>

Builder for TemplateConfig.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TemplateConfig	build()	Builds a TemplateConfig.
final TemplateConfig.Builder	explain(Boolean value)	If true, returns detailed information about score calculation as part of each hit.
final TemplateConfig.Builder	id(String value)	ID of the search template to use.
final TemplateConfig.Builder	params(String key, JsonData value)	Key-value pairs used to replace Mustache variables in the template.
final TemplateConfig.Builder	params(Map<String,JsonData> map)	Key-value pairs used to replace Mustache variables in the template.
final TemplateConfig.Builder	profile(Boolean value)	If true, the query execution is profiled.
protected TemplateConfig.Builder	self()
final TemplateConfig.Builder	source(String value)	An inline search template.

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

explain

public final TemplateConfig.Builder explain(@Nullable
 Boolean value)

If true, returns detailed information about score calculation as part of each hit.

API name: explain

id

public final TemplateConfig.Builder id(@Nullable
 String value)

ID of the search template to use. If no source is specified, this parameter is required.

API name: id

params

public final TemplateConfig.Builder params(Map<String,JsonData> map)

Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.

API name: params

Adds all entries of map to params.

params

public final TemplateConfig.Builder params(String key,
 JsonData value)

Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.

API name: params

Adds an entry to params.

profile

public final TemplateConfig.Builder profile(@Nullable
 Boolean value)

If true, the query execution is profiled.

API name: profile

source

public final TemplateConfig.Builder source(@Nullable
 String value)

An inline search template. Supports the same parameters as the search API's request body. Also supports Mustache variables. If no id is specified, this parameter is required.

API name: source

self

protected TemplateConfig.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<TemplateConfig.Builder>

build

public TemplateConfig build()

Builds a TemplateConfig.

Specified by:

build in interface ObjectBuilder<TemplateConfig>

Throws:

NullPointerException - if some of the required fields are null.