Package org.opensearch.client.opensearch.core.msearch_template

Class TemplateConfig

java.lang.Object

org.opensearch.client.opensearch.core.msearch_template.TemplateConfig

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class TemplateConfig
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<TemplateConfig>	_DESERIALIZER	Json deserializer for TemplateConfig

Method Summary

Modifier and Type	Method	Description
final Boolean	explain()	API name: explain
final String	id()	ID of the search template to use.
static TemplateConfig	of(Function<TemplateConfig.Builder,ObjectBuilder<TemplateConfig>> fn)
final Map<String,JsonData>	params()	API name: params
final Boolean	profile()	API name: profile
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	setupTemplateConfigDeserializer(ObjectDeserializer<TemplateConfig.Builder> op)
final String	source()	An inline search template.

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.json.PlainJsonSerializable

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TemplateConfig> _DESERIALIZER

Json deserializer for TemplateConfig

Method Details

of

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

explain

@Nullable
public final Boolean explain()

API name: explain

id

@Nullable
public final String id()

ID of the search template to use. If no source is specified, this parameter is required.

API name: id

params

public final Map<String,JsonData> params()

API name: params

profile

@Nullable
public final Boolean profile()

API name: profile

source

@Nullable
public final String source()

An inline search template. Supports the same parameters as the search API's request body. Also supports Mustache variables. If no 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)

setupTemplateConfigDeserializer

protected static void setupTemplateConfigDeserializer(ObjectDeserializer<TemplateConfig.Builder> op)