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	collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)	API name: collapse
MultisearchBody.Builder	collapse(FieldCollapse value)	API name: collapse
MultisearchBody.Builder	docvalueFields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)	Array of wildcard (*) patterns.
MultisearchBody.Builder	docvalueFields(java.util.List<FieldAndFormat> list)	Array of wildcard (*) patterns.
MultisearchBody.Builder	docvalueFields(FieldAndFormat value, FieldAndFormat... values)	Array of wildcard (*) patterns.
MultisearchBody.Builder	explain(java.lang.Boolean value)	If true, returns detailed information about score computation as part of a hit.
MultisearchBody.Builder	ext(java.lang.String key, JsonData value)	API name: ext
MultisearchBody.Builder	ext(java.util.Map<java.lang.String,JsonData> map)	API name: ext
MultisearchBody.Builder	fields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)	Array of wildcard (*) patterns.
MultisearchBody.Builder	fields(java.util.List<FieldAndFormat> list)	Array of wildcard (*) patterns.
MultisearchBody.Builder	fields(FieldAndFormat value, FieldAndFormat... values)	Array of wildcard (*) patterns.
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	indicesBoost(java.util.List<java.util.Map<java.lang.String,java.lang.Double>> list)	Boosts the _score of documents from specified indices.
MultisearchBody.Builder	indicesBoost(java.util.Map<java.lang.String,java.lang.Double> value, java.util.Map<java.lang.String,java.lang.Double>... values)	Boosts the _score of documents from specified indices.
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	rescore(java.util.function.Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)	API name: rescore
MultisearchBody.Builder	rescore(java.util.List<Rescore> list)	API name: rescore
MultisearchBody.Builder	rescore(Rescore value, Rescore... values)	API name: rescore
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	searchAfterVals(java.util.List<FieldValue> list)	API name: search_after
MultisearchBody.Builder	searchAfterVals(FieldValue value, FieldValue... values)	API name: search_after
MultisearchBody.Builder	seqNoPrimaryTerm(java.lang.Boolean value)	If true, returns sequence number and primary term of the last modification of each hit.
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	storedFields(java.lang.String value, java.lang.String... values)	List of stored fields to return as part of a hit.
MultisearchBody.Builder	storedFields(java.util.List<java.lang.String> list)	List of stored fields to return as part of a hit.
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	timeout(java.lang.String value)	Specifies the period of time to wait for a response from each shard.
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
MultisearchBody.Builder	version(java.lang.Boolean value)	If true, returns document version as part of a hit.

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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.

NOTE: In version 3.0.0 of opensearch-java, this method will instead accept a List<FieldValue>.

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.

NOTE: In version 3.0.0 of opensearch-java, this method will instead accept values of type FieldValue.

searchAfterVals

public final MultisearchBody.Builder searchAfterVals(java.util.List<FieldValue> list)

API name: search_after

Adds all elements of list to searchAfter.

NOTE: In version 3.0.0 of opensearch-java, this method will be renamed to replace searchAfter(List).

searchAfterVals

public final MultisearchBody.Builder searchAfterVals(FieldValue value,
                                                     FieldValue... values)

API name: search_after

Adds one or more values to searchAfter.

NOTE: In version 3.0.0 of opensearch-java, this method will be renamed to replace searchAfter(String, String...).

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

seqNoPrimaryTerm

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

If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.

API name: seq_no_primary_term

storedFields

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

List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

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

List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.

API name: stored_fields

Adds one or more values to storedFields.

explain

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

If true, returns detailed information about score computation as part of a hit.

API name: explain

fields

public final MultisearchBody.Builder fields(java.util.List<FieldAndFormat> list)

Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

API name: fields

Adds all elements of list to fields.

fields

public final MultisearchBody.Builder fields(FieldAndFormat value,
                                            FieldAndFormat... values)

Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

API name: fields

Adds one or more values to fields.

fields

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

Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

API name: fields

Adds a value to fields using a builder lambda.

docvalueFields

public final MultisearchBody.Builder docvalueFields(java.util.List<FieldAndFormat> list)

Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

API name: docvalue_fields

Adds all elements of list to docvalueFields.

docvalueFields

public final MultisearchBody.Builder docvalueFields(FieldAndFormat value,
                                                    FieldAndFormat... values)

Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

API name: docvalue_fields

Adds one or more values to docvalueFields.

docvalueFields

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

Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

API name: docvalue_fields

Adds a value to docvalueFields using a builder lambda.

indicesBoost

public final MultisearchBody.Builder indicesBoost(java.util.List<java.util.Map<java.lang.String,java.lang.Double>> list)

Boosts the _score of documents from specified indices.

API name: indices_boost

Adds all elements of list to indicesBoost.

indicesBoost

public final MultisearchBody.Builder indicesBoost(java.util.Map<java.lang.String,java.lang.Double> value,
                                                  java.util.Map<java.lang.String,java.lang.Double>... values)

Boosts the _score of documents from specified indices.

API name: indices_boost

Adds one or more values to indicesBoost.

collapse

public final MultisearchBody.Builder collapse(@Nullable
                                              FieldCollapse value)

API name: collapse

collapse

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

API name: collapse

version

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

If true, returns document version as part of a hit.

API name: version

timeout

public final MultisearchBody.Builder timeout(@Nullable
                                             java.lang.String value)

Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.

API name: timeout

rescore

public final MultisearchBody.Builder rescore(java.util.List<Rescore> list)

API name: rescore

Adds all elements of list to rescore.

rescore

public final MultisearchBody.Builder rescore(Rescore value,
                                             Rescore... values)

API name: rescore

Adds one or more values to rescore.

rescore

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

API name: rescore

Adds a value to rescore using a builder lambda.

ext

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

API name: ext

Adds all entries of map to ext.

ext

public final MultisearchBody.Builder ext(java.lang.String key,
                                         JsonData value)

API name: ext

Adds an entry to ext.

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.