org.elasticsearch.action.search

Class SearchScrollRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<SearchScrollRequest>

org.elasticsearch.action.search.SearchScrollRequest

All Implemented Interfaces:

Streamable

public class SearchScrollRequest
extends ActionRequest<SearchScrollRequest>

Nested Class Summary

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

TransportRequest.Empty

Constructor Summary

Constructors

Constructor and Description
SearchScrollRequest()
SearchScrollRequest(java.lang.String scrollId)

Method Summary

Modifier and Type	Method and Description
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
Scroll	scroll() If set, will enable scrolling of the search request.
SearchScrollRequest	scroll(Scroll scroll) If set, will enable scrolling of the search request.
SearchScrollRequest	scroll(java.lang.String keepAlive) If set, will enable scrolling of the search request for the specified timeout.
SearchScrollRequest	scroll(TimeValue keepAlive) If set, will enable scrolling of the search request for the specified timeout.
java.lang.String	scrollId() The scroll id used to scroll the search.
SearchScrollRequest	scrollId(java.lang.String scrollId)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription, getParentTask, setParentTask, 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

Constructor Detail

SearchScrollRequest

public SearchScrollRequest()

SearchScrollRequest

public SearchScrollRequest(java.lang.String scrollId)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<SearchScrollRequest>

scrollId

public java.lang.String scrollId()

The scroll id used to scroll the search.

scrollId

public SearchScrollRequest scrollId(java.lang.String scrollId)

scroll

public Scroll scroll()

If set, will enable scrolling of the search request.

scroll

public SearchScrollRequest scroll(Scroll 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.

scroll

public SearchScrollRequest scroll(java.lang.String keepAlive)

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

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 ActionRequest<SearchScrollRequest>

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 ActionRequest<SearchScrollRequest>

Throws:

java.io.IOException