Package org.opensearch.search.internal

Class InternalScrollSearchRequest

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.search.internal.InternalScrollSearchRequest

All Implemented Interfaces:

Writeable, TaskAwareRequest

public class InternalScrollSearchRequest
extends TransportRequest

Nested Class Summary

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

TransportRequest.Empty

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

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

Constructor Summary

Constructors

Constructor	Description
InternalScrollSearchRequest()
InternalScrollSearchRequest(SearchScrollRequest request, ShardSearchContextId contextId)
InternalScrollSearchRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
ShardSearchContextId	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.
java.lang.String	getDescription()	Returns optional description of the request to be displayed by the task manager
Scroll	scroll()
InternalScrollSearchRequest	scroll(Scroll scroll)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

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

InternalScrollSearchRequest

public InternalScrollSearchRequest()

InternalScrollSearchRequest

public InternalScrollSearchRequest(SearchScrollRequest request, ShardSearchContextId contextId)

InternalScrollSearchRequest

public InternalScrollSearchRequest(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 ShardSearchContextId contextId()

scroll

public Scroll scroll()

scroll

public InternalScrollSearchRequest scroll(Scroll scroll)

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