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, ToXContent, ToXContentObject, TaskAwareRequest

public final class CountRequest
extends ActionRequest
implements IndicesRequest.Replaceable, 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.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CountRequest()
CountRequest(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 Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String[]	indices()	Returns the array of indices that the action relates to
CountRequest	indices(String... indices)	Sets the indices the count will be executed on.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
CountRequest	indicesOptions(IndicesOptions indicesOptions)	Returns the indices options used to resolve indices.
Float	minScore()
CountRequest	minScore(Float minScore)
String	preference()
CountRequest	preference(String preference)	Sets the preference to execute the count.
QueryBuilder	query()
CountRequest	query(QueryBuilder query)	Sets the query to execute for this count request.
String	routing()
CountRequest	routing(String routing)	The routing values to control the shards that the search will be executed on.
CountRequest	routing(String... routings)	A comma separated list of routing values to control the shards the count will be executed on.
SearchSourceBuilder	source()	Deprecated. The count api only supports a query.
CountRequest	source(SearchSourceBuilder searchSourceBuilder)	Deprecated. The count api only supports a query.
int	terminateAfter()
CountRequest	terminateAfter(int terminateAfter)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String[]	types()	Deprecated. Types are in the process of being removed.
CountRequest	types(String... types)	Deprecated. Types are in the process of being removed.
ActionRequestValidationException	validate()

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult, writeTo

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

CountRequest

public CountRequest()

CountRequest

public CountRequest(String... indices)

Constructs a new count request against the indices. No indices provided here means that count will execute on all indices.

CountRequest

@Deprecated
public CountRequest(String[] indices,
                    SearchSourceBuilder searchSourceBuilder)

Deprecated.

The count api only supports a query. Use CountRequest(String[], QueryBuilder) instead.

Constructs a new search request against the provided indices with the given search source.

CountRequest

public CountRequest(String[] indices,
                    QueryBuilder query)

Constructs a new search request against the provided indices with the given query.

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indices

public CountRequest indices(String... indices)

Sets the indices the count will be executed on.

Specified by:

indices in interface IndicesRequest.Replaceable

source

@Deprecated
public CountRequest source(SearchSourceBuilder searchSourceBuilder)

Deprecated.

The count api only supports a query. Use query(QueryBuilder) instead.

The source of the count request.

query

public CountRequest query(QueryBuilder query)

Sets the query to execute for this count request.

types

@Deprecated
public CountRequest types(String... 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

public CountRequest routing(String routing)

The routing values to control the shards that the search will be executed on.

routing

public CountRequest routing(String... routings)

A comma separated list of routing values to control the shards the count will be executed on.

indicesOptions

public CountRequest indicesOptions(IndicesOptions 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:

IndicesOptions

preference

public CountRequest preference(String 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

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

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.

Specified by:

indicesOptions in interface IndicesRequest

routing

public String routing()

preference

public String preference()

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

minScore

public Float minScore()

minScore

public CountRequest minScore(Float minScore)

terminateAfter

public int terminateAfter()

terminateAfter

public CountRequest terminateAfter(int terminateAfter)

types

@Deprecated
public String[] 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
public SearchSourceBuilder source()

Deprecated.

The count api only supports a query. Use query() instead.

Returns:

the source builder

query

public QueryBuilder query()

Returns:

The provided query to execute with the count request or null if no query was provided.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object