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

Class MultisearchBody.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.msearch.MultisearchBody.Builder

All Implemented Interfaces:

ObjectBuilder<MultisearchBody>

Enclosing class:

MultisearchBody

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

Builder for MultisearchBody.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MultisearchBody.Builder	aggregations(java.lang.String key, java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)	API name: aggregations
MultisearchBody.Builder	aggregations(java.lang.String key, Aggregation value)	API name: aggregations
MultisearchBody.Builder	aggregations(java.util.Map<java.lang.String,Aggregation> map)	API name: aggregations
MultisearchBody	build()	Builds a MultisearchBody.
MultisearchBody.Builder	from(java.lang.Integer value)	API name: from
MultisearchBody.Builder	highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
MultisearchBody.Builder	highlight(Highlight value)	API name: highlight
MultisearchBody.Builder	minScore(java.lang.Double value)	Minimum _score for matching documents.
MultisearchBody.Builder	postFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: post_filter
MultisearchBody.Builder	postFilter(Query value)	API name: post_filter
MultisearchBody.Builder	query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: query
MultisearchBody.Builder	query(Query value)	API name: query
MultisearchBody.Builder	scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	API name: script_fields
MultisearchBody.Builder	scriptFields(java.lang.String key, ScriptField value)	API name: script_fields
MultisearchBody.Builder	scriptFields(java.util.Map<java.lang.String,ScriptField> map)	API name: script_fields
MultisearchBody.Builder	searchAfter(java.lang.String value, java.lang.String... values)	API name: search_after
MultisearchBody.Builder	searchAfter(java.util.List<java.lang.String> list)	API name: search_after
MultisearchBody.Builder	size(java.lang.Integer value)	API name: size
MultisearchBody.Builder	sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
MultisearchBody.Builder	sort(java.util.List<SortOptions> list)	API name: sort
MultisearchBody.Builder	sort(SortOptions value, SortOptions... values)	API name: sort
MultisearchBody.Builder	source(java.util.function.Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	API name: _source
MultisearchBody.Builder	source(SourceConfig value)	API name: _source
MultisearchBody.Builder	suggest(java.util.function.Function<Suggester.Builder,ObjectBuilder<Suggester>> fn)	API name: suggest
MultisearchBody.Builder	suggest(Suggester value)	API name: suggest
MultisearchBody.Builder	trackScores(java.lang.Boolean value)	If true, calculate and return document scores, even if the scores are not used for sorting.
MultisearchBody.Builder	trackTotalHits(java.util.function.Function<TrackHits.Builder,ObjectBuilder<TrackHits>> fn)	API name: track_total_hits
MultisearchBody.Builder	trackTotalHits(TrackHits value)	API name: track_total_hits

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

aggregations

public final MultisearchBody.Builder aggregations(java.util.Map<java.lang.String,Aggregation> map)

API name: aggregations

Adds all entries of map to aggregations.

aggregations

public final MultisearchBody.Builder aggregations(java.lang.String key,
                                                  Aggregation value)

API name: aggregations

Adds an entry to aggregations.

aggregations

public final MultisearchBody.Builder aggregations(java.lang.String key,
                                                  java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)

API name: aggregations

Adds an entry to aggregations using a builder lambda.

query

public final MultisearchBody.Builder query(@Nullable
                                           Query value)

API name: query

query

public final MultisearchBody.Builder query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: query

from

public final MultisearchBody.Builder from(@Nullable
                                          java.lang.Integer value)

API name: from

minScore

public final MultisearchBody.Builder minScore(@Nullable
                                              java.lang.Double value)

Minimum _score for matching documents. Documents with a lower _score are not included in the search results.

API name: min_score

postFilter

public final MultisearchBody.Builder postFilter(@Nullable
                                                Query value)

API name: post_filter

postFilter

public final MultisearchBody.Builder postFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: post_filter

searchAfter

public final MultisearchBody.Builder searchAfter(java.util.List<java.lang.String> list)

API name: search_after

Adds all elements of list to searchAfter.

searchAfter

public final MultisearchBody.Builder searchAfter(java.lang.String value,
                                                 java.lang.String... values)

API name: search_after

Adds one or more values to searchAfter.

size

public final MultisearchBody.Builder size(@Nullable
                                          java.lang.Integer value)

API name: size

sort

public final MultisearchBody.Builder sort(java.util.List<SortOptions> list)

API name: sort

Adds all elements of list to sort.

sort

public final MultisearchBody.Builder sort(SortOptions value,
                                          SortOptions... values)

API name: sort

Adds one or more values to sort.

sort

public final MultisearchBody.Builder sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

API name: sort

Adds a value to sort using a builder lambda.

trackScores

public final MultisearchBody.Builder trackScores(@Nullable
                                                 java.lang.Boolean value)

If true, calculate and return document scores, even if the scores are not used for sorting.

API name: track_scores

trackTotalHits

public final MultisearchBody.Builder trackTotalHits(@Nullable
                                                    TrackHits value)

API name: track_total_hits

trackTotalHits

public final MultisearchBody.Builder trackTotalHits(java.util.function.Function<TrackHits.Builder,ObjectBuilder<TrackHits>> fn)

API name: track_total_hits

suggest

public final MultisearchBody.Builder suggest(@Nullable
                                             Suggester value)

API name: suggest

suggest

public final MultisearchBody.Builder suggest(java.util.function.Function<Suggester.Builder,ObjectBuilder<Suggester>> fn)

API name: suggest

highlight

public final MultisearchBody.Builder highlight(@Nullable
                                               Highlight value)

API name: highlight

highlight

public final MultisearchBody.Builder highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)

API name: highlight

source

public final MultisearchBody.Builder source(@Nullable
                                            SourceConfig value)

API name: _source

source

public final MultisearchBody.Builder source(java.util.function.Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)

API name: _source

scriptFields

public final MultisearchBody.Builder scriptFields(java.util.Map<java.lang.String,ScriptField> map)

API name: script_fields

scriptFields

public final MultisearchBody.Builder scriptFields(java.lang.String key,
                                                  ScriptField value)

API name: script_fields

scriptFields

public final MultisearchBody.Builder scriptFields(java.lang.String key,
                                                  java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)

API name: script_fields

build

public MultisearchBody build()

Builds a MultisearchBody.

Specified by:

build in interface ObjectBuilder<MultisearchBody>

Throws:

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