Package co.elastic.clients.elasticsearch.core

Class RenderSearchTemplateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.RenderSearchTemplateRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RenderSearchTemplateRequest
extends RequestBase
implements JsonpSerializable

Render a search template.

Render a search template as a search request body.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderSearchTemplateRequest.Builder	Builder for RenderSearchTemplateRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RenderSearchTemplateRequest>	_DESERIALIZER	Json deserializer for RenderSearchTemplateRequest
static final Endpoint<RenderSearchTemplateRequest,RenderSearchTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "render_search_template".

Method Summary

Modifier and Type	Method	Description
final String	file()	API name: file
final String	id()	The ID of the search template to render.
static RenderSearchTemplateRequest	of(Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)
final Map<String,JsonData>	params()	Key-value pairs used to replace Mustache variables in the template.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRenderSearchTemplateRequestDeserializer(ObjectDeserializer<RenderSearchTemplateRequest.Builder> op)
final ScriptSource	source()	An inline search template.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RenderSearchTemplateRequest> _DESERIALIZER

Json deserializer for RenderSearchTemplateRequest

_ENDPOINT

public static final Endpoint<RenderSearchTemplateRequest,RenderSearchTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "render_search_template".

Method Details

of

public static RenderSearchTemplateRequest of(Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)

file

@Nullable
public final String file()

API name: file

id

@Nullable
public final String id()

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 Map<String,JsonData> params()

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

source

@Nullable
public final ScriptSource source()

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

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupRenderSearchTemplateRequestDeserializer

protected static void setupRenderSearchTemplateRequestDeserializer(ObjectDeserializer<RenderSearchTemplateRequest.Builder> op)