ShardFetchRequest (server 7.8.1 API)

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.search.fetch.ShardFetchRequest

All Implemented Interfaces:: Writeable, 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

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors
Constructor	Description
`ShardFetchRequest()`
`ShardFetchRequest(StreamInput in)`
`ShardFetchRequest(SearchContextId contextId, com.carrotsearch.hppc.IntArrayList list, org.apache.lucene.search.ScoreDoc lastEmittedDoc)`

Method Summary

Modifier and Type	Method	Description
`SearchContextId`	`contextId()`
`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.
`int[]`	`docIds()`
`int`	`docIdsSize()`
`java.lang.String`	`getDescription()`	Returns optional description of the request to be displayed by the task manager
`org.apache.lucene.search.ScoreDoc`	`lastEmittedDoc()`
`void`	`writeTo(StreamOutput out)`	Write this into the 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 Details
- ShardFetchRequest
  
  public ShardFetchRequest()
- ShardFetchRequest
  
  public ShardFetchRequest(SearchContextId contextId, com.carrotsearch.hppc.IntArrayList list, org.apache.lucene.search.ScoreDoc lastEmittedDoc)
- ShardFetchRequest
  
  public ShardFetchRequest(StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
Method Details
- writeTo
  
  public void writeTo(StreamOutput out) throws java.io.IOException
  
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Overrides:
  
  writeTo in class TransportRequest
  
  Throws:
  
  java.io.IOException
- contextId
  
  public SearchContextId contextId()
- docIds
  
  public int[] docIds()
- docIdsSize
  
  public int docIdsSize()
- lastEmittedDoc
  
  public org.apache.lucene.search.ScoreDoc lastEmittedDoc()
- 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.
- getDescription
  
  public java.lang.String getDescription()
  
  Description copied from interface: TaskAwareRequest
  
  Returns optional description of the request to be displayed by the task manager