Package org.opensearch.client.opensearch.core

Class RenderSearchTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.RenderSearchTemplateRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RenderSearchTemplateRequest.Builder,RenderSearchTemplateRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class RenderSearchTemplateRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<RenderSearchTemplateRequest.Builder,RenderSearchTemplateRequest>

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._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
static RenderSearchTemplateRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	id()	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 String	source()	An inline search template.
RenderSearchTemplateRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

id

@Nullable
public final String id()

ID of the search template to render. If no source is specified, this or the id request body parameter is required.

API name: id

params

@Nonnull
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 String source()

An inline search template. Supports the same parameters as the search API 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)

toBuilder

@Nonnull
public RenderSearchTemplateRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RenderSearchTemplateRequest.Builder,RenderSearchTemplateRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static RenderSearchTemplateRequest.Builder builder()

setupRenderSearchTemplateRequestDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object