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
# Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
25
+
# Delete an async search.
26
+
# If the asynchronous search is still running, it is cancelled.
27
+
# Otherwise, the saved search results are deleted.
28
+
# If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the +cancel_task+ cluster privilege.
26
29
#
27
-
# @option arguments [String] :id The async search ID
30
+
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
# Retrieves the results of a previously submitted async search request given its ID.
25
+
# Get async search results.
26
+
# Retrieve the results of a previously submitted asynchronous search request.
27
+
# If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
26
28
#
27
-
# @option arguments [String] :id The async search ID
28
-
# @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
29
-
# @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available
29
+
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
30
+
# @option arguments [Time] :keep_alive The length of time that the async search should be available in the cluster.
31
+
# When not specified, the +keep_alive+ set with the corresponding submit async request will be used.
32
+
# Otherwise, it is possible to override the value and extend the validity of the request.
33
+
# When this period expires, the search, if still running, is cancelled.
34
+
# If the search is completed, its saved results are deleted.
30
35
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
36
+
# @option arguments [Time] :wait_for_completion_timeout Specifies to wait for the search to be completed up until the provided timeout.
37
+
# Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
38
+
# By default no timeout is set meaning that the currently available results will be returned without any additional wait.
0 commit comments