Package org.elasticsearch.action.search
Class SearchScrollRequestBuilder
java.lang.Object
org.elasticsearch.action.ActionRequestBuilder<SearchScrollRequest,SearchResponse>
org.elasticsearch.action.search.SearchScrollRequestBuilder
public class SearchScrollRequestBuilder extends ActionRequestBuilder<SearchScrollRequest,SearchResponse>
A search scroll action request builder.
-
Field Summary
Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
action, client, request
-
Constructor Summary
Constructors Constructor Description SearchScrollRequestBuilder(ElasticsearchClient client, SearchScrollAction action)
SearchScrollRequestBuilder(ElasticsearchClient client, SearchScrollAction action, java.lang.String scrollId)
-
Method Summary
Modifier and Type Method Description SearchScrollRequestBuilder
setScroll(java.lang.String keepAlive)
If set, will enable scrolling of the search request for the specified timeout.SearchScrollRequestBuilder
setScroll(org.elasticsearch.common.unit.TimeValue keepAlive)
If set, will enable scrolling of the search request for the specified timeout.SearchScrollRequestBuilder
setScroll(Scroll scroll)
If set, will enable scrolling of the search request.SearchScrollRequestBuilder
setScrollId(java.lang.String scrollId)
The scroll id to use to continue scrolling.Methods inherited from class org.elasticsearch.action.ActionRequestBuilder
execute, execute, get, get, get, request
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
SearchScrollRequestBuilder
-
SearchScrollRequestBuilder
public SearchScrollRequestBuilder(ElasticsearchClient client, SearchScrollAction action, java.lang.String scrollId)
-
-
Method Details
-
setScrollId
The scroll id to use to continue scrolling. -
setScroll
If set, will enable scrolling of the search request. -
setScroll
If set, will enable scrolling of the search request for the specified timeout. -
setScroll
If set, will enable scrolling of the search request for the specified timeout.
-