Scroll (server 6.8.23 API)

java.lang.Object
- org.elasticsearch.search.Scroll

All Implemented Interfaces:

Writeable
```
public final class Scroll
extends java.lang.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(java.lang.Object o)`
`int`	`hashCode()`
`TimeValue`	`keepAlive()`	How long the resources will be kept open to support the scroll request.
`java.lang.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 Detail
  - Scroll
```
public Scroll(StreamInput in)
       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - Scroll
```
public Scroll(TimeValue keepAlive)
```
    Constructs a new scroll of the provided keep alive.
- Method Detail
  - keepAlive
```
public TimeValue keepAlive()
```
    How long the resources will be kept open to support the scroll request.
  - 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
    
    Throws:
    
    java.io.IOException
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object