org.elasticsearch.action.count

Class CountRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder,Client>

org.elasticsearch.action.support.broadcast.BroadcastOperationRequestBuilder<CountRequest,CountResponse,CountRequestBuilder,Client>

org.elasticsearch.action.count.CountRequestBuilder

public class CountRequestBuilder
extends BroadcastOperationRequestBuilder<CountRequest,CountResponse,CountRequestBuilder,Client>

A count action request builder.

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

client, request

Constructor Summary

Constructors

Constructor and Description
CountRequestBuilder(Client client)

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(ActionListener<CountResponse> listener)
CountRequestBuilder	setMinScore(float minScore) The minimum score of the documents to include in the count.
CountRequestBuilder	setPreference(String preference) Sets the preference to execute the search.
CountRequestBuilder	setQuery(BytesReference queryBinary) The query binary to execute
CountRequestBuilder	setQuery(QueryBuilder queryBuilder) The query source to execute.
CountRequestBuilder	setQuery(XContentBuilder query) Constructs a new builder with a raw search query.
CountRequestBuilder	setRouting(String... routing) The routing values to control the shards that the search will be executed on.
CountRequestBuilder	setRouting(String routing) A comma separated list of routing values to control the shards the search will be executed on.
CountRequestBuilder	setSource(byte[] querySource) The query source to execute.
CountRequestBuilder	setSource(BytesReference source) The source to execute.
CountRequestBuilder	setTerminateAfter(int terminateAfter)
CountRequestBuilder	setTypes(String... types) The types of documents the query will run against.
String	toString()

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequestBuilder

setIndices, setIndicesOptions

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, putHeader, request, setListenerThreaded

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CountRequestBuilder

public CountRequestBuilder(Client client)

Method Detail

setTypes

public CountRequestBuilder setTypes(String... types)

The types of documents the query will run against. Defaults to all types.

setMinScore

public CountRequestBuilder setMinScore(float minScore)

The minimum score of the documents to include in the count. Defaults to -1 which means all documents will be included in the count.

setRouting

public CountRequestBuilder setRouting(String routing)

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

setPreference

public CountRequestBuilder setPreference(String preference)

Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary shards, _shards:x,y to operate on shards x & y, or a custom value, which guarantees that the same order will be used across different requests.

setRouting

public CountRequestBuilder setRouting(String... routing)

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

setQuery

public CountRequestBuilder setQuery(QueryBuilder queryBuilder)

The query source to execute.

See Also:

QueryBuilders

setQuery

public CountRequestBuilder setQuery(BytesReference queryBinary)

The query binary to execute

setQuery

public CountRequestBuilder setQuery(XContentBuilder query)

Constructs a new builder with a raw search query.

setSource

public CountRequestBuilder setSource(BytesReference source)

The source to execute.

setSource

public CountRequestBuilder setSource(byte[] querySource)

The query source to execute.

setTerminateAfter

public CountRequestBuilder setTerminateAfter(int terminateAfter)

doExecute

protected void doExecute(ActionListener<CountResponse> listener)

Specified by:

doExecute in class ActionRequestBuilder<CountRequest,CountResponse,CountRequestBuilder,Client>

toString

public String toString()

Overrides:

toString in class Object