org.elasticsearch.action.exists

Class ExistsRequest

java.lang.Object

org.elasticsearch.common.ContextHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.broadcast.BroadcastOperationRequest<ExistsRequest>

org.elasticsearch.action.exists.ExistsRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable

public class ExistsRequest
extends BroadcastOperationRequest<ExistsRequest>

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
protected String	routing

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

indices

Constructor Summary

Constructors

Constructor and Description
ExistsRequest(String... indices) Constructs a new exists request against the provided indices.

Method Summary

Modifier and Type	Method and Description
protected void	beforeStart()
float	minScore() The minimum score of the documents to include in the count.
ExistsRequest	minScore(float minScore) The minimum score of the documents to include in the count.
String	preference()
ExistsRequest	preference(String preference) Routing preference for executing the search on shards
void	readFrom(StreamInput in)
String	routing() A comma separated list of routing values to control the shards the search will be executed on.
ExistsRequest	routing(String... routings) The routing values to control the shards that the search will be executed on.
ExistsRequest	routing(String routing) A comma separated list of routing values to control the shards the search will be executed on.
BytesReference	source() The source to execute.
ExistsRequest	source(byte[] querySource) The source to execute.
ExistsRequest	source(byte[] querySource, int offset, int length, boolean unsafe) The source to execute.
ExistsRequest	source(BytesReference querySource, boolean unsafe)
ExistsRequest	source(Map querySource) The source to execute in the form of a map.
ExistsRequest	source(QuerySourceBuilder sourceBuilder) The source to execute.
ExistsRequest	source(String querySource) The source to execute.
ExistsRequest	source(XContentBuilder builder)
String	toString()
String[]	types() The types of documents the query will run against.
ExistsRequest	types(String... types) The types of documents the query will run against.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

beforeLocalFork, indices, indices, indicesOptions, indicesOptions

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

getHeader, getHeaders, hasHeader, putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextHolder

contextSize, copyContextFrom, getContext, getFromContext, getFromContext, hasInContext, isContextEmpty, putAllInContext, 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

See Also:

Constant Field Values

routing

@Nullable
protected String routing

Constructor Detail

ExistsRequest

public ExistsRequest(String... indices)

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

Method Detail

validate

public ActionRequestValidationException validate()

Overrides:

validate in class BroadcastOperationRequest<ExistsRequest>

beforeStart

protected void beforeStart()

Overrides:

beforeStart in class BroadcastOperationRequest<ExistsRequest>

minScore

public float minScore()

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

minScore

public ExistsRequest minScore(float minScore)

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

routing

public String routing()

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

routing

public ExistsRequest routing(String routing)

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

routing

public ExistsRequest routing(String... routings)

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

preference

public ExistsRequest preference(String preference)

Routing preference for executing the search on shards

preference

public String preference()

source

public BytesReference source()

The source to execute.

source

public ExistsRequest source(QuerySourceBuilder sourceBuilder)

The source to execute.

source

public ExistsRequest source(Map querySource)

The source to execute in the form of a map.

source

public ExistsRequest source(XContentBuilder builder)

source

public ExistsRequest source(String querySource)

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

source

public ExistsRequest source(byte[] querySource)

The source to execute.

source

public ExistsRequest source(byte[] querySource,
                            int offset,
                            int length,
                            boolean unsafe)

The source to execute.

source

public ExistsRequest source(BytesReference querySource,
                            boolean unsafe)

types

public String[] types()

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

types

public ExistsRequest types(String... types)

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

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastOperationRequest<ExistsRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastOperationRequest<ExistsRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object