Package co.elastic.clients.elasticsearch.async_search

Class SubmitRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.async_search.SubmitRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class SubmitRequest extends RequestBase implements JsonpSerializable
Run an async search.

When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.

Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.

By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.

See Also:

  • Field Details

  • Method Details

    • of

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

    • 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

    • aggregations

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      API name: allow_no_indices

    • allowPartialSearchResults

      @Nullable public final Boolean allowPartialSearchResults()
      Indicate if an error should be returned if there is a partial search failure or timeout

      API name: allow_partial_search_results

    • analyzeWildcard

      @Nullable public final Boolean analyzeWildcard()
      Specify whether wildcard and prefix queries should be analyzed (default: false)

      API name: analyze_wildcard

    • analyzer

      @Nullable public final String analyzer()
      The analyzer to use for the query string

      API name: analyzer

    • batchedReduceSize

      @Nullable public final Long batchedReduceSize()
      Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).

      API name: batched_reduce_size

    • ccsMinimizeRoundtrips

      @Nullable public final Boolean ccsMinimizeRoundtrips()
      The default value is the only supported value.

      API name: ccs_minimize_roundtrips

    • collapse

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

    • defaultOperator

      @Nullable public final Operator defaultOperator()
      The default operator for query string query (AND or OR)

      API name: default_operator

    • df

      @Nullable public final String df()
      The field to use as default where no field prefix is given in the query string

      API name: df

    • 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

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • 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

    • 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

    • 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

    • ignoreThrottled

      @Nullable public final Boolean ignoreThrottled()
      Whether specified concrete, expanded or aliased indices should be ignored when throttled

      API name: ignore_throttled

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • index

      public final List<String> index()
      A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

      API name: index

    • indicesBoost

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

      API name: indices_boost

    • keepAlive

      @Nullable public final Time keepAlive()
      Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.

      API name: keep_alive

    • keepOnCompletion

      @Nullable public final Boolean keepOnCompletion()
      If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout.

      API name: keep_on_completion

    • knn

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

      API name: knn

    • lenient

      @Nullable public final Boolean lenient()
      Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

      API name: lenient

    • maxConcurrentShardRequests

      @Nullable public final Integer maxConcurrentShardRequests()
      The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests

      API name: max_concurrent_shard_requests

    • minScore

      @Nullable public final Double minScore()
      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

    • 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

    • postFilter

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

    • preference

      @Nullable public final String preference()
      Specify the node or shard the operation should be performed on (default: random)

      API name: preference

    • profile

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

    • projectRouting

      @Nullable public final String projectRouting()
      Specifies a subset of projects to target for the search using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

      API name: project_routing

    • q

      @Nullable public final String q()
      Query in the Lucene query string syntax

      API name: q

    • query

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

      API name: query

    • requestCache

      @Nullable public final Boolean requestCache()
      Specify if request cache should be used for this request or not, defaults to true

      API name: request_cache

    • rescore

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

    • routing

      @Nullable public final String routing()
      A comma-separated list of specific routing values

      API name: routing

    • 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

    • 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

    • searchType

      @Nullable public final SearchType searchType()
      Search operation type

      API name: search_type

    • 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

    • 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

    • slice

      @Nullable public final SlicedScroll slice()
      API name: slice

    • sort

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

    • 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

    • 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

    • suggest

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

    • 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

    • 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

    • waitForCompletionTimeout

      @Nullable public final Time waitForCompletionTimeout()
      Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.

      API name: wait_for_completion_timeout

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

    • setupSubmitRequestDeserializer

      protected static void setupSubmitRequestDeserializer(ObjectDeserializer<SubmitRequest.Builder> op)

    • createSubmitEndpoint

      public static <TDocument> Endpoint<SubmitRequest,SubmitResponse<TDocument>,ErrorResponse> createSubmitEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "async_search.submit" endpoint.