Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchScrollRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.search.SearchScrollRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest, ToXContent, ToXContentObject

public class SearchScrollRequest
extends UntypedActionRequest
implements ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchScrollRequest()
SearchScrollRequest(String scrollId)
SearchScrollRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
boolean	equals(Object o)
void	fromXContent(XContentParser parser)	Parse a search scroll request from a request body provided through the REST layer.
String	getDescription()	Returns optional description of the request to be displayed by the task manager
int	hashCode()
ParsedScrollId	parseScrollId()
TimeValue	scroll()	If set, will enable scrolling of the search request.
SearchScrollRequest	scroll(TimeValue keepAlive)	If set, will enable scrolling of the search request for the specified timeout.
String	scrollId()	The scroll id used to scroll the search.
SearchScrollRequest	scrollId(String scrollId)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

SearchScrollRequest

public SearchScrollRequest()

SearchScrollRequest

public SearchScrollRequest(String scrollId)

SearchScrollRequest

public SearchScrollRequest(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

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 ActionRequest

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

scrollId

public String scrollId()

The scroll id used to scroll the search.

scrollId

public SearchScrollRequest scrollId(String scrollId)

parseScrollId

public ParsedScrollId parseScrollId()

scroll

public TimeValue scroll()

If set, will enable scrolling of the search request.

scroll

public SearchScrollRequest scroll(TimeValue keepAlive)

If set, will enable scrolling of the search request for the specified timeout.

createTask

public Task createTask(long id,
 String type,
 String action,
 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.

Specified by:

createTask in interface TaskAwareRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class AbstractTransportRequest

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

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

Specified by:

getDescription in interface TaskAwareRequest

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public void fromXContent(XContentParser parser)
                  throws IOException

Parse a search scroll request from a request body provided through the REST layer. Values that are already be set and are also found while parsing will be overridden.

Throws:

IOException