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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aTemplateConfig.final TemplateConfig.BuilderAPI name:explainfinal TemplateConfig.BuilderID of the search template to use.final TemplateConfig.BuilderAPI name:paramsfinal TemplateConfig.BuilderAPI name:paramsfinal TemplateConfig.BuilderAPI name:profilefinal TemplateConfig.BuilderAn inline search template.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
explain
API name:explain -
id
ID of the search template to use. If no source is specified, this parameter is required.API name:
id -
params
API name:paramsAdds all entries of
maptoparams. -
params
API name:paramsAdds an entry to
params. -
profile
API name:profile -
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 -
build
Builds aTemplateConfig.- Specified by:
buildin interfaceObjectBuilder<TemplateConfig>- Throws:
NullPointerException- if some of the required fields are null.
-