Package org.opensearch.action.search

Class SearchScrollRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<SearchScrollRequest,SearchResponse>

org.opensearch.action.search.SearchScrollRequestBuilder

@PublicApi(since="1.0.0")
public class SearchScrollRequestBuilder
extends ActionRequestBuilder<SearchScrollRequest,SearchResponse>

A search scroll action request builder.

Opensearch.api:

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
SearchScrollRequestBuilder(OpenSearchClient client, SearchScrollAction action)
SearchScrollRequestBuilder(OpenSearchClient client, SearchScrollAction action, String scrollId)

Method Summary

Modifier and Type	Method	Description
SearchScrollRequestBuilder	setScroll(String keepAlive)	If set, will enable scrolling of the search request for the specified timeout.
SearchScrollRequestBuilder	setScroll(org.opensearch.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(String scrollId)	The scroll id to use to continue scrolling.

Methods inherited from class org.opensearch.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

public SearchScrollRequestBuilder(OpenSearchClient client,
 SearchScrollAction action)

SearchScrollRequestBuilder

public SearchScrollRequestBuilder(OpenSearchClient client,
 SearchScrollAction action,
 String scrollId)

Method Details

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(org.opensearch.common.unit.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.