org.elasticsearch.action.search
Class SearchScrollRequestBuilder

java.lang.Object
  org.elasticsearch.action.support.BaseRequestBuilder<SearchScrollRequest,SearchResponse>
      org.elasticsearch.action.search.SearchScrollRequestBuilder

All Implemented Interfaces:

ActionRequestBuilder<SearchScrollRequest,SearchResponse>

public class SearchScrollRequestBuilder
extends BaseRequestBuilder<SearchScrollRequest,SearchResponse>

A search scroll action request builder.

Field Summary

Fields inherited from class org.elasticsearch.action.support.BaseRequestBuilder

client, request

Constructor Summary

SearchScrollRequestBuilder(Client client)

SearchScrollRequestBuilder(Client client, String scrollId)

Method Summary

protected void	doExecute(ActionListener<SearchResponse> listener)
SearchScrollRequestBuilder	listenerThreaded(boolean threadedListener) Should the listener be called on a separate thread if needed.
SearchScrollRequestBuilder	setOperationThreading(SearchOperationThreading operationThreading) Controls the the search operation threading model.
SearchScrollRequestBuilder	setScroll(Scroll scroll) If set, will enable scrolling of the search request.
SearchScrollRequestBuilder	setScroll(String keepAlive) If set, will enable scrolling of the search request for the specified timeout.
SearchScrollRequestBuilder	setScroll(TimeValue keepAlive) If set, will enable scrolling of the search request for the specified timeout.
SearchScrollRequestBuilder	setScrollId(String scrollId) The scroll id to use to continue scrolling.

Methods inherited from class org.elasticsearch.action.support.BaseRequestBuilder

execute, execute, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchScrollRequestBuilder

public SearchScrollRequestBuilder(Client client)

SearchScrollRequestBuilder

public SearchScrollRequestBuilder(Client client,
                                  String scrollId)

Method Detail

setOperationThreading

public SearchScrollRequestBuilder setOperationThreading(SearchOperationThreading operationThreading)

Controls the the search operation threading model.

listenerThreaded

public SearchScrollRequestBuilder listenerThreaded(boolean threadedListener)

Should the listener be called on a separate thread if needed.

setScrollId

public SearchScrollRequestBuilder setScrollId(String scrollId)

The scroll id to use to continue scrolling.

setScroll

public SearchScrollRequestBuilder setScroll(Scroll scroll)

If set, will enable scrolling of the search request.

setScroll

public SearchScrollRequestBuilder setScroll(TimeValue keepAlive)

If set, will enable scrolling of the search request for the specified timeout.

setScroll

public SearchScrollRequestBuilder setScroll(String keepAlive)

If set, will enable scrolling of the search request for the specified timeout.

doExecute

protected void doExecute(ActionListener<SearchResponse> listener)

Specified by:

doExecute in class BaseRequestBuilder<SearchScrollRequest,SearchResponse>