RenderSearchTemplateRequest (java-client 7.17.5 API)

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

Allows to use the Mustache language to pre-render a search definition.

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 JsonpDeserializer<RenderSearchTemplateRequest>`	`_DESERIALIZER`	Json deserializer for `RenderSearchTemplateRequest`
`static Endpoint<RenderSearchTemplateRequest,RenderSearchTemplateResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`render_search_template`".

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`file()`	API name: `file`
`java.lang.String`	`id()`	The id of the stored search template
`static RenderSearchTemplateRequest`	`of(java.util.function.Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)`
`java.util.Map<java.lang.String,JsonData>`	`params()`	API name: `params`
`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)`
`java.lang.String`	`source()`	API name: `source`

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(java.util.function.Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)
- file
  
  @Nullable public final java.lang.String file()
  
  API name: file
- id
  
  @Nullable public final java.lang.String id()
  
  The id of the stored search template
  API name: id
- params
  
  public final java.util.Map<java.lang.String,JsonData> params()
  
  API name: params
- source
  
  @Nullable public final java.lang.String source()
  
  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)