You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Allows to retrieve a large numbers of results from a single search request.
24
+
# Run a scrolling search.
25
+
# IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the +search_after+ parameter with a point in time (PIT).
26
+
# The scroll API gets large sets of results from a single scrolling search request.
27
+
# To get the necessary scroll ID, submit a search API request that includes an argument for the +scroll+ query parameter.
28
+
# The +scroll+ parameter indicates how long Elasticsearch should retain the search context for the request.
29
+
# The search response returns a scroll ID in the +_scroll_id+ response body parameter.
30
+
# You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.
31
+
# If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.
32
+
# You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.
33
+
# IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.
25
34
#
26
-
# @option arguments [String] :scroll_id The scroll ID *Deprecated*
27
-
# @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
28
-
# @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
35
+
# @option arguments [String] :scroll_id The scroll ID
36
+
# @option arguments [Time] :scroll The period to retain the search context for scrolling. Server default: 1d.
37
+
# @option arguments [Boolean] :rest_total_hits_as_int If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.
0 commit comments