IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
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);
Asynchronous Executionedit
Clear Scroll Responseedit
The returned ClearScrollResponse
allows to retrieve information about the released
search contexts: