Package org.opensearch.client.opensearch.core

Class MsearchTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.MsearchTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<MsearchTemplateRequest>

Enclosing class:

MsearchTemplateRequest

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

Builder for MsearchTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MsearchTemplateRequest	build()	Builds a MsearchTemplateRequest.
MsearchTemplateRequest.Builder	ccsMinimizeRoundtrips(java.lang.Boolean value)	Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
MsearchTemplateRequest.Builder	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index names to use as default
MsearchTemplateRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index names to use as default
MsearchTemplateRequest.Builder	maxConcurrentSearches(java.lang.Long value)	Controls the maximum number of concurrent searches the multi search api will execute
MsearchTemplateRequest.Builder	searchTemplates(java.util.function.Function<RequestItem.Builder,ObjectBuilder<RequestItem>> fn)	Required - Request body.
MsearchTemplateRequest.Builder	searchTemplates(java.util.List<RequestItem> list)	Required - Request body.
MsearchTemplateRequest.Builder	searchTemplates(RequestItem value, RequestItem... values)	Required - Request body.
MsearchTemplateRequest.Builder	searchType(SearchType value)	Search operation type

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

ccsMinimizeRoundtrips

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

Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

API name: ccs_minimize_roundtrips

index

public final MsearchTemplateRequest.Builder index(java.util.List<java.lang.String> list)

A comma-separated list of index names to use as default

API name: index

Adds all elements of list to index.

index

public final MsearchTemplateRequest.Builder index(java.lang.String value,
                                                  java.lang.String... values)

A comma-separated list of index names to use as default

API name: index

Adds one or more values to index.

maxConcurrentSearches

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

Controls the maximum number of concurrent searches the multi search api will execute

API name: max_concurrent_searches

searchType

public final MsearchTemplateRequest.Builder searchType(@Nullable
                                                       SearchType value)

Search operation type

API name: search_type

searchTemplates

public final MsearchTemplateRequest.Builder searchTemplates(java.util.List<RequestItem> list)

Required - Request body.

API name: _value_body

Adds all elements of list to searchTemplates.

searchTemplates

public final MsearchTemplateRequest.Builder searchTemplates(RequestItem value,
                                                            RequestItem... values)

Required - Request body.

API name: _value_body

Adds one or more values to searchTemplates.

searchTemplates

public final MsearchTemplateRequest.Builder searchTemplates(java.util.function.Function<RequestItem.Builder,ObjectBuilder<RequestItem>> fn)

Required - Request body.

API name: _value_body

Adds a value to searchTemplates using a builder lambda.

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.