Class MultisearchBody.Builder
- All Implemented Interfaces:
ObjectBuilder<MultisearchBody>
- Enclosing class:
MultisearchBody
MultisearchBody.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal MultisearchBody.BuilderAPI name:aggregationsfinal MultisearchBody.Builderaggregations(String key, Aggregation value) API name:aggregationsfinal MultisearchBody.Builderaggregations(Map<String, Aggregation> map) API name:aggregationsbuild()Builds aMultisearchBody.final MultisearchBody.BuilderAPI name:collapsefinal MultisearchBody.Buildercollapse(FieldCollapse value) API name:collapsefinal MultisearchBody.BuilderArray of wildcard (*) patterns.final MultisearchBody.BuilderdocvalueFields(List<FieldAndFormat> list) Array of wildcard (*) patterns.final MultisearchBody.BuilderdocvalueFields(FieldAndFormat value, FieldAndFormat... values) Array of wildcard (*) patterns.final MultisearchBody.BuilderIf true, returns detailed information about score computation as part of a hit.final MultisearchBody.BuilderAPI name:extfinal MultisearchBody.BuilderAPI name:extfinal MultisearchBody.BuilderArray of wildcard (*) patterns.final MultisearchBody.Builderfields(List<FieldAndFormat> list) Array of wildcard (*) patterns.final MultisearchBody.Builderfields(FieldAndFormat value, FieldAndFormat... values) Array of wildcard (*) patterns.final MultisearchBody.BuilderAPI name:fromfinal MultisearchBody.BuilderAPI name:highlightfinal MultisearchBody.BuilderAPI name:highlightfinal MultisearchBody.BuilderindicesBoost(List<Map<String, Double>> list) Boosts the _score of documents from specified indices.final MultisearchBody.BuilderBoosts the _score of documents from specified indices.final MultisearchBody.BuilderMinimum _score for matching documents.final MultisearchBody.BuilderAPI name:post_filterfinal MultisearchBody.BuilderpostFilter(Query value) API name:post_filterfinal MultisearchBody.BuilderAPI name:queryfinal MultisearchBody.BuilderAPI name:queryfinal MultisearchBody.BuilderAPI name:rescorefinal MultisearchBody.BuilderAPI name:rescorefinal MultisearchBody.BuilderAPI name:rescorefinal MultisearchBody.BuilderAPI name:script_fieldsfinal MultisearchBody.BuilderscriptFields(String key, ScriptField value) API name:script_fieldsfinal MultisearchBody.BuilderscriptFields(Map<String, ScriptField> map) API name:script_fieldsfinal MultisearchBody.BuildersearchAfter(List<FieldValue> list) API name:search_afterfinal MultisearchBody.BuildersearchAfter(FieldValue value, FieldValue... values) API name:search_afterfinal MultisearchBody.BuilderseqNoPrimaryTerm(Boolean value) If true, returns sequence number and primary term of the last modification of each hit.final MultisearchBody.BuilderAPI name:sizefinal MultisearchBody.BuilderAPI name:sortfinal MultisearchBody.Buildersort(List<SortOptions> list) API name:sortfinal MultisearchBody.Buildersort(SortOptions value, SortOptions... values) API name:sortfinal MultisearchBody.BuilderAPI name:_sourcefinal MultisearchBody.Buildersource(SourceConfig value) API name:_sourcefinal MultisearchBody.BuilderstoredFields(String value, String... values) List of stored fields to return as part of a hit.final MultisearchBody.BuilderstoredFields(List<String> list) List of stored fields to return as part of a hit.final MultisearchBody.BuilderAPI name:suggestfinal MultisearchBody.BuilderAPI name:suggestfinal MultisearchBody.BuilderSpecifies the period of time to wait for a response from each shard.final MultisearchBody.BuildertrackScores(Boolean value) If true, calculate and return document scores, even if the scores are not used for sorting.final MultisearchBody.BuilderAPI name:track_total_hitsfinal MultisearchBody.BuildertrackTotalHits(TrackHits value) API name:track_total_hitsfinal MultisearchBody.BuilderIf true, returns document version as part of a hit.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
aggregations
API name:aggregationsAdds all entries of
maptoaggregations. -
aggregations
API name:aggregationsAdds an entry to
aggregations. -
aggregations
public final MultisearchBody.Builder aggregations(String key, Function<Aggregation.Builder, ObjectBuilder<Aggregation>> fn) API name:aggregationsAdds an entry to
aggregationsusing a builder lambda. -
query
API name:query -
query
API name:query -
from
API name:from -
minScore
Minimum _score for matching documents. Documents with a lower _score are not included in the search results.API name:
min_score -
postFilter
API name:post_filter -
postFilter
API name:post_filter -
searchAfter
API name:search_afterAdds all elements of
listtosearchAfter. -
searchAfter
API name:search_afterAdds one or more values to
searchAfter. -
size
API name:size -
sort
API name:sortAdds all elements of
listtosort. -
sort
API name:sortAdds one or more values to
sort. -
sort
public final MultisearchBody.Builder sort(Function<SortOptions.Builder, ObjectBuilder<SortOptions>> fn) API name:sortAdds a value to
sortusing a builder lambda. -
trackScores
If true, calculate and return document scores, even if the scores are not used for sorting.API name:
track_scores -
trackTotalHits
API name:track_total_hits -
trackTotalHits
public final MultisearchBody.Builder trackTotalHits(Function<TrackHits.Builder, ObjectBuilder<TrackHits>> fn) API name:track_total_hits -
suggest
API name:suggest -
suggest
public final MultisearchBody.Builder suggest(Function<Suggester.Builder, ObjectBuilder<Suggester>> fn) API name:suggest -
highlight
API name:highlight -
highlight
public final MultisearchBody.Builder highlight(Function<Highlight.Builder, ObjectBuilder<Highlight>> fn) API name:highlight -
source
API name:_source -
source
public final MultisearchBody.Builder source(Function<SourceConfig.Builder, ObjectBuilder<SourceConfig>> fn) API name:_source -
scriptFields
API name:script_fields -
scriptFields
API name:script_fields -
scriptFields
public final MultisearchBody.Builder scriptFields(String key, Function<ScriptField.Builder, ObjectBuilder<ScriptField>> fn) API name:script_fields -
seqNoPrimaryTerm
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
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_fieldsAdds all elements of
listtostoredFields. -
storedFields
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_fieldsAdds one or more values to
storedFields. -
explain
If true, returns detailed information about score computation as part of a hit.API name:
explain -
fields
Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.API name:
fieldsAdds all elements of
listtofields. -
fields
Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.API name:
fieldsAdds 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:
fieldsAdds a value to
fieldsusing a builder lambda. -
docvalueFields
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_fieldsAdds all elements of
listtodocvalueFields. -
docvalueFields
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_fieldsAdds 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_fieldsAdds a value to
docvalueFieldsusing a builder lambda. -
indicesBoost
Boosts the _score of documents from specified indices.API name:
indices_boostAdds all elements of
listtoindicesBoost. -
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_boostAdds one or more values to
indicesBoost. -
collapse
API name:collapse -
collapse
public final MultisearchBody.Builder collapse(Function<FieldCollapse.Builder, ObjectBuilder<FieldCollapse>> fn) API name:collapse -
version
If true, returns document version as part of a hit.API name:
version -
timeout
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
API name:rescoreAdds all elements of
listtorescore. -
rescore
API name:rescoreAdds one or more values to
rescore. -
rescore
API name:rescoreAdds a value to
rescoreusing a builder lambda. -
ext
API name:extAdds all entries of
maptoext. -
ext
API name:extAdds an entry to
ext. -
build
Builds aMultisearchBody.- Specified by:
buildin interfaceObjectBuilder<MultisearchBody>- Throws:
NullPointerException- if some of the required fields are null.
-