org.elasticsearch.search
Class Scroll
java.lang.Object
org.elasticsearch.search.Scroll
- All Implemented Interfaces:
- Streamable
public class Scroll
- extends java.lang.Object
- implements Streamable
A scroll enables scrolling of search request. It holds a keepAlive()
time that
will control how long to keep the scrolling resources open.
Constructor Summary |
Scroll(TimeValue keepAlive)
Constructs a new scroll of the provided keep alive. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Scroll
public Scroll(TimeValue keepAlive)
- Constructs a new scroll of the provided keep alive.
keepAlive
public TimeValue keepAlive()
- How long the resources will be kept open to support the scroll request.
readScroll
public static Scroll readScroll(StreamInput in)
throws java.io.IOException
- Throws:
java.io.IOException
readFrom
public void readFrom(StreamInput in)
throws java.io.IOException
- Specified by:
readFrom
in interface Streamable
- Throws:
java.io.IOException
writeTo
public void writeTo(StreamOutput out)
throws java.io.IOException
- Specified by:
writeTo
in interface Streamable
- Throws:
java.io.IOException