@@ -36,13 +36,13 @@ async def delete(
36
36
pretty : t .Optional [bool ] = None ,
37
37
) -> ObjectApiResponse [t .Any ]:
38
38
"""
39
- Deletes an async search by identifier . If the search is still running, the search
40
- request will be cancelled. Otherwise, the saved search results are deleted. If
41
- the Elasticsearch security features are enabled, the deletion of a specific async
42
- search is restricted to: the authenticated user that submitted the original search
43
- request; users that have the `cancel_task` cluster privilege.
39
+ Delete an async search. If the asynchronous search is still running, it is cancelled.
40
+ Otherwise, the saved search results are deleted. If the Elasticsearch security
41
+ features are enabled, the deletion of a specific async search is restricted to:
42
+ the authenticated user that submitted the original search request; users that
43
+ have the `cancel_task` cluster privilege.
44
44
45
- `<https://www.elastic.co/guide/en/elasticsearch/reference/master /async-search.html>`_
45
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html>`_
46
46
47
47
:param id: A unique identifier for the async search.
48
48
"""
@@ -85,12 +85,12 @@ async def get(
85
85
] = None ,
86
86
) -> ObjectApiResponse [t .Any ]:
87
87
"""
88
- Retrieves the results of a previously submitted async search request given its
89
- identifier . If the Elasticsearch security features are enabled, access to the
90
- results of a specific async search is restricted to the user or API key that
88
+ Get async search results. Retrieve the results of a previously submitted asynchronous
89
+ search request . If the Elasticsearch security features are enabled, access to
90
+ the results of a specific async search is restricted to the user or API key that
91
91
submitted it.
92
92
93
- `<https://www.elastic.co/guide/en/elasticsearch/reference/master /async-search.html>`_
93
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html>`_
94
94
95
95
:param id: A unique identifier for the async search.
96
96
:param keep_alive: Specifies how long the async search should be available in
@@ -148,12 +148,12 @@ async def status(
148
148
pretty : t .Optional [bool ] = None ,
149
149
) -> ObjectApiResponse [t .Any ]:
150
150
"""
151
- Get async search status Retrieves the status of a previously submitted async
151
+ Get async search status. Retrieve the status of a previously submitted async
152
152
search request given its identifier, without retrieving search results. If the
153
153
Elasticsearch security features are enabled, use of this API is restricted to
154
154
the `monitoring_user` role.
155
155
156
- `<https://www.elastic.co/guide/en/elasticsearch/reference/master /async-search.html>`_
156
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html>`_
157
157
158
158
:param id: A unique identifier for the async search.
159
159
"""
@@ -323,17 +323,17 @@ async def submit(
323
323
body : t .Optional [t .Dict [str , t .Any ]] = None ,
324
324
) -> ObjectApiResponse [t .Any ]:
325
325
"""
326
- Runs a search request asynchronously . When the primary sort of the results is
327
- an indexed field, shards get sorted based on minimum and maximum value that they
328
- hold for that field, hence partial results become available following the sort
329
- criteria that was requested. Warning: Async search does not support scroll nor
330
- search requests that only include the suggest section. By default, Elasticsearch
331
- doesn’t allow you to store an async search response larger than 10Mb and an attempt
332
- to do this results in an error. The maximum allowed size for a stored async search
333
- response can be set by changing the `search.max_async_search_response_size` cluster
334
- level setting.
326
+ Run an async search . When the primary sort of the results is an indexed field,
327
+ shards get sorted based on minimum and maximum value that they hold for that
328
+ field. Partial results become available following the sort criteria that was
329
+ requested. Warning: Asynchronous search does not support scroll or search requests
330
+ that include only the suggest section. By default, Elasticsearch does not allow
331
+ you to store an async search response larger than 10Mb and an attempt to do this
332
+ results in an error. The maximum allowed size for a stored async search response
333
+ can be set by changing the `search.max_async_search_response_size` cluster level
334
+ setting.
335
335
336
- `<https://www.elastic.co/guide/en/elasticsearch/reference/master /async-search.html>`_
336
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16 /async-search.html>`_
337
337
338
338
:param index: A comma-separated list of index names to search; use `_all` or
339
339
empty string to perform the operation on all indices
0 commit comments