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
Returns number of documents matching a query.
See Also:
API specification

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  CountRequest.Builder
    Builder for CountRequest.

    Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

    RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

  • Field Summary

    Fields
    Modifier and Type Field Description
    static JsonpDeserializer<CountRequest> _DESERIALIZER
    Json deserializer for CountRequest
    static Endpoint<CountRequest,​CountResponse,​ErrorResponse> _ENDPOINT
    Endpoint "count".

  • Method Summary

    Modifier and Type Method Description
    java.lang.Boolean allowNoIndices()
    Whether to ignore if a wildcard indices expression resolves into no concrete indices.
    java.lang.String analyzer()
    The analyzer to use for the query string
    java.lang.Boolean analyzeWildcard()
    Specify whether wildcard and prefix queries should be analyzed (default: false)
    Operator defaultOperator()
    The default operator for query string query (AND or OR)
    java.lang.String df()
    The field to use as default where no field prefix is given in the query string
    java.util.List<ExpandWildcard> expandWildcards()
    Whether to expand wildcard expression to concrete indices that are open, closed or both.
    java.lang.Boolean ignoreThrottled()
    Whether specified concrete, expanded or aliased indices should be ignored when throttled
    java.lang.Boolean ignoreUnavailable()
    Whether specified concrete indices should be ignored when unavailable (missing or closed)
    java.util.List<java.lang.String> index()
    A comma-separated list of indices to restrict the results
    java.lang.Boolean lenient()
    Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
    java.lang.Double minScore()
    Include only documents with a specific _score value in the result
    static CountRequest of​(java.util.function.Function<CountRequest.Builder,​ObjectBuilder<CountRequest>> fn)  
    java.lang.String preference()
    Specify the node or shard the operation should be performed on (default: random)
    java.lang.String q()
    Query in the Lucene query string syntax
    Query query()
    API name: query
    java.lang.String routing()
    A comma-separated list of specific routing values
    void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
    Serialize this object to JSON.
    protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)  
    protected static void setupCountRequestDeserializer​(ObjectDeserializer<CountRequest.Builder> op)  
    java.lang.Long terminateAfter()
    The maximum count for each shard, upon reaching which the query execution will terminate early
    java.util.List<java.lang.String> type()
    A comma-separated list of types to restrict the results

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Method Details

    • of

      public static CountRequest of​(java.util.function.Function<CountRequest.Builder,​ObjectBuilder<CountRequest>> fn)

    • allowNoIndices

      @Nullable public final java.lang.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

    • analyzeWildcard

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

      API name: analyze_wildcard

    • analyzer

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

      API name: analyzer

    • defaultOperator

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

      API name: default_operator

    • df

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

      API name: df

    • expandWildcards

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

      API name: expand_wildcards

    • ignoreThrottled

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

      API name: ignore_throttled

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • index

      public final java.util.List<java.lang.String> index()
      A comma-separated list of indices to restrict the results

      API name: index

    • lenient

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

      API name: lenient

    • minScore

      @Nullable public final java.lang.Double minScore()
      Include only documents with a specific _score value in the result

      API name: min_score

    • preference

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

      API name: preference

    • q

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

      API name: q

    • query

      @Nullable public final Query query()
      API name: query

    • routing

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

      API name: routing

    • terminateAfter

      @Nullable public final java.lang.Long terminateAfter()
      The maximum count for each shard, upon reaching which the query execution will terminate early

      API name: terminate_after

    • type

      public final java.util.List<java.lang.String> type()
      A comma-separated list of types to restrict the results

      API name: type

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

    • setupCountRequestDeserializer

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