Package org.elasticsearch.action.search

Class SearchScrollRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.search.SearchScrollRequest
All Implemented Interfaces:
Writeable, org.elasticsearch.common.util.concurrent.RefCounted, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, TaskAwareRequest
public class SearchScrollRequest
extends ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject

  • Nested Class Summary

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

    TransportRequest.Empty

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

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

  • Field Summary

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    SearchScrollRequest()  
    SearchScrollRequest​(java.lang.String scrollId)  
    SearchScrollRequest​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    Task createTask​(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,​java.lang.String> headers)
    Returns the task object that should be used to keep track of the processing of the request.
    boolean equals​(java.lang.Object o)  
    void fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
    Parse a search scroll request from a request body provided through the REST layer.
    java.lang.String getDescription()
    Returns optional description of the request to be displayed by the task manager
    int hashCode()  
    ParsedScrollId parseScrollId()  
    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​(org.elasticsearch.common.unit.TimeValue keepAlive)
    If set, will enable scrolling of the search request for the specified timeout.
    SearchScrollRequest scroll​(Scroll scroll)
    If set, will enable scrolling of the search request.
    java.lang.String scrollId()
    The scroll id used to scroll the search.
    SearchScrollRequest scrollId​(java.lang.String scrollId)  
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    ActionRequestValidationException validate()  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class org.elasticsearch.action.ActionRequest

    getShouldStoreResult

    Methods inherited from class org.elasticsearch.transport.TransportRequest

    getParentTask, setParentTask

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    setParentTask

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • SearchScrollRequest

      public SearchScrollRequest()

    • SearchScrollRequest

      public SearchScrollRequest​(java.lang.String scrollId)

    • SearchScrollRequest

      public SearchScrollRequest​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • 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
      Overrides:
      writeTo in class ActionRequest
      Throws:
      java.io.IOException

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest

    • scrollId

      public java.lang.String scrollId()
      The scroll id used to scroll the search.

    • scrollId

      public SearchScrollRequest scrollId​(java.lang.String scrollId)

    • parseScrollId

      public ParsedScrollId parseScrollId()

    • 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​(org.elasticsearch.common.unit.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.

    • createTask

      public Task createTask​(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,​java.lang.String> headers)
      Description copied from interface: TaskAwareRequest
      Returns the task object that should be used to keep track of the processing of the request.
      Specified by:
      createTask in interface TaskAwareRequest

    • 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

    • getDescription

      public java.lang.String getDescription()
      Description copied from interface: TaskAwareRequest
      Returns optional description of the request to be displayed by the task manager
      Specified by:
      getDescription in interface TaskAwareRequest

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public void fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Parse a search scroll request from a request body provided through the REST layer. Values that are already be set and are also found while parsing will be overridden.
      Throws:
      java.io.IOException