org.elasticsearch.search.fetch

Class ShardFetchRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.search.fetch.ShardFetchRequest

All Implemented Interfaces:

Streamable, TaskAwareRequest

Direct Known Subclasses:

ShardFetchSearchRequest

public class ShardFetchRequest
extends TransportRequest

Shard level fetch base request. Holds all the info needed to execute a fetch. Used with search scroll as the original request doesn't hold indices.

Nested Class Summary

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

TransportRequest.Empty

Constructor Summary

Constructors

Constructor and Description
ShardFetchRequest()
ShardFetchRequest(long id, com.carrotsearch.hppc.IntArrayList list, org.apache.lucene.search.ScoreDoc lastEmittedDoc)

Method Summary

Modifier and Type	Method and Description
Task	createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId) Returns the task object that should be used to keep track of the processing of the request.
int[]	docIds()
int	docIdsSize()
java.lang.String	getDescription() Returns optional description of the request to be displayed by the task manager
long	id()
org.apache.lucene.search.ScoreDoc	lastEmittedDoc()
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 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

ShardFetchRequest

public ShardFetchRequest()

ShardFetchRequest

public ShardFetchRequest(long id,
                         com.carrotsearch.hppc.IntArrayList list,
                         org.apache.lucene.search.ScoreDoc lastEmittedDoc)

Method Detail

id

public long id()

docIds

public int[] docIds()

docIdsSize

public int docIdsSize()

lastEmittedDoc

public org.apache.lucene.search.ScoreDoc lastEmittedDoc()

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

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)

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.

getDescription

public java.lang.String getDescription()

Description copied from interface: TaskAwareRequest

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