Package co.elastic.clients.elasticsearch.fleet

Class FleetSearchRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.fleet.FleetSearchRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class FleetSearchRequest extends RequestBase implements JsonpSerializable
Run a Fleet search. The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
See Also:

  • Field Details

  • Method Details

    • of

      public static FleetSearchRequest of(Function<FleetSearchRequest.Builder,ObjectBuilder<FleetSearchRequest>> 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()
      API name: allow_no_indices

    • allowPartialSearchResults

      @Nullable public final Boolean allowPartialSearchResults()
      If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Defaults to the configured cluster setting search.default_allow_partial_results, which is true by default.

      API name: allow_partial_search_results

    • analyzeWildcard

      @Nullable public final Boolean analyzeWildcard()
      API name: analyze_wildcard

    • analyzer

      @Nullable public final String analyzer()
      API name: analyzer

    • batchedReduceSize

      @Nullable public final Long batchedReduceSize()
      API name: batched_reduce_size

    • ccsMinimizeRoundtrips

      @Nullable public final Boolean ccsMinimizeRoundtrips()
      API name: ccs_minimize_roundtrips

    • collapse

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

    • defaultOperator

      @Nullable public final Operator defaultOperator()
      API name: default_operator

    • df

      @Nullable public final String df()
      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()
      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()
      API name: ignore_throttled

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      API name: ignore_unavailable

    • index

      public final String index()
      Required - A single target to search. If the target is an index alias, it must resolve to a single index.

      API name: index

    • indicesBoost

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

      API name: indices_boost

    • lenient

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

    • maxConcurrentShardRequests

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

    • preFilterShardSize

      @Nullable public final Long preFilterShardSize()
      API name: pre_filter_shard_size

    • preference

      @Nullable public final String preference()
      API name: preference

    • profile

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

    • q

      @Nullable public final String q()
      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()
      API name: request_cache

    • rescore

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

    • routing

      @Nullable public final String routing()
      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

    • scroll

      @Nullable public final Time scroll()
      API name: scroll

    • searchAfter

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

    • searchType

      @Nullable public final SearchType searchType()
      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

    • waitForCheckpoints

      public final List<Long> waitForCheckpoints()
      A comma separated list of checkpoints. When configured, the search API will only be executed on a shard after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause Elasticsearch to immediately execute the search.

      API name: wait_for_checkpoints

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

    • setupFleetSearchRequestDeserializer

      protected static void setupFleetSearchRequestDeserializer(ObjectDeserializer<FleetSearchRequest.Builder> op)

    • createSearchEndpoint

      public static <TDocument> Endpoint<FleetSearchRequest,FleetSearchResponse<TDocument>,ErrorResponse> createSearchEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
      Create an "fleet.search" endpoint.