TemplateConfig (java-client 7.16.3 API)

java.lang.Object

co.elastic.clients.elasticsearch.core.msearch_template.TemplateConfig

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class TemplateConfig
extends java.lang.Object
implements JsonpSerializable

See Also:: API specification

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 JsonpDeserializer<TemplateConfig> _DESERIALIZER
Json deserializer for TemplateConfig

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<TemplateConfig> _DESERIALIZER
  
  Json deserializer for TemplateConfig
Method Details
- of
  
  public static TemplateConfig of(java.util.function.Function<TemplateConfig.Builder,ObjectBuilder<TemplateConfig>> fn)
- explain
  
  @Nullable public final java.lang.Boolean explain()
  
  API name: explain
- id
  
  @Nullable public final java.lang.String id()
  
  ID of the search template to use. If no source is specified, this parameter is required.
  API name: id
- params
  
  public final java.util.Map<java.lang.String,JsonData> params()
  
  API name: params
- profile
  
  @Nullable public final java.lang.Boolean profile()
  
  API name: profile
- source
  
  @Nullable public final java.lang.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)