Package org.elasticsearch.search

Class Scroll

org.elasticsearch.search.Scroll
All Implemented Interfaces:
Writeable
public final class Scroll extends 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​(org.elasticsearch.core.TimeValue keepAlive)
    Constructs a new scroll of the provided keep alive.

  • Method Summary

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

    Methods inherited from class java.lang.

    , , , , , , ,

  • Constructor Details

    • Scroll

      public Scroll​(StreamInput in) throws
      Throws:

    • Scroll

      public Scroll​(org.elasticsearch.core.TimeValue keepAlive)
      Constructs a new scroll of the provided keep alive.

  • Method Details

    • keepAlive

      public org.elasticsearch.core.TimeValue keepAlive()
      How long the resources will be kept open to support the scroll request.

    • writeTo

      public void writeTo​(StreamOutput out) throws
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:

    • equals

      public boolean equals​( o)
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class 

    • toString

      public  toString()
      Overrides:
       in class