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 forCountRequest
.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 forCountRequest
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 stringjava.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 stringjava.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 throttledjava.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 resultsjava.lang.Boolean
lenient()
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredjava.lang.Double
minScore()
Include only documents with a specific_score
value in the resultstatic 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 syntaxQuery
query()
API name:query
java.lang.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
setupCountRequestDeserializer(ObjectDeserializer<CountRequest.Builder> op)
java.lang.Long
terminateAfter()
The maximum count for each shard, upon reaching which the query execution will terminate earlyMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forCountRequest
-
_ENDPOINT
Endpoint "count
".
-
-
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 stringAPI name:
analyzer
-
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 stringAPI name:
df
-
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 throttledAPI name:
ignore_throttled
-
index
public final java.util.List<java.lang.String> index()A comma-separated list of indices to restrict the resultsAPI 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 ignoredAPI name:
lenient
-
minScore
@Nullable public final java.lang.Double minScore()Include only documents with a specific_score
value in the resultAPI 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 syntaxAPI name:
q
-
query
API name:query
-
routing
@Nullable public final java.lang.String routing()A comma-separated list of specific routing valuesAPI name:
routing
-
terminateAfter
@Nullable public final java.lang.Long terminateAfter()The maximum count for each shard, upon reaching which the query execution will terminate earlyAPI name:
terminate_after
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupCountRequestDeserializer
-