Package org.elasticsearch.search.query

Class QuerySearchRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.search.query.QuerySearchRequest

All Implemented Interfaces:

IndicesRequest, Streamable, Writeable, TaskAwareRequest

public class QuerySearchRequest
extends TransportRequest
implements IndicesRequest

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

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

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

Constructor Summary

Constructors

Constructor	Description
QuerySearchRequest()
QuerySearchRequest(OriginalIndices originalIndices, long id, AggregatedDfs dfs)

Method Summary

Modifier and Type	Method	Description
Task	createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)	Returns the task object that should be used to keep track of the processing of the request.
AggregatedDfs	dfs()
java.lang.String	getDescription()	Returns optional description of the request to be displayed by the task manager
long	id()
java.lang.String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Constructor Detail

QuerySearchRequest

public QuerySearchRequest()

QuerySearchRequest

public QuerySearchRequest(OriginalIndices originalIndices,
                          long id,
                          AggregatedDfs dfs)

Method Detail

id

public long id()

dfs

public AggregatedDfs dfs()

indices

public java.lang.String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

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

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class TransportRequest

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class TransportRequest

Throws:

java.io.IOException

createTask

public Task createTask(long id,
                       java.lang.String type,
                       java.lang.String action,
                       TaskId parentTaskId,
                       java.util.Map<java.lang.String,java.lang.String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request. A request can override this method and return null to avoid being tracked by the task manager.

Specified by:

createTask in interface TaskAwareRequest

getDescription

public java.lang.String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

Specified by:

getDescription in interface TaskAwareRequest