Package co.elastic.clients.elasticsearch.core.msearch

Class MultisearchHeader.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<MultisearchHeader.Builder>

co.elastic.clients.elasticsearch.core.msearch.MultisearchHeader.Builder

All Implemented Interfaces:

WithJson<MultisearchHeader.Builder>, ObjectBuilder<MultisearchHeader>

Enclosing class:

MultisearchHeader

public static class MultisearchHeader.Builder
extends WithJsonObjectBuilderBase<MultisearchHeader.Builder>
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)	A setting that does two separate checks on the index expression.
final MultisearchHeader.Builder	allowPartialSearchResults(Boolean value)	API name: allow_partial_search_results
MultisearchHeader	build()	Builds a MultisearchHeader.
final MultisearchHeader.Builder	ccsMinimizeRoundtrips(Boolean value)	API name: ccs_minimize_roundtrips
final MultisearchHeader.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	API name: expand_wildcards
final MultisearchHeader.Builder	expandWildcards(List<ExpandWildcard> list)	API name: expand_wildcards
final MultisearchHeader.Builder	ignoreThrottled(Boolean value)	API name: ignore_throttled
final MultisearchHeader.Builder	ignoreUnavailable(Boolean value)	If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise 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	projectRouting(String value)	API name: project_routing
final MultisearchHeader.Builder	requestCache(Boolean value)	API name: request_cache
final MultisearchHeader.Builder	routing(String value, String... values)	API name: routing
final MultisearchHeader.Builder	routing(List<String> list)	API name: routing
final MultisearchHeader.Builder	searchType(SearchType value)	API name: search_type
protected MultisearchHeader.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoIndices

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

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

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)

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

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

projectRouting

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

API name: project_routing

requestCache

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

API name: request_cache

routing

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

API name: routing

Adds all elements of list to routing.

routing

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

API name: routing

Adds one or more values to routing.

searchType

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

API name: search_type

ccsMinimizeRoundtrips

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

API name: ccs_minimize_roundtrips

allowPartialSearchResults

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

API name: allow_partial_search_results

ignoreThrottled

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

API name: ignore_throttled

self

protected MultisearchHeader.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<MultisearchHeader.Builder>

build

public MultisearchHeader build()

Builds a MultisearchHeader.

Specified by:

build in interface ObjectBuilder<MultisearchHeader>

Throws:

NullPointerException - if some of the required fields are null.