org.elasticsearch.action.search
Class SearchScrollRequest

java.lang.Object
  extended by org.elasticsearch.action.search.SearchScrollRequest
All Implemented Interfaces:
ActionRequest, Streamable

public class SearchScrollRequest
extends java.lang.Object
implements ActionRequest


Constructor Summary
SearchScrollRequest()
           
SearchScrollRequest(java.lang.String scrollId)
           
 
Method Summary
 boolean listenerThreaded()
          Should the listener be called on a separate thread if needed.
 SearchScrollRequest listenerThreaded(boolean threadedListener)
          Should the listener be called on a separate thread if needed.
 SearchOperationThreading operationThreading()
          Controls the the search operation threading model.
 SearchScrollRequest operationThreading(SearchOperationThreading operationThreading)
          Controls the the search operation threading model.
 void readFrom(StreamInput in)
           
 Scroll scroll()
          If set, will enable scrolling of the search request.
 SearchScrollRequest scroll(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(TimeValue keepAlive)
          If set, will enable scrolling of the search request for the specified timeout.
 java.lang.String scrollId()
          The scroll id used to scroll the search.
 ActionRequestValidationException validate()
           
 void writeTo(StreamOutput out)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchScrollRequest

public SearchScrollRequest()

SearchScrollRequest

public SearchScrollRequest(java.lang.String scrollId)
Method Detail

validate

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

operationThreading

public SearchOperationThreading operationThreading()
Controls the the search operation threading model.


operationThreading

public SearchScrollRequest operationThreading(SearchOperationThreading operationThreading)
Controls the the search operation threading model.


listenerThreaded

public boolean listenerThreaded()
Should the listener be called on a separate thread if needed.

Specified by:
listenerThreaded in interface ActionRequest

listenerThreaded

public SearchScrollRequest listenerThreaded(boolean threadedListener)
Should the listener be called on a separate thread if needed.

Specified by:
listenerThreaded in interface ActionRequest

scrollId

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


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(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.


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