Package org.opensearch.client.opensearch.core

Class RenderSearchTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<RenderSearchTemplateRequest.Builder>

org.opensearch.client.opensearch.core.RenderSearchTemplateRequest.Builder

All Implemented Interfaces:

CopyableBuilder<RenderSearchTemplateRequest.Builder,RenderSearchTemplateRequest>, MutableBuilder<RenderSearchTemplateRequest.Builder,RenderSearchTemplateRequest>, ObjectBuilder<RenderSearchTemplateRequest>

Enclosing class:

RenderSearchTemplateRequest

public static class RenderSearchTemplateRequest.Builder
extends RequestBase.AbstractBuilder<RenderSearchTemplateRequest.Builder>
implements CopyableBuilder<RenderSearchTemplateRequest.Builder,RenderSearchTemplateRequest>

Builder for RenderSearchTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RenderSearchTemplateRequest	build()	Builds a RenderSearchTemplateRequest.
RenderSearchTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RenderSearchTemplateRequest.Builder	id(String value)	ID of the search template to render.
final RenderSearchTemplateRequest.Builder	params(String key, JsonData value)	Key-value pairs used to replace Mustache variables in the template.
final RenderSearchTemplateRequest.Builder	params(Map<String,JsonData> map)	Key-value pairs used to replace Mustache variables in the template.
protected RenderSearchTemplateRequest.Builder	self()
final RenderSearchTemplateRequest.Builder	source(String value)	An inline search template.

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public RenderSearchTemplateRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<RenderSearchTemplateRequest.Builder,RenderSearchTemplateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected RenderSearchTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RenderSearchTemplateRequest.Builder>

id

@Nonnull
public final RenderSearchTemplateRequest.Builder id(@Nullable
 String value)

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 RenderSearchTemplateRequest.Builder params(Map<String,JsonData> map)

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

Adds all elements of map to params.

params

@Nonnull
public final RenderSearchTemplateRequest.Builder params(String key,
 JsonData value)

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

Adds an entry to params.

source

@Nonnull
public final RenderSearchTemplateRequest.Builder source(@Nullable
 String value)

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

build

@Nonnull
public RenderSearchTemplateRequest build()

Builds a RenderSearchTemplateRequest.

Specified by:

build in interface ObjectBuilder<RenderSearchTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.