Package org.opensearch.client.opensearch._global

Class MsearchTemplateRequest.Builder

java.lang.Object

org.opensearch.client.opensearch._global.MsearchTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<MsearchTemplateRequest>

Enclosing class:

MsearchTemplateRequest

public static class MsearchTemplateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<MsearchTemplateRequest>

Builder for MsearchTemplateRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MsearchTemplateRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
MsearchTemplateRequest.Builder	addType(java.lang.String value)	Add a value to type(List), creating the list if needed.
MsearchTemplateRequest.Builder	addValue(java.util.function.Function<TemplateItem.Builder,ObjectBuilder<TemplateItem>> fn)	Add a value to value(List), creating the list if needed.
MsearchTemplateRequest.Builder	addValue(TemplateItem value)	Add a value to value(List), creating the list if needed.
MsearchTemplateRequest	build()	Builds a MsearchTemplateRequest.
MsearchTemplateRequest.Builder	ccsMinimizeRoundtrips(java.lang.Boolean value)	API name: ccs_minimize_roundtrips
MsearchTemplateRequest.Builder	index(java.lang.String... value)	API name: index
MsearchTemplateRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
MsearchTemplateRequest.Builder	maxConcurrentSearches(java.lang.Number value)	API name: max_concurrent_searches
MsearchTemplateRequest.Builder	restTotalHitsAsInt(java.lang.Boolean value)	API name: rest_total_hits_as_int
MsearchTemplateRequest.Builder	searchType(jakarta.json.JsonValue value)	API name: search_type
MsearchTemplateRequest.Builder	type(java.lang.String... value)	API name: type
MsearchTemplateRequest.Builder	type(java.util.List<java.lang.String> value)	API name: type
MsearchTemplateRequest.Builder	typedKeys(java.lang.Boolean value)	API name: typed_keys
MsearchTemplateRequest.Builder	value(java.util.function.Function<TemplateItem.Builder,ObjectBuilder<TemplateItem>> fn)	Set value(List) to a singleton list.
MsearchTemplateRequest.Builder	value(java.util.List<TemplateItem> value)	Request body.
MsearchTemplateRequest.Builder	value(TemplateItem... value)	Request body.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

public MsearchTemplateRequest.Builder index(@Nullable java.util.List<java.lang.String> value)

API name: index

index

public MsearchTemplateRequest.Builder index(java.lang.String... value)

API name: index

addIndex

public MsearchTemplateRequest.Builder addIndex(java.lang.String value)

Add a value to index(List), creating the list if needed.

type

public MsearchTemplateRequest.Builder type(@Nullable java.util.List<java.lang.String> value)

API name: type

type

public MsearchTemplateRequest.Builder type(java.lang.String... value)

API name: type

addType

public MsearchTemplateRequest.Builder addType(java.lang.String value)

Add a value to type(List), creating the list if needed.

ccsMinimizeRoundtrips

public MsearchTemplateRequest.Builder ccsMinimizeRoundtrips(@Nullable java.lang.Boolean value)

API name: ccs_minimize_roundtrips

maxConcurrentSearches

public MsearchTemplateRequest.Builder maxConcurrentSearches(@Nullable java.lang.Number value)

API name: max_concurrent_searches

searchType

public MsearchTemplateRequest.Builder searchType(@Nullable jakarta.json.JsonValue value)

API name: search_type

restTotalHitsAsInt

public MsearchTemplateRequest.Builder restTotalHitsAsInt(@Nullable java.lang.Boolean value)

API name: rest_total_hits_as_int

typedKeys

public MsearchTemplateRequest.Builder typedKeys(@Nullable java.lang.Boolean value)

API name: typed_keys

value

public MsearchTemplateRequest.Builder value(java.util.List<TemplateItem> value)

Request body. API name: value

value

public MsearchTemplateRequest.Builder value(TemplateItem... value)

Request body. API name: value

addValue

public MsearchTemplateRequest.Builder addValue(TemplateItem value)

Add a value to value(List), creating the list if needed.

value

public MsearchTemplateRequest.Builder value(java.util.function.Function<TemplateItem.Builder,ObjectBuilder<TemplateItem>> fn)

Set value(List) to a singleton list.

addValue

public MsearchTemplateRequest.Builder addValue(java.util.function.Function<TemplateItem.Builder,ObjectBuilder<TemplateItem>> fn)

Add a value to value(List), creating the list if needed.

build

public MsearchTemplateRequest build()

Builds a MsearchTemplateRequest.

Specified by:

build in interface ObjectBuilder<MsearchTemplateRequest>

Throws:

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