Package co.elastic.clients.elasticsearch.core.msearch_template

Class TemplateConfig

java.lang.Object
co.elastic.clients.elasticsearch.core.msearch_template.TemplateConfig
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class TemplateConfig extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • explain

      @Nullable public final Boolean explain()
      If true, returns detailed information about score calculation as part of each hit.

      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()
      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

    • profile

      @Nullable public final Boolean profile()
      If true, the query execution is profiled.

      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)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupTemplateConfigDeserializer

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