Package co.elastic.clients.elasticsearch.search_application

Class RenderQueryRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.search_application.RenderQueryRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RenderQueryRequest
extends RequestBase
implements JsonpSerializable

Render a search application query.

Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in params, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.

You must have read privileges on the backing alias of the search application.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<RenderQueryRequest>	_DESERIALIZER	Json deserializer for RenderQueryRequest
static final Endpoint<RenderQueryRequest,RenderQueryResponse,ErrorResponse>	_ENDPOINT	Endpoint "search_application.render_query".

Method Summary

Modifier and Type	Method	Description
final String	name()	Required - The name of the search application to render teh query for.
static RenderQueryRequest	of(Function<RenderQueryRequest.Builder,ObjectBuilder<RenderQueryRequest>> fn)
final Map<String,JsonData>	params()	API name: params
RenderQueryRequest.Builder	rebuild()
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	setupRenderQueryRequestDeserializer(ObjectDeserializer<RenderQueryRequest.Builder> op)

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<RenderQueryRequest> _DESERIALIZER

Json deserializer for RenderQueryRequest

_ENDPOINT

public static final Endpoint<RenderQueryRequest,RenderQueryResponse,ErrorResponse> _ENDPOINT

Endpoint "search_application.render_query".

Method Details

of

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

name

public final String name()

Required - The name of the search application to render teh query for.

API name: name

params

public final Map<String,JsonData> params()

API name: params

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)

rebuild

public RenderQueryRequest.Builder rebuild()

Returns:

New RenderQueryRequest.Builder initialized with field values of this instance

setupRenderQueryRequestDeserializer

protected static void setupRenderQueryRequestDeserializer(ObjectDeserializer<RenderQueryRequest.Builder> op)