Package org.elasticsearch.client.core
Class CountRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.core.CountRequest
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public final class CountRequest
extends ActionRequest
implements IndicesRequest.Replaceable, org.elasticsearch.xcontent.ToXContentObject
Encapsulates a request to _count API against one, several or all indices.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.Replaceable
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionCountRequest
(String... indices) Constructs a new count request against the indices.CountRequest
(String[] indices, QueryBuilder query) Constructs a new search request against the provided indices with the given query.CountRequest
(String[] indices, SearchSourceBuilder searchSourceBuilder) Deprecated.The count api only supports a query. -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
hashCode()
String[]
indices()
Sets the indices the count will be executed on.indicesOptions
(IndicesOptions indicesOptions) Returns the indices options used to resolve indices.minScore()
preference
(String preference) Sets the preference to execute the count.query()
query
(QueryBuilder query) Sets the query to execute for this count request.routing()
The routing values to control the shards that the search will be executed on.A comma separated list of routing values to control the shards the count will be executed on.source()
Deprecated.The count api only supports a query.source
(SearchSourceBuilder searchSourceBuilder) Deprecated.The count api only supports a query.int
terminateAfter
(int terminateAfter) org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) String[]
types()
Deprecated.Types are in the process of being removed.Deprecated.Types are in the process of being removed.validate()
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, writeTo
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.action.IndicesRequest
includeDataStreams
Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndices
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
CountRequest
public CountRequest() -
CountRequest
Constructs a new count request against the indices. No indices provided here means that count will execute on all indices. -
CountRequest
Deprecated.The count api only supports a query. UseCountRequest(String[], QueryBuilder)
instead.Constructs a new search request against the provided indices with the given search source. -
CountRequest
Constructs a new search request against the provided indices with the given query.
-
-
Method Details
-
validate
- Specified by:
validate
in classActionRequest
-
indices
Sets the indices the count will be executed on.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
source
Deprecated.The count api only supports a query. Usequery(QueryBuilder)
instead.The source of the count request. -
query
Sets the query to execute for this count request. -
types
Deprecated.Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document.The document types to execute the count against. Defaults to be executed against all types. -
routing
The routing values to control the shards that the search will be executed on. -
routing
A comma separated list of routing values to control the shards the count will be executed on. -
indicesOptions
Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.- See Also:
-
preference
Sets the preference to execute the count. Defaults to randomize across shards. Can be set to_local
to prefer local shards or a custom value, which guarantees that the same order will be used across different requests. -
indicesOptions
- Specified by:
indicesOptions
in interfaceIndicesRequest
-
routing
-
preference
-
indices
- Specified by:
indices
in interfaceIndicesRequest
-
minScore
-
minScore
-
terminateAfter
public int terminateAfter() -
terminateAfter
-
types
Deprecated.Types are in the process of being removed. Instead of using a type, prefer to filter on a field on the document. -
source
Deprecated.The count api only supports a query. Usequery()
instead.- Returns:
- the source builder
-
query
- Returns:
- The provided query to execute with the count request or
null
if no query was provided.
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode()
-