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 Details

    • Builder

      public Builder()

  • Method Details

    • aggregations

      public final MultisearchBody.Builder aggregations​(java.util.Map<java.lang.String,​Aggregation> map)
      API name: aggregations

      Adds all entries of map to aggregations.

    • aggregations

      public final MultisearchBody.Builder aggregations​(java.lang.String key, Aggregation value)
      API name: aggregations

      Adds an entry to aggregations.

    • aggregations

      public final MultisearchBody.Builder aggregations​(java.lang.String key, java.util.function.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​(java.util.function.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​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      Defines the search definition using the Query DSL.

      API name: query

    • explain

      public final MultisearchBody.Builder explain​(@Nullable java.lang.Boolean value)
      If true, returns detailed information about score computation as part of a hit.

      API name: explain

    • ext

      public final MultisearchBody.Builder ext​(java.util.Map<java.lang.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​(java.lang.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​(java.util.List<java.lang.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​(java.lang.String value, java.lang.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​(java.util.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​(java.util.function.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.

    • knn

      public final MultisearchBody.Builder knn​(@Nullable KnnQuery value)
      Defines the approximate kNN search to run.

      API name: knn

    • knn

      public final MultisearchBody.Builder knn​(java.util.function.Function<KnnQuery.Builder,​ObjectBuilder<KnnQuery>> fn)
      Defines the approximate kNN search to run.

      API name: knn

    • from

      public final MultisearchBody.Builder from​(@Nullable java.lang.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​(java.util.function.Function<Highlight.Builder,​ObjectBuilder<Highlight>> fn)
      API name: highlight

    • indicesBoost

      public final MultisearchBody.Builder indicesBoost​(java.util.List<java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.Double> value, java.util.Map<java.lang.String,​java.lang.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 java.lang.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​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      API name: post_filter

    • profile

      public final MultisearchBody.Builder profile​(@Nullable java.lang.Boolean value)
      API name: profile

    • rescore

      public final MultisearchBody.Builder rescore​(java.util.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​(java.util.function.Function<Rescore.Builder,​ObjectBuilder<Rescore>> fn)
      API name: rescore

      Adds a value to rescore using a builder lambda.

    • scriptFields

      public final MultisearchBody.Builder scriptFields​(java.util.Map<java.lang.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​(java.lang.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​(java.lang.String key, java.util.function.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​(java.util.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​(java.util.function.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 java.lang.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​(java.util.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​(java.util.function.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​(java.util.function.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​(java.util.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​(java.util.function.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 java.lang.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​(java.util.List<java.lang.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​(java.lang.String value, java.lang.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 java.lang.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 java.lang.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​(java.util.function.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 java.lang.Boolean value)
      If true, returns document version as part of a hit.

      API name: version

    • runtimeMappings

      public final MultisearchBody.Builder runtimeMappings​(java.util.Map<java.lang.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​(java.lang.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​(java.lang.String key, java.util.function.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 java.lang.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​(java.util.function.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​(java.util.function.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:
      java.lang.NullPointerException - if some of the required fields are null.