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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<RenderSearchTemplateRequest> Json deserializer forRenderSearchTemplateRequestEndpoint "render_search_template". -
Method Summary
Modifier and TypeMethodDescriptionbuilder()booleaninthashCode()final Stringid()ID of the search template to render.static RenderSearchTemplateRequestparams()Key-value pairs used to replace Mustache variables in the template.voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidsetupRenderSearchTemplateRequestDeserializer(ObjectDeserializer<RenderSearchTemplateRequest.Builder> op) final Stringsource()An inline search template.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
applyQueryParameters, errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forRenderSearchTemplateRequest -
_ENDPOINT
public static final Endpoint<RenderSearchTemplateRequest,RenderSearchTemplateResponse, _ENDPOINTErrorResponse> Endpoint "render_search_template".
-
-
Method Details
-
of
-
id
ID of the search template to render. If nosourceis specified, this or theidrequest body parameter is required.API name:
id -
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
An inline search template. Supports the same parameters as the search API request body. These parameters also support Mustache variables. If noidor<templated-id>is specified, this parameter is required.API name:
source -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<RenderSearchTemplateRequest.Builder,RenderSearchTemplateRequest> - Returns:
- a new builder instance.
-
builder
-
setupRenderSearchTemplateRequestDeserializer
protected static void setupRenderSearchTemplateRequestDeserializer(ObjectDeserializer<RenderSearchTemplateRequest.Builder> op) -
hashCode
public int hashCode() -
equals
-