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

Class MultisearchBody

java.lang.Object
org.opensearch.client.opensearch.core.msearch.MultisearchBody
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable
@JsonpDeserializable public class MultisearchBody extends Object implements PlainJsonSerializable

  • Field Details

  • Method Details

    • of

      public static MultisearchBody of(Function<MultisearchBody.Builder,ObjectBuilder<MultisearchBody>> fn)

    • aggregations

      public final Map<String,Aggregation> aggregations()
      API name: aggregations

    • query

      @Nullable public final Query query()
      API name: query

    • from

      @Nullable public final Integer from()
      API name: from

    • minScore

      @Nullable public final Double minScore()
      API name: from

    • postFilter

      @Nullable public final Query postFilter()
      API name: post_filter

    • searchAfter

      public final List<FieldValue> searchAfter()
      API name: search_after

    • size

      @Nullable public final Integer size()
      API name: size

    • sort

      public final List<SortOptions> sort()
      API name: sort

    • trackScores

      @Nullable public final 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 Map<String,ScriptField> scriptFields()

    • seqNoPrimaryTerm

      @Nullable public final 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 List<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 Boolean explain()
      If true, returns detailed information about score computation as part of a hit.

      API name: explain

    • fields

      public final 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 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 List<Map<String,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 Boolean version()
      If true, returns document version as part of a hit.

      API name: version

    • timeout

      @Nullable public final 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 List<Rescore> rescore()
      API name: rescore

    • ext

      public final Map<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)