Package org.opensearch.client.opensearch.core.msearch

Class MultisearchHeader.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.msearch.MultisearchHeader.Builder

All Implemented Interfaces:

ObjectBuilder<MultisearchHeader>

Enclosing class:

MultisearchHeader

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

Builder for MultisearchHeader.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MultisearchHeader.Builder	allowNoIndices(Boolean value)	API name: allow_no_indices
MultisearchHeader	build()	Builds a MultisearchHeader.
final MultisearchHeader.Builder	expandWildcards(List<ExpandWildcard> list)	API name: expand_wildcards
final MultisearchHeader.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	API name: expand_wildcards
final MultisearchHeader.Builder	ignoreUnavailable(Boolean value)	API name: ignore_unavailable
final MultisearchHeader.Builder	index(String value, String... values)	API name: index
final MultisearchHeader.Builder	index(List<String> list)	API name: index
final MultisearchHeader.Builder	preference(String value)	API name: preference
final MultisearchHeader.Builder	requestCache(Boolean value)	API name: request_cache
final MultisearchHeader.Builder	routing(String value)	API name: routing
final MultisearchHeader.Builder	searchType(SearchType value)	API name: search_type

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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

allowNoIndices

public final MultisearchHeader.Builder allowNoIndices(@Nullable
 Boolean value)

API name: allow_no_indices

expandWildcards

public final MultisearchHeader.Builder expandWildcards(List<ExpandWildcard> list)

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final MultisearchHeader.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

public final MultisearchHeader.Builder ignoreUnavailable(@Nullable
 Boolean value)

API name: ignore_unavailable

index

public final MultisearchHeader.Builder index(List<String> list)

API name: index

Adds all elements of list to index.

index

public final MultisearchHeader.Builder index(String value,
 String... values)

API name: index

Adds one or more values to index.

preference

public final MultisearchHeader.Builder preference(@Nullable
 String value)

API name: preference

requestCache

public final MultisearchHeader.Builder requestCache(@Nullable
 Boolean value)

API name: request_cache

routing

public final MultisearchHeader.Builder routing(@Nullable
 String value)

API name: routing

searchType

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

API name: search_type

build

public MultisearchHeader build()

Builds a MultisearchHeader.

Specified by:

build in interface ObjectBuilder<MultisearchHeader>

Throws:

NullPointerException - if some of the required fields are null.