Package org.elasticsearch.search.fetch

Class ShardFetchSearchRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.search.fetch.ShardFetchRequest

org.elasticsearch.search.fetch.ShardFetchSearchRequest

All Implemented Interfaces:

IndicesRequest, Writeable, TaskAwareRequest

public class ShardFetchSearchRequest
extends ShardFetchRequest
implements IndicesRequest

Shard level fetch request used with search. Holds indices taken from the original search request and implements IndicesRequest.

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.io.stream.Writeable

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

Constructor Summary

Constructors

Constructor	Description
ShardFetchSearchRequest()
ShardFetchSearchRequest(OriginalIndices originalIndices, long id, IntArrayList list, ScoreDoc lastEmittedDoc)
ShardFetchSearchRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.search.fetch.ShardFetchRequest

createTask, docIds, docIdsSize, getDescription, id, lastEmittedDoc

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Constructor Detail

ShardFetchSearchRequest

public ShardFetchSearchRequest()

ShardFetchSearchRequest

public ShardFetchSearchRequest(OriginalIndices originalIndices,
                               long id,
                               IntArrayList list,
                               ScoreDoc lastEmittedDoc)

ShardFetchSearchRequest

public ShardFetchSearchRequest(StreamInput in)
                        throws IOException

Throws:

IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ShardFetchRequest

Throws:

IOException

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

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