Package co.elastic.clients.elasticsearch.core

Class RenderSearchTemplateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<RenderSearchTemplateRequest.Builder>

co.elastic.clients.elasticsearch.core.RenderSearchTemplateRequest.Builder

All Implemented Interfaces:

WithJson<RenderSearchTemplateRequest.Builder>, ObjectBuilder<RenderSearchTemplateRequest>

Enclosing class:

RenderSearchTemplateRequest

public static class RenderSearchTemplateRequest.Builder
extends RequestBase.AbstractBuilder<RenderSearchTemplateRequest.Builder>
implements ObjectBuilder<RenderSearchTemplateRequest>

Builder for RenderSearchTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RenderSearchTemplateRequest	build()	Builds a RenderSearchTemplateRequest.
final RenderSearchTemplateRequest.Builder	file(String value)	API name: file
final RenderSearchTemplateRequest.Builder	id(String value)	The ID of the search template to render.
final RenderSearchTemplateRequest.Builder	params(String key, JsonData value)	Key-value pairs used to replace Mustache variables in the template.
final RenderSearchTemplateRequest.Builder	params(Map<String,JsonData> map)	Key-value pairs used to replace Mustache variables in the template.
protected RenderSearchTemplateRequest.Builder	self()
final RenderSearchTemplateRequest.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

file

public final RenderSearchTemplateRequest.Builder file(@Nullable
 String value)

API name: file

id

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

The ID of the search template to render. If no source is specified, this or the <template-id> request path parameter is required. If you specify both this parameter and the <template-id> parameter, the API uses only <template-id>.

API name: id

params

public final RenderSearchTemplateRequest.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 RenderSearchTemplateRequest.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.

source

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

An inline search template. It supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no id or <templated-id> is specified, this parameter is required.

API name: source

self

protected RenderSearchTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RenderSearchTemplateRequest.Builder>

build

public RenderSearchTemplateRequest build()

Builds a RenderSearchTemplateRequest.

Specified by:

build in interface ObjectBuilder<RenderSearchTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.