java.lang.Object
- org.opensearch.client.opensearch.core.msearch.MultisearchBody

All Implemented Interfaces:: JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class MultisearchBody
extends java.lang.Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MultisearchBody.Builder
Builder for MultisearchBody.

Field Summary

Fields
Modifier and Type Field Description

static JsonpDeserializer<MultisearchBody> _DESERIALIZER
Json deserializer for MultisearchBody

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Map<java.lang.String,Aggregation>`	`aggregations()`	API name: `aggregations`
`FieldCollapse`	`collapse()`	API name: `collapse`
`java.util.List<FieldAndFormat>`	`docvalueFields()`	Array of wildcard (*) patterns.
`java.lang.Boolean`	`explain()`	If true, returns detailed information about score computation as part of a hit.
`java.util.Map<java.lang.String,JsonData>`	`ext()`	API name: `ext`
`java.util.List<FieldAndFormat>`	`fields()`	Array of wildcard (*) patterns.
`java.lang.Integer`	`from()`	API name: `from`
`Highlight`	`highlight()`	API name: `highlight`
`java.util.List<java.util.Map<java.lang.String,java.lang.Double>>`	`indicesBoost()`	Boosts the _score of documents from specified indices.
`java.lang.Double`	`minScore()`	API name: `from`
`static MultisearchBody`	`of(java.util.function.Function<MultisearchBody.Builder,ObjectBuilder<MultisearchBody>> fn)`
`Query`	`postFilter()`	API name: `post_filter`
`Query`	`query()`	API name: `query`
`java.util.List<Rescore>`	`rescore()`	API name: `rescore`
`java.util.Map<java.lang.String,ScriptField>`	`scriptFields()`
`java.util.List<java.lang.String>`	`searchAfter()`	API name: `search_after`
`java.util.List<FieldValue>`	`searchAfterVals()`	API name: `search_after`
`java.lang.Boolean`	`seqNoPrimaryTerm()`	If true, returns sequence number and primary term of the last modification of each hit.
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`	Serialize this object to JSON.
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupMultisearchBodyDeserializer(ObjectDeserializer<MultisearchBody.Builder> op)`
`java.lang.Integer`	`size()`	API name: `size`
`java.util.List<SortOptions>`	`sort()`	API name: `sort`
`SourceConfig`	`source()`	API name: `_source`
`java.util.List<java.lang.String>`	`storedFields()`	List of stored fields to return as part of a hit.
`Suggester`	`suggest()`	API name: `suggest`
`java.lang.String`	`timeout()`	Specifies the period of time to wait for a response from each shard.
`java.lang.Boolean`	`trackScores()`	API name: `track_scores`
`TrackHits`	`trackTotalHits()`	API name: `track_total_hits`
`java.lang.Boolean`	`version()`	If true, returns document version as part of a hit.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonString

- Field Detail
  - _DESERIALIZER
```
public static final JsonpDeserializer<MultisearchBody> _DESERIALIZER
```
    Json deserializer for MultisearchBody
- Method Detail
  - of
```
public static MultisearchBody of(java.util.function.Function<MultisearchBody.Builder,ObjectBuilder<MultisearchBody>> fn)
```
  - aggregations
```
public final java.util.Map<java.lang.String,Aggregation> aggregations()
```
    API name: aggregations
  - query
```
@Nullable
public final Query query()
```
    API name: query
  - from
```
@Nullable
public final java.lang.Integer from()
```
    API name: from
  - minScore
```
@Nullable
public final java.lang.Double minScore()
```
    API name: from
  - postFilter
```
@Nullable
public final Query postFilter()
```
    API name: post_filter
  - searchAfter
```
public final java.util.List<java.lang.String> searchAfter()
```
    API name: search_after
    NOTE: In version 3.0.0 of opensearch-java, this method will instead return a List<FieldValue>.
  - searchAfterVals
```
public final java.util.List<FieldValue> searchAfterVals()
```
    API name: search_after
    NOTE: In version 3.0.0 of opensearch-java, this method will be renamed to replace searchAfter().
  - size
```
@Nullable
public final java.lang.Integer size()
```
    API name: size
  - sort
```
public final java.util.List<SortOptions> sort()
```
    API name: sort
  - trackScores
```
@Nullable
public final java.lang.Boolean trackScores()
```
    API name: track_scores
  - trackTotalHits
```
@Nullable
public final TrackHits trackTotalHits()
```
    API name: track_total_hits
  - suggest
```
@Nullable
public final Suggester suggest()
```
    API name: suggest
  - highlight
```
@Nullable
public final Highlight highlight()
```
    API name: highlight
  - source
```
@Nullable
public final SourceConfig source()
```
    API name: _source
  - scriptFields
```
public final java.util.Map<java.lang.String,ScriptField> scriptFields()
```
  - seqNoPrimaryTerm
```
@Nullable
public final java.lang.Boolean 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
```
public final java.util.List<java.lang.String> 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_fields
  - explain
```
@Nullable
public final java.lang.Boolean explain()
```
    If true, returns detailed information about score computation as part of a hit.
    API name: explain
  - fields
```
public final java.util.List<FieldAndFormat> 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: fields
  - docvalueFields
```
public final java.util.List<FieldAndFormat> 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_fields
  - indicesBoost
```
public final java.util.List<java.util.Map<java.lang.String,java.lang.Double>> indicesBoost()
```
    Boosts the _score of documents from specified indices.
    API name: indices_boost
  - collapse
```
@Nullable
public final FieldCollapse collapse()
```
    API name: collapse
  - version
```
@Nullable
public final java.lang.Boolean version()
```
    If true, returns document version as part of a hit.
    API name: version
  - timeout
```
@Nullable
public final java.lang.String 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
```
public final java.util.List<Rescore> rescore()
```
    API name: rescore
  - ext
```
public final java.util.Map<java.lang.String,JsonData> ext()
```
    API name: ext
  - serialize
```
public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)
```
    Serialize this object to JSON.
    
    Specified by:
    
    serialize in interface JsonpSerializable
  - serializeInternal
```
protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)
```
  - setupMultisearchBodyDeserializer
```
protected static void setupMultisearchBodyDeserializer(ObjectDeserializer<MultisearchBody.Builder> op)
```

Class MultisearchBody

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

Field Detail

_DESERIALIZER

Method Detail

of

aggregations

query

from

minScore

postFilter

searchAfter

searchAfterVals

size

sort

trackScores

trackTotalHits

suggest

highlight

source

scriptFields

seqNoPrimaryTerm

storedFields

explain

fields

docvalueFields

indicesBoost

collapse

version

timeout

rescore

ext

serialize

serializeInternal

setupMultisearchBodyDeserializer