Package org.opensearch.search.fetch

Class ShardFetchRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.search.fetch.ShardFetchRequest

All Implemented Interfaces:

org.opensearch.core.common.io.stream.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.

Opensearch.internal:

Nested Class Summary

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

TransportRequest.Empty

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
ShardFetchRequest(org.opensearch.core.common.io.stream.StreamInput in)
ShardFetchRequest(ShardSearchContextId contextId, Collection<Integer> list, org.apache.lucene.search.ScoreDoc lastEmittedDoc)

Method Summary

Modifier and Type	Method	Description
ShardSearchContextId	contextId()
Task	createTask(long id, String type, String action, org.opensearch.core.tasks.TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
int[]	docIds()
int	docIdsSize()
AggregatedDfs	getAggregatedDfs()
String	getDescription()	Returns optional description of the request to be displayed by the task manager
RescoreDocIds	getRescoreDocIds()
ShardSearchRequest	getShardSearchRequest()
org.apache.lucene.search.ScoreDoc	lastEmittedDoc()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.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.opensearch.tasks.TaskAwareRequest

setParentTask

Constructor Details

ShardFetchRequest

public ShardFetchRequest(ShardSearchContextId contextId,
 Collection<Integer> list,
 org.apache.lucene.search.ScoreDoc lastEmittedDoc)

ShardFetchRequest

public ShardFetchRequest(org.opensearch.core.common.io.stream.StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class TransportRequest

Throws:

IOException

contextId

public ShardSearchContextId contextId()

docIds

public int[] docIds()

docIdsSize

public int docIdsSize()

lastEmittedDoc

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

createTask

public Task createTask(long id,
 String type,
 String action,
 org.opensearch.core.tasks.TaskId parentTaskId,
 Map<String,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 String getDescription()

Description copied from interface: TaskAwareRequest

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

getShardSearchRequest

@Nullable
public ShardSearchRequest getShardSearchRequest()

getRescoreDocIds

@Nullable
public RescoreDocIds getRescoreDocIds()

getAggregatedDfs

@Nullable
public AggregatedDfs getAggregatedDfs()