org.elasticsearch.action.count

Class CountRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.broadcast.BroadcastRequest<CountRequest>

org.elasticsearch.action.count.CountRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

Deprecated.

use SearchRequest instead and set the size to 0

@Deprecated
public class CountRequest
extends BroadcastRequest<CountRequest>

A request to count the number of documents matching a specific query. Best created with Requests.countRequest(String...).

The request requires the query source to be set either using source(QuerySourceBuilder), or source(byte[]).

See Also:

CountResponse, Client.count(CountRequest), Requests.countRequest(String...)

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

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_MIN_SCORE Deprecated.
protected String	routing Deprecated.

Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest

indices

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
CountRequest(String... indices) Deprecated. Constructs a new count request against the provided indices.

Method Summary

Modifier and Type	Method and Description
float	minScore() Deprecated. The minimum score of the documents to include in the count.
CountRequest	minScore(float minScore) Deprecated. The minimum score of the documents to include in the count.
String	preference() Deprecated.
CountRequest	preference(String preference) Deprecated.
void	readFrom(StreamInput in) Deprecated.
String	routing() Deprecated. A comma separated list of routing values to control the shards the search will be executed on.
CountRequest	routing(String... routings) Deprecated. The routing values to control the shards that the search will be executed on.
CountRequest	routing(String routing) Deprecated. A comma separated list of routing values to control the shards the search will be executed on.
BytesReference	source() Deprecated. The source to execute.
CountRequest	source(byte[] querySource) Deprecated. The source to execute.
CountRequest	source(byte[] querySource, int offset, int length) Deprecated. The source to execute.
CountRequest	source(BytesReference querySource) Deprecated.
CountRequest	source(Map querySource) Deprecated. The source to execute in the form of a map.
CountRequest	source(QuerySourceBuilder sourceBuilder) Deprecated. The source to execute.
CountRequest	source(String querySource) Deprecated. The source to execute.
CountRequest	source(XContentBuilder builder) Deprecated.
int	terminateAfter() Deprecated.
CountRequest	terminateAfter(int terminateAfterCount) Deprecated. Upon reaching terminateAfter counts, the count request will early terminate
SearchRequest	toSearchRequest() Deprecated.
String	toString() Deprecated.
String[]	types() Deprecated. The types of documents the query will run against.
CountRequest	types(String... types) Deprecated. The types of documents the query will run against.
void	writeTo(StreamOutput out) Deprecated.

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

indices, indices, indicesOptions, indicesOptions, validate

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MIN_SCORE

public static final float DEFAULT_MIN_SCORE

Deprecated.

See Also:

Constant Field Values

routing

@Nullable
protected String routing

Deprecated.

Constructor Detail

CountRequest

public CountRequest(String... indices)

Deprecated.

Constructs a new count request against the provided indices. No indices provided means it will run against all indices.

Method Detail

minScore

public float minScore()

Deprecated.

The minimum score of the documents to include in the count.

minScore

public CountRequest minScore(float minScore)

Deprecated.

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

source

public BytesReference source()

Deprecated.

The source to execute.

source

public CountRequest source(QuerySourceBuilder sourceBuilder)

Deprecated.

The source to execute.

source

public CountRequest source(Map querySource)

Deprecated.

The source to execute in the form of a map.

source

public CountRequest source(XContentBuilder builder)

Deprecated.

source

public CountRequest source(String querySource)

Deprecated.

The source to execute. It is preferable to use either source(byte[]) or source(QuerySourceBuilder).

source

public CountRequest source(byte[] querySource)

Deprecated.

The source to execute.

source

public CountRequest source(byte[] querySource,
                           int offset,
                           int length)

Deprecated.

The source to execute.

source

public CountRequest source(BytesReference querySource)

Deprecated.

types

public String[] types()

Deprecated.

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

types

public CountRequest types(String... types)

Deprecated.

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

routing

public String routing()

Deprecated.

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

routing

public CountRequest routing(String routing)

Deprecated.

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

routing

public CountRequest routing(String... routings)

Deprecated.

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

preference

public CountRequest preference(String preference)

Deprecated.

preference

public String preference()

Deprecated.

terminateAfter

public CountRequest terminateAfter(int terminateAfterCount)

Deprecated.

Upon reaching terminateAfter counts, the count request will early terminate

terminateAfter

public int terminateAfter()

Deprecated.

readFrom

public void readFrom(StreamInput in)
              throws IOException

Deprecated.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastRequest<CountRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Deprecated.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastRequest<CountRequest>

Throws:

IOException

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

toSearchRequest

public SearchRequest toSearchRequest()

Deprecated.