Package org.elasticsearch.search

Class Scroll

java.lang.Object

org.elasticsearch.search.Scroll

All Implemented Interfaces:

Writeable

public final class Scroll
extends Object
implements Writeable

A scroll enables scrolling of search request. It holds a keepAlive() time that will control how long to keep the scrolling resources open.

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
Scroll(StreamInput in)
Scroll(TimeValue keepAlive)	Constructs a new scroll of the provided keep alive.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
TimeValue	keepAlive()	How long the resources will be kept open to support the scroll request.
String	toString()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Constructor Details

Scroll

public Scroll(StreamInput in)
       throws IOException

Throws:

IOException

Scroll

public Scroll(TimeValue keepAlive)

Constructs a new scroll of the provided keep alive.

Method Details

keepAlive

public TimeValue keepAlive()

How long the resources will be kept open to support the scroll request.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

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 Object