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
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb
+13-2Lines changed: 13 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -25,9 +25,20 @@ module Actions
25
25
# Delete an async search.
26
26
# If the asynchronous search is still running, it is cancelled.
27
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.
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.
29
29
#
30
30
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
31
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
32
+
# when they occur.
33
+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
34
+
# returned by Elasticsearch.
35
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
36
+
# For example `"exists_time": "1h"` for humans and
37
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
38
+
# readable values will be omitted. This makes sense for responses being consumed
39
+
# only by machines.
40
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb
+12-1Lines changed: 12 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -28,14 +28,25 @@ module Actions
28
28
#
29
29
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
30
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.
31
+
# When not specified, the `keep_alive` set with the corresponding submit async request will be used.
32
32
# Otherwise, it is possible to override the value and extend the validity of the request.
33
33
# When this period expires, the search, if still running, is cancelled.
34
34
# If the search is completed, its saved results are deleted.
35
35
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
36
36
# @option arguments [Time] :wait_for_completion_timeout Specifies to wait for the search to be completed up until the provided timeout.
37
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
38
# By default no timeout is set meaning that the currently available results will be returned without any additional wait.
39
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
40
+
# when they occur.
41
+
# @option arguments [String] :filter_path Comma-separated list of filters in dot notation which reduce the response
42
+
# returned by Elasticsearch.
43
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
44
+
# For example `"exists_time": "1h"` for humans and
45
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
46
+
# readable values will be omitted. This makes sense for responses being consumed
47
+
# only by machines.
48
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb
+15-4Lines changed: 15 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -26,15 +26,15 @@ module Actions
26
26
# When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.
27
27
# Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.
28
28
# By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
29
-
# The maximum allowed size for a stored async search response can be set by changing the +search.max_async_search_response_size+ cluster level setting.
29
+
# The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
30
30
#
31
-
# @option arguments [String, Array] :index A comma-separated list of index names to search; use +_all+ or empty string to perform the operation on all indices
31
+
# @option arguments [String, Array] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
32
32
# @option arguments [Time] :wait_for_completion_timeout Blocks and waits until the search is completed up to a certain timeout.
33
33
# When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. Server default: 1s.
34
34
# @option arguments [Time] :keep_alive Specifies how long the async search needs to be available.
35
35
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
36
-
# @option arguments [Boolean] :keep_on_completion If +true+, results are stored for later retrieval when the search completes within the +wait_for_completion_timeout+.
37
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes +_all+ string or when no indices have been specified)
36
+
# @option arguments [Boolean] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
37
+
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
38
38
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
39
39
# @option arguments [String] :analyzer The analyzer to use for the query string
40
40
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
@@ -75,6 +75,17 @@ module Actions
75
75
# @option arguments [Integer] :size Number of hits to return (default: 10)
0 commit comments