Package co.elastic.clients.elasticsearch.core

Class CountRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.CountRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class CountRequest extends RequestBase implements JsonpSerializable
Count search results.

Get the number of documents matching a query.

The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses match_all to count all the documents.

The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.

The operation is broadcast across all shards. For each shard ID group, a replica is chosen and the search is run against it. This means that replicas increase the scalability of the count.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • analyzeWildcard

      @Nullable public final Boolean analyzeWildcard()
      If true, wildcard and prefix queries are analyzed. This parameter can be used only when the q query string parameter is specified.

      API name: analyze_wildcard

    • analyzer

      @Nullable public final String analyzer()
      The analyzer to use for the query string. This parameter can be used only when the q query string parameter is specified.

      API name: analyzer

    • defaultOperator

      @Nullable public final Operator defaultOperator()
      The default operator for query string query: and or or. This parameter can be used only when the q query string parameter is specified.

      API name: default_operator

    • df

      @Nullable public final String df()
      The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the q query string parameter is specified.

      API name: df

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

    • ignoreThrottled

      @Deprecated @Nullable public final Boolean ignoreThrottled()
      Deprecated.
      7.16.0
      If true, concrete, expanded, or aliased indices are ignored when frozen.

      API name: ignore_throttled

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

      public final List<String> index()
      A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (*). To search all data streams and indices, omit this parameter or use * or _all.

      API name: index

    • lenient

      @Nullable public final Boolean lenient()
      If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the q query string parameter is specified.

      API name: lenient

    • minScore

      @Nullable public final Double minScore()
      The minimum _score value that documents must have to be included in the result.

      API name: min_score

    • preference

      @Nullable public final String preference()
      The node or shard the operation should be performed on. By default, it is random.

      API name: preference

    • projectRouting

      @Nullable public final String projectRouting()
      Specifies a subset of projects to target 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()
      The query in Lucene query string syntax. This parameter cannot be used with a request body.

      API name: q

    • query

      @Nullable public final Query query()
      Defines the search query using Query DSL. A request body query cannot be used with the q query string parameter.

      API name: query

    • routeSlice

      @Nullable public final String routeSlice()
      The slice identifier used to route the operation to a specific slice. Use the special value _all to target all slices without restricting to a routing value. Required when index.slice.enabled is true for the target index; not allowed when index.slice.enabled is false.

      API name: _slice

    • routing

      public final List<String> routing()
      A custom value used to route operations to a specific shard. Not allowed when index.slice.enabled is true for the target index; use _slice instead.

      API name: routing

    • stats

      public final List<String> stats()
      Specific tag of the request for logging and statistical purposes.

      API name: stats

    • terminateAfter

      @Nullable public final Long terminateAfter()
      The 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.

      IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.

      API name: terminate_after

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

    • rebuild

      public CountRequest.Builder rebuild()
      Returns:
      New CountRequest.Builder initialized with field values of this instance

    • setupCountRequestDeserializer

      protected static void setupCountRequestDeserializer(ObjectDeserializer<CountRequest.Builder> op)