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

Class MultisearchBody

java.lang.Object
co.elastic.clients.elasticsearch.core.msearch.MultisearchBody
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class MultisearchBody extends Object implements JsonpSerializable
See Also:

  • 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

    • collapse

      @Nullable public final FieldCollapse collapse()
      API name: collapse

    • query

      @Nullable public final Query query()
      Defines the search definition using the Query DSL.

      API name: query

    • explain

      @Nullable public final Boolean explain()
      If true, returns detailed information about score computation as part of a hit.

      API name: explain

    • ext

      public final Map<String,JsonData> ext()
      Configuration of search extensions defined by Elasticsearch plugins.

      API name: ext

    • 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

    • 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

    • knn

      public final List<KnnSearch> knn()
      Defines the approximate kNN search to run.

      API name: knn

    • from

      @Nullable public final Integer from()
      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

      @Nullable public final Highlight highlight()
      API name: highlight

    • indicesBoost

      public final List<NamedValue<Double>> indicesBoost()
      Boosts the _score of documents from specified indices.

      API name: indices_boost

    • minScore

      @Nullable public final Double minScore()
      The minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations.

      API name: min_score

    • postFilter

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

    • profile

      @Nullable public final Boolean profile()
      API name: profile

    • rescore

      public final List<Rescore> rescore()
      API name: rescore

    • scriptFields

      public final Map<String,ScriptField> scriptFields()
      Retrieve a script evaluation (based on different fields) for each hit.

      API name: script_fields

    • searchAfter

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

    • size

      @Nullable public final Integer size()
      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 List<SortOptions> sort()
      API name: sort

    • source

      @Nullable public final SourceConfig source()
      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 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

    • terminateAfter

      @Nullable public final Long terminateAfter()
      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 List<String> stats()
      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

    • 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

    • trackScores

      @Nullable public final Boolean trackScores()
      If true, calculate and return document scores, even if the scores are not used for sorting.

      API name: track_scores

    • trackTotalHits

      @Nullable public final TrackHits trackTotalHits()
      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

      @Nullable public final Boolean version()
      If true, returns document version as part of a hit.

      API name: version

    • runtimeMappings

      public final Map<String,RuntimeField> runtimeMappings()
      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

    • 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

    • pit

      @Nullable public final PointInTimeReference pit()
      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

      @Nullable public final Suggester suggest()
      API name: suggest

    • 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)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupMultisearchBodyDeserializer

      protected static void setupMultisearchBodyDeserializer(ObjectDeserializer<MultisearchBody.Builder> op)