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

Class TemplateConfig.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<TemplateConfig>

Enclosing class:

TemplateConfig

public static class TemplateConfig.Builder
extends ObjectBuilderBase
implements ObjectBuilder<TemplateConfig>

Builder for TemplateConfig.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TemplateConfig	build()	Builds a TemplateConfig.
TemplateConfig.Builder	explain(java.lang.Boolean value)	API name: explain
TemplateConfig.Builder	id(java.lang.String value)	ID of the search template to use.
TemplateConfig.Builder	params(java.lang.String key, JsonData value)	API name: params
TemplateConfig.Builder	params(java.util.Map<java.lang.String,JsonData> map)	API name: params
TemplateConfig.Builder	profile(java.lang.Boolean value)	API name: profile
TemplateConfig.Builder	source(java.lang.String value)	An inline search template.

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

explain

public final TemplateConfig.Builder explain(@Nullable
                                            java.lang.Boolean value)

API name: explain

id

public final TemplateConfig.Builder id(@Nullable
                                       java.lang.String value)

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

API name: id

params

public final TemplateConfig.Builder params(java.util.Map<java.lang.String,JsonData> map)

API name: params

Adds all entries of map to params.

params

public final TemplateConfig.Builder params(java.lang.String key,
                                           JsonData value)

API name: params

Adds an entry to params.

profile

public final TemplateConfig.Builder profile(@Nullable
                                            java.lang.Boolean value)

API name: profile

source

public final TemplateConfig.Builder source(@Nullable
                                           java.lang.String value)

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

build

public TemplateConfig build()

Builds a TemplateConfig.

Specified by:

build in interface ObjectBuilder<TemplateConfig>

Throws:

java.lang.NullPointerException - if some of the required fields are null.