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
Whether to ignore if a wildcard indices expression resolves into no concrete indices.final String
analyzer()
The analyzer to use for the query stringfinal Boolean
Specify whether wildcard and prefix queries should be analyzed (default: false)final Operator
The default operator for query string query (AND or OR)final String
df()
The field to use as default where no field prefix is given in the query stringfinal List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
Whether specified concrete, expanded or aliased indices should be ignored when throttledfinal Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)index()
A comma-separated list of indices to restrict the resultsfinal Boolean
lenient()
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredfinal Double
minScore()
Include only documents with a specific_score
value in the resultstatic CountRequest
final String
Specify the node or shard the operation should be performed on (default: random)final String
q()
Query in the Lucene query string syntaxfinal Query
query()
API name:query
final String
routing()
A comma-separated list of specific routing valuesvoid
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
The maximum count for each shard, upon reaching which the query execution will terminate earlytype()
A comma-separated list of types to restrict the resultsMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forCountRequest
-
_ENDPOINT
Endpoint "count
".
-
-
Method Details
-
of
-
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
Specify whether wildcard and prefix queries should be analyzed (default: false)API name:
analyze_wildcard
-
analyzer
The analyzer to use for the query stringAPI name:
analyzer
-
defaultOperator
The default operator for query string query (AND or OR)API name:
default_operator
-
df
The field to use as default where no field prefix is given in the query stringAPI name:
df
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
ignoreThrottled
Whether specified concrete, expanded or aliased indices should be ignored when throttledAPI name:
ignore_throttled
-
index
A comma-separated list of indices to restrict the resultsAPI name:
index
-
lenient
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredAPI name:
lenient
-
minScore
Include only documents with a specific_score
value in the resultAPI name:
min_score
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
q
Query in the Lucene query string syntaxAPI name:
q
-
query
API name:query
-
routing
A comma-separated list of specific routing valuesAPI name:
routing
-
terminateAfter
The maximum count for each shard, upon reaching which the query execution will terminate earlyAPI name:
terminate_after
-
type
A comma-separated list of types to restrict the resultsAPI name:
type
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupCountRequestDeserializer
-