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

Class MultisearchBody.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

WithJson<MultisearchBody.Builder>, ObjectBuilder<MultisearchBody>

Enclosing class:

MultisearchBody

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

Builder for MultisearchBody.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MultisearchBody.Builder	aggregations(String key, Aggregation value)	API name: aggregations
final MultisearchBody.Builder	aggregations(String key, Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)	API name: aggregations
final MultisearchBody.Builder	aggregations(Map<String,Aggregation> map)	API name: aggregations
MultisearchBody	build()	Builds a MultisearchBody.
final MultisearchBody.Builder	collapse(FieldCollapse value)	API name: collapse
final MultisearchBody.Builder	collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)	API name: collapse
final MultisearchBody.Builder	docvalueFields(FieldAndFormat value, FieldAndFormat... values)	Array of wildcard (*) patterns.
final MultisearchBody.Builder	docvalueFields(Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)	Array of wildcard (*) patterns.
final MultisearchBody.Builder	docvalueFields(List<FieldAndFormat> list)	Array of wildcard (*) patterns.
final MultisearchBody.Builder	explain(Boolean value)	If true, returns detailed information about score computation as part of a hit.
final MultisearchBody.Builder	ext(String key, JsonData value)	Configuration of search extensions defined by Elasticsearch plugins.
final MultisearchBody.Builder	ext(Map<String,JsonData> map)	Configuration of search extensions defined by Elasticsearch plugins.
final MultisearchBody.Builder	fields(FieldAndFormat value, FieldAndFormat... values)	Array of wildcard (*) patterns.
final MultisearchBody.Builder	fields(Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)	Array of wildcard (*) patterns.
final MultisearchBody.Builder	fields(List<FieldAndFormat> list)	Array of wildcard (*) patterns.
final MultisearchBody.Builder	from(Integer value)	Starting document offset.
final MultisearchBody.Builder	highlight(Highlight value)	API name: highlight
final MultisearchBody.Builder	highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
final MultisearchBody.Builder	indicesBoost(List<Map<String,Double>> list)	Boosts the _score of documents from specified indices.
final MultisearchBody.Builder	indicesBoost(Map<String,Double> value, Map<String,Double>... values)	Boosts the _score of documents from specified indices.
final MultisearchBody.Builder	minScore(Double value)	Minimum _score for matching documents.
final MultisearchBody.Builder	pit(PointInTimeReference value)	Limits the search to a point in time (PIT).
final MultisearchBody.Builder	pit(Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)	Limits the search to a point in time (PIT).
final MultisearchBody.Builder	postFilter(Query value)	API name: post_filter
final MultisearchBody.Builder	postFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: post_filter
final MultisearchBody.Builder	profile(Boolean value)	API name: profile
final MultisearchBody.Builder	query(Query value)	Defines the search definition using the Query DSL.
final MultisearchBody.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	Defines the search definition using the Query DSL.
final MultisearchBody.Builder	rescore(Rescore value, Rescore... values)	API name: rescore
final MultisearchBody.Builder	rescore(Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)	API name: rescore
final MultisearchBody.Builder	rescore(List<Rescore> list)	API name: rescore
final MultisearchBody.Builder	runtimeMappings(String key, RuntimeField value)	Defines one or more runtime fields in the search request.
final MultisearchBody.Builder	runtimeMappings(String key, Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)	Defines one or more runtime fields in the search request.
final MultisearchBody.Builder	runtimeMappings(Map<String,RuntimeField> map)	Defines one or more runtime fields in the search request.
final MultisearchBody.Builder	scriptFields(String key, ScriptField value)	Retrieve a script evaluation (based on different fields) for each hit.
final MultisearchBody.Builder	scriptFields(String key, Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	Retrieve a script evaluation (based on different fields) for each hit.
final MultisearchBody.Builder	scriptFields(Map<String,ScriptField> map)	Retrieve a script evaluation (based on different fields) for each hit.
final MultisearchBody.Builder	searchAfter(FieldValue value, FieldValue... values)	API name: search_after
final MultisearchBody.Builder	searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: search_after
final MultisearchBody.Builder	searchAfter(List<FieldValue> list)	API name: search_after
protected MultisearchBody.Builder	self()
final MultisearchBody.Builder	seqNoPrimaryTerm(Boolean value)	If true, returns sequence number and primary term of the last modification of each hit.
final MultisearchBody.Builder	size(Integer value)	The number of hits to return.
final MultisearchBody.Builder	sort(SortOptions value, SortOptions... values)	API name: sort
final MultisearchBody.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
final MultisearchBody.Builder	sort(List<SortOptions> list)	API name: sort
final MultisearchBody.Builder	source(SourceConfig value)	Indicates which source fields are returned for matching documents.
final MultisearchBody.Builder	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	Indicates which source fields are returned for matching documents.
final MultisearchBody.Builder	stats(String value, String... values)	Stats groups to associate with the search.
final MultisearchBody.Builder	stats(List<String> list)	Stats groups to associate with the search.
final MultisearchBody.Builder	storedFields(String value, String... values)	List of stored fields to return as part of a hit.
final MultisearchBody.Builder	storedFields(List<String> list)	List of stored fields to return as part of a hit.
final MultisearchBody.Builder	suggest(Suggester value)	API name: suggest
final MultisearchBody.Builder	suggest(Function<Suggester.Builder,ObjectBuilder<Suggester>> fn)	API name: suggest
final MultisearchBody.Builder	terminateAfter(Long value)	Maximum number of documents to collect for each shard.
final MultisearchBody.Builder	timeout(String value)	Specifies the period of time to wait for a response from each shard.
final MultisearchBody.Builder	trackScores(Boolean value)	If true, calculate and return document scores, even if the scores are not used for sorting.
final MultisearchBody.Builder	trackTotalHits(TrackHits value)	Number of hits matching the query to count accurately.
final MultisearchBody.Builder	trackTotalHits(Function<TrackHits.Builder,ObjectBuilder<TrackHits>> fn)	Number of hits matching the query to count accurately.
final MultisearchBody.Builder	version(Boolean value)	If true, returns document version as part of a hit.

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

aggregations

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

API name: aggregations

Adds all entries of map to aggregations.

aggregations

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

API name: aggregations

Adds an entry to aggregations.

aggregations

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

API name: aggregations

Adds an entry to aggregations using a builder lambda.

collapse

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

API name: collapse

collapse

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

API name: collapse

query

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

Defines the search definition using the Query DSL.

API name: query

query

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

Defines the search definition using the Query DSL.

API name: query

explain

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

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

API name: explain

ext

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

Configuration of search extensions defined by Elasticsearch plugins.

API name: ext

Adds all entries of map to ext.

ext

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

Configuration of search extensions defined by Elasticsearch plugins.

API name: ext

Adds an entry to ext.

storedFields

public final MultisearchBody.Builder storedFields(List<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(String value,
 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.

docvalueFields

public final MultisearchBody.Builder docvalueFields(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(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.

from

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

Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

API name: from

highlight

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

API name: highlight

highlight

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

API name: highlight

indicesBoost

public final MultisearchBody.Builder indicesBoost(List<Map<String,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(Map<String,Double> value,
 Map<String,Double>... values)

Boosts the _score of documents from specified indices.

API name: indices_boost

Adds one or more values to indicesBoost.

minScore

public final MultisearchBody.Builder minScore(@Nullable
 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(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: post_filter

profile

public final MultisearchBody.Builder profile(@Nullable
 Boolean value)

API name: profile

rescore

public final MultisearchBody.Builder rescore(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(Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)

API name: rescore

Adds a value to rescore using a builder lambda.

scriptFields

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

Retrieve a script evaluation (based on different fields) for each hit.

API name: script_fields

Adds all entries of map to scriptFields.

scriptFields

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

Retrieve a script evaluation (based on different fields) for each hit.

API name: script_fields

Adds an entry to scriptFields.

scriptFields

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

Retrieve a script evaluation (based on different fields) for each hit.

API name: script_fields

Adds an entry to scriptFields using a builder lambda.

searchAfter

public final MultisearchBody.Builder searchAfter(List<FieldValue> list)

API name: search_after

Adds all elements of list to searchAfter.

searchAfter

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

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final MultisearchBody.Builder searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

API name: search_after

Adds a value to searchAfter using a builder lambda.

size

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

The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

API name: size

sort

public final MultisearchBody.Builder sort(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(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

API name: sort

Adds a value to sort using a builder lambda.

source

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

Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.

API name: _source

source

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

Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response.

API name: _source

fields

public final MultisearchBody.Builder fields(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(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.

terminateAfter

public final MultisearchBody.Builder terminateAfter(@Nullable
 Long value)

Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early.

API name: terminate_after

stats

public final MultisearchBody.Builder stats(List<String> list)

Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.

API name: stats

Adds all elements of list to stats.

stats

public final MultisearchBody.Builder stats(String value,
 String... values)

Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.

API name: stats

Adds one or more values to stats.

timeout

public final MultisearchBody.Builder timeout(@Nullable
 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

trackScores

public final MultisearchBody.Builder trackScores(@Nullable
 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)

Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.

API name: track_total_hits

trackTotalHits

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

Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.

API name: track_total_hits

version

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

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

API name: version

runtimeMappings

public final MultisearchBody.Builder runtimeMappings(Map<String,RuntimeField> map)

Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.

API name: runtime_mappings

Adds all entries of map to runtimeMappings.

runtimeMappings

public final MultisearchBody.Builder runtimeMappings(String key,
 RuntimeField value)

Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.

API name: runtime_mappings

Adds an entry to runtimeMappings.

runtimeMappings

public final MultisearchBody.Builder runtimeMappings(String key,
 Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)

Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.

API name: runtime_mappings

Adds an entry to runtimeMappings using a builder lambda.

seqNoPrimaryTerm

public final MultisearchBody.Builder seqNoPrimaryTerm(@Nullable
 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

pit

public final MultisearchBody.Builder pit(@Nullable
 PointInTimeReference value)

Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an <index> in the request path.

API name: pit

pit

public final MultisearchBody.Builder pit(Function<PointInTimeReference.Builder,ObjectBuilder<PointInTimeReference>> fn)

Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an <index> in the request path.

API name: pit

suggest

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

API name: suggest

suggest

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

API name: suggest

self

protected MultisearchBody.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<MultisearchBody.Builder>

build

public MultisearchBody build()

Builds a MultisearchBody.

Specified by:

build in interface ObjectBuilder<MultisearchBody>

Throws:

NullPointerException - if some of the required fields are null.