Clear Scroll APIedit
The search contexts used by the Search Scroll API are automatically deleted when the scroll times out. But it is advised to release search contexts as soon as they are not necessary anymore using the Clear Scroll API.
Clear Scroll Requestedit
A ClearScrollRequest
can be created as follows:
Providing the scroll identifiersedit
The ClearScrollRequest
allows to clear one or more scroll identifiers in a single request.
The scroll identifiers can be added to the request one by one:
request.addScrollId(scrollId);
Or all together using:
request.setScrollIds(scrollIds);
Synchronous Executionedit
ClearScrollResponse response = client.clearScroll(request, RequestOptions.DEFAULT);
Asynchronous Executionedit
The asynchronous execution of a clear scroll request requires both the ClearScrollRequest
instance and an ActionListener
instance to be passed to the asynchronous
method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back using the onResponse
method
if the execution successfully completed or using the onFailure
method if
it failed.
A typical listener for ClearScrollResponse
looks like:
Clear Scroll Responseedit
The returned ClearScrollResponse
allows to retrieve information about the released
search contexts: