Package org.opensearch.client.opensearch.core

Class CountRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.core.CountRequest
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<CountRequest.Builder,CountRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class CountRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<CountRequest.Builder,CountRequest>
Returns number of documents matching a query.

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

      API name: allow_no_indices

    • analyzeWildcard

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

      API name: analyze_wildcard

    • analyzer

      @Nullable public final String analyzer()
      Analyzer to use for the query string. This parameter can only be used 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 only be used when the q query string parameter is specified.

      API name: default_operator

    • df

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

      API name: df

    • expandWildcards

      @Nonnull public final List<ExpandWildcard> expandWildcards()
      Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

      API name: expand_wildcards

    • ignoreThrottled

      @Nullable public final Boolean ignoreThrottled()
      If true, concrete, expanded or aliased indexes 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 missing or closed index.

      API name: ignore_unavailable

    • index

      @Nonnull public final List<String> index()
      A comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). To search all data streams and indexes, 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.

      API name: lenient

    • minScore

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

      API name: min_score

    • preference

      @Nullable public final String preference()
      Specifies the node or shard the operation should be performed on. Random by default.

      API name: preference

    • q

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

      API name: q

    • query

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

    • routing

      @Nonnull public final List<String> routing()
      A custom value used to route operations to a specific shard.

      API name: routing

    • terminateAfter

      @Nullable public final Integer terminateAfter()
      Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting.

      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)

    • toBuilder

      @Nonnull public CountRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CountRequest.Builder,CountRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static CountRequest.Builder builder()

    • setupCountRequestDeserializer

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

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object