Package co.elastic.clients.elasticsearch.async_search

Class SubmitRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SubmitRequest.Builder>
co.elastic.clients.elasticsearch.async_search.SubmitRequest.Builder
All Implemented Interfaces:
WithJson<SubmitRequest.Builder>, ObjectBuilder<SubmitRequest>
Enclosing class:
SubmitRequest
public static class SubmitRequest.Builder extends RequestBase.AbstractBuilder<SubmitRequest.Builder> implements ObjectBuilder<SubmitRequest>
Builder for SubmitRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • source

      public final SubmitRequest.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 SubmitRequest.Builder source(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

    • aggregations

      public final SubmitRequest.Builder aggregations(Map<String,Aggregation> map)
      API name: aggregations

      Adds all entries of map to aggregations.

    • aggregations

      public final SubmitRequest.Builder aggregations(String key, Aggregation value)
      API name: aggregations

      Adds an entry to aggregations.

    • aggregations

      public final SubmitRequest.Builder aggregations(String key, AggregationVariant value)
      API name: aggregations

      Adds an entry to aggregations.

    • aggregations

      public final SubmitRequest.Builder aggregations(String key, Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)
      API name: aggregations

      Adds an entry to aggregations using a builder lambda.

    • allowNoIndices

      public final SubmitRequest.Builder allowNoIndices(@Nullable Boolean value)
      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

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

      API name: allow_partial_search_results

    • analyzeWildcard

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

      API name: analyze_wildcard

    • analyzer

      public final SubmitRequest.Builder analyzer(@Nullable String value)
      The analyzer to use for the query string

      API name: analyzer

    • batchedReduceSize

      public final SubmitRequest.Builder batchedReduceSize(@Nullable Long value)
      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

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

      API name: ccs_minimize_roundtrips

    • collapse

      public final SubmitRequest.Builder collapse(@Nullable FieldCollapse value)
      API name: collapse

    • collapse

      public final SubmitRequest.Builder collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)
      API name: collapse

    • defaultOperator

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

      API name: default_operator

    • df

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

      API name: df

    • docvalueFields

      public final SubmitRequest.Builder docvalueFields(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 SubmitRequest.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 SubmitRequest.Builder docvalueFields(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.

    • expandWildcards

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

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final SubmitRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • explain

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

      API name: explain

    • ext

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

      API name: ext

      Adds all entries of map to ext.

    • ext

      public final SubmitRequest.Builder ext(String key, JsonData value)
      Configuration of search extensions defined by Elasticsearch plugins.

      API name: ext

      Adds an entry to ext.

    • fields

      public final SubmitRequest.Builder fields(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 SubmitRequest.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 SubmitRequest.Builder fields(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.

    • from

      public final SubmitRequest.Builder from(@Nullable 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 SubmitRequest.Builder highlight(@Nullable Highlight value)
      API name: highlight

    • highlight

      public final SubmitRequest.Builder highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)
      API name: highlight

    • ignoreThrottled

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

      API name: ignore_throttled

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • index

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

      API name: index

      Adds all elements of list to index.

    • index

      public final SubmitRequest.Builder index(String value, String... values)
      A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices

      API name: index

      Adds one or more values to index.

    • indicesBoost

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

      API name: indices_boost

      Adds all elements of list to indicesBoost.

    • indicesBoost

      @SafeVarargs public final SubmitRequest.Builder indicesBoost(NamedValue<Double> value, NamedValue<Double>... values)
      Boosts the _score of documents from specified indices.

      API name: indices_boost

      Adds one or more values to indicesBoost.

    • keepAlive

      public final SubmitRequest.Builder keepAlive(@Nullable Time value)
      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

    • keepAlive

      public final SubmitRequest.Builder keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

      public final SubmitRequest.Builder keepOnCompletion(@Nullable Boolean value)
      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 SubmitRequest.Builder knn(List<KnnSearch> list)
      Defines the approximate kNN search to run.

      API name: knn

      Adds all elements of list to knn.

    • knn

      public final SubmitRequest.Builder knn(KnnSearch value, KnnSearch... values)
      Defines the approximate kNN search to run.

      API name: knn

      Adds one or more values to knn.

    • knn

      public final SubmitRequest.Builder knn(Function<KnnSearch.Builder,ObjectBuilder<KnnSearch>> fn)
      Defines the approximate kNN search to run.

      API name: knn

      Adds a value to knn using a builder lambda.

    • lenient

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

      API name: lenient

    • maxConcurrentShardRequests

      public final SubmitRequest.Builder maxConcurrentShardRequests(@Nullable Integer value)
      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

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

      public final SubmitRequest.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 SubmitRequest.Builder pit(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

    • postFilter

      public final SubmitRequest.Builder postFilter(@Nullable Query value)
      API name: post_filter

    • postFilter

      public final SubmitRequest.Builder postFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)
      API name: post_filter

    • postFilter

      public final SubmitRequest.Builder postFilter(QueryVariant value)
      API name: post_filter

    • preference

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

      API name: preference

    • profile

      public final SubmitRequest.Builder profile(@Nullable Boolean value)
      API name: profile

    • projectRouting

      public final SubmitRequest.Builder projectRouting(@Nullable String value)
      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

      public final SubmitRequest.Builder q(@Nullable String value)
      Query in the Lucene query string syntax

      API name: q

    • query

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

      API name: query

    • query

      public final SubmitRequest.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)
      Defines the search definition using the Query DSL.

      API name: query

    • query

      public final SubmitRequest.Builder query(QueryVariant value)
      Defines the search definition using the Query DSL.

      API name: query

    • requestCache

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

      API name: request_cache

    • rescore

      public final SubmitRequest.Builder rescore(List<Rescore> list)
      API name: rescore

      Adds all elements of list to rescore.

    • rescore

      public final SubmitRequest.Builder rescore(Rescore value, Rescore... values)
      API name: rescore

      Adds one or more values to rescore.

    • rescore

      public final SubmitRequest.Builder rescore(RescoreVariant value, RescoreVariant... values)
      API name: rescore

      Adds one or more values to rescore.

    • rescore

      public final SubmitRequest.Builder rescore(Function<Rescore.Builder,ObjectBuilder<Rescore>> fn)
      API name: rescore

      Adds a value to rescore using a builder lambda.

    • routing

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

      API name: routing

    • runtimeMappings

      public final SubmitRequest.Builder runtimeMappings(Map<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 SubmitRequest.Builder runtimeMappings(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 SubmitRequest.Builder runtimeMappings(String key, 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.

    • scriptFields

      public final SubmitRequest.Builder scriptFields(Map<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 SubmitRequest.Builder scriptFields(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 SubmitRequest.Builder scriptFields(String key, 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 SubmitRequest.Builder searchAfter(List<FieldValue> list)
      API name: search_after

      Adds all elements of list to searchAfter.

    • searchAfter

      public final SubmitRequest.Builder searchAfter(FieldValue value, FieldValue... values)
      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final SubmitRequest.Builder searchAfter(String value, String... values)
      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final SubmitRequest.Builder searchAfter(long value, long... values)
      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final SubmitRequest.Builder searchAfter(double value, double... values)
      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final SubmitRequest.Builder searchAfter(boolean value, boolean... values)
      API name: search_after

      Adds one or more values to searchAfter.

    • searchAfter

      public final SubmitRequest.Builder searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)
      API name: search_after

      Adds a value to searchAfter using a builder lambda.

    • searchType

      public final SubmitRequest.Builder searchType(@Nullable SearchType value)
      Search operation type

      API name: search_type

    • seqNoPrimaryTerm

      public final SubmitRequest.Builder seqNoPrimaryTerm(@Nullable 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

    • size

      public final SubmitRequest.Builder size(@Nullable 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

    • slice

      public final SubmitRequest.Builder slice(@Nullable SlicedScroll value)
      API name: slice

    • slice

      public final SubmitRequest.Builder slice(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> fn)
      API name: slice

    • sort

      public final SubmitRequest.Builder sort(List<SortOptions> list)
      API name: sort

      Adds all elements of list to sort.

    • sort

      public final SubmitRequest.Builder sort(SortOptions value, SortOptions... values)
      API name: sort

      Adds one or more values to sort.

    • sort

      public final SubmitRequest.Builder sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)
      API name: sort

      Adds a value to sort using a builder lambda.

    • stats

      public final SubmitRequest.Builder stats(List<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 SubmitRequest.Builder stats(String value, 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.

    • storedFields

      public final SubmitRequest.Builder storedFields(List<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 SubmitRequest.Builder storedFields(String value, 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.

    • suggest

      public final SubmitRequest.Builder suggest(@Nullable Suggester value)
      API name: suggest

    • suggest

      public final SubmitRequest.Builder suggest(Function<Suggester.Builder,ObjectBuilder<Suggester>> fn)
      API name: suggest

    • terminateAfter

      public final SubmitRequest.Builder terminateAfter(@Nullable 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

    • timeout

      public final SubmitRequest.Builder timeout(@Nullable 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 SubmitRequest.Builder trackScores(@Nullable 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 SubmitRequest.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 SubmitRequest.Builder trackTotalHits(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 SubmitRequest.Builder version(@Nullable Boolean value)
      If true, returns document version as part of a hit.

      API name: version

    • waitForCompletionTimeout

      public final SubmitRequest.Builder waitForCompletionTimeout(@Nullable Time value)
      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

    • waitForCompletionTimeout

      public final SubmitRequest.Builder waitForCompletionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

    • self

      protected SubmitRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<SubmitRequest.Builder>

    • build

      public SubmitRequest build()
      Builds a SubmitRequest.
      Specified by:
      build in interface ObjectBuilder<SubmitRequest>
      Throws:
      NullPointerException - if some of the required fields are null.