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
MultisearchHeader.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
MultisearchHeader	build()	Builds a MultisearchHeader.
MultisearchHeader.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	API name: expand_wildcards
MultisearchHeader.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	API name: expand_wildcards
MultisearchHeader.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
MultisearchHeader.Builder	index(java.lang.String value, java.lang.String... values)	API name: index
MultisearchHeader.Builder	index(java.util.List<java.lang.String> list)	API name: index
MultisearchHeader.Builder	preference(java.lang.String value)	API name: preference
MultisearchHeader.Builder	requestCache(java.lang.Boolean value)	API name: request_cache
MultisearchHeader.Builder	routing(java.lang.String value)	API name: routing
MultisearchHeader.Builder	searchType(SearchType value)	API name: search_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

allowNoIndices

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

API name: allow_no_indices

expandWildcards

public final MultisearchHeader.Builder expandWildcards(java.util.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
                                                         java.lang.Boolean value)

API name: ignore_unavailable

index

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

API name: index

Adds all elements of list to index.

index

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

API name: index

Adds one or more values to index.

preference

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

API name: preference

requestCache

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

API name: request_cache

routing

public final MultisearchHeader.Builder routing(@Nullable
                                               java.lang.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:

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