Class CountRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.CountRequest
- All Implemented Interfaces:
JsonpSerializable
Returns number of documents matching a query.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<CountRequest>
Json deserializer forCountRequest
static final Endpoint<CountRequest,
CountResponse, ErrorResponse> Endpoint "count
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices.final String
analyzer()
Analyzer to use for the query string.final Boolean
Iftrue
, wildcard and prefix queries are analyzed.final Operator
The default operator for query string query:AND
orOR
.final String
df()
Field to use as default where no field prefix is given in the query string.final List<ExpandWildcard>
Type of index that wildcard patterns can match.final Boolean
Iftrue
, concrete, expanded or aliased indices are ignored when frozen.final Boolean
Iffalse
, the request returns an error if it targets a missing or closed index.index()
Comma-separated list of data streams, indices, and aliases to search.final Boolean
lenient()
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.final Double
minScore()
Sets the minimum_score
value that documents must have to be included in the result.static CountRequest
final String
Specifies the node or shard the operation should be performed on.final String
q()
Query in the Lucene query string syntax.final Query
query()
Defines the search definition using the Query DSL.final String
routing()
Custom value used to route operations to a specific shard.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
final Long
Maximum number of documents to collect for each shard.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forCountRequest
-
_ENDPOINT
Endpoint "count
".
-
-
Method Details
-
of
-
allowNoIndices
Iffalse
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices.API name:
allow_no_indices
-
analyzeWildcard
Iftrue
, wildcard and prefix queries are analyzed. This parameter can only be used when theq
query string parameter is specified.API name:
analyze_wildcard
-
analyzer
Analyzer to use for the query string. This parameter can only be used when theq
query string parameter is specified.API name:
analyzer
-
defaultOperator
The default operator for query string query:AND
orOR
. This parameter can only be used when theq
query string parameter is specified.API name:
default_operator
-
df
Field to use as default where no field prefix is given in the query string. This parameter can only be used when theq
query string parameter is specified.API name:
df
-
expandWildcards
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. Supports comma-separated values, such asopen,hidden
.API name:
expand_wildcards
-
ignoreThrottled
Iftrue
, concrete, expanded or aliased indices are ignored when frozen.API name:
ignore_throttled
-
index
Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*
). To search all data streams and indices, omit this parameter or use*
or_all
.API name:
index
-
lenient
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.API name:
lenient
-
minScore
Sets the minimum_score
value that documents must have to be included in the result.API name:
min_score
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
q
Query in the Lucene query string syntax.API name:
q
-
query
Defines the search definition using the Query DSL.API name:
query
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
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.API name:
terminate_after
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupCountRequestDeserializer
-