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/_async/client/async_search.py
+33-22
Original file line number
Diff line number
Diff line change
@@ -36,11 +36,13 @@ async def delete(
36
36
pretty: t.Optional[bool] =None,
37
37
) ->ObjectApiResponse[t.Any]:
38
38
"""
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.
39
+
.. raw:: html
40
+
41
+
<p>Delete an async search.</p>
42
+
<p>If the asynchronous search is still running, it is cancelled.
43
+
Otherwise, the saved search results are deleted.
44
+
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 <code>cancel_task</code> cluster privilege.</p>
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
-
submitted it.
90
+
.. raw:: html
91
+
92
+
<p>Get async search results.</p>
93
+
<p>Retrieve the results of a previously submitted asynchronous search request.
94
+
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.</p>
Run an async search. When the primary sort of the results is an indexed field,
330
-
shards get sorted based on minimum and maximum value that they hold for that
331
-
field. Partial results become available following the sort criteria that was
332
-
requested. Warning: Asynchronous search does not support scroll or search requests
333
-
that include only the suggest section. By default, Elasticsearch does not allow
334
-
you to store an async search response larger than 10Mb and an attempt to do this
335
-
results in an error. The maximum allowed size for a stored async search response
336
-
can be set by changing the `search.max_async_search_response_size` cluster level
337
-
setting.
336
+
.. raw:: html
337
+
338
+
<p>Run an async search.</p>
339
+
<p>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.</p>
340
+
<p>Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.</p>
341
+
<p>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.
342
+
The maximum allowed size for a stored async search response can be set by changing the <code>search.max_async_search_response_size</code> cluster level setting.</p>
Delete an autoscaling policy. NOTE: This feature is designed for indirect use
42
-
by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
43
-
Direct use is not supported.
41
+
.. raw:: html
42
+
43
+
<p>Delete an autoscaling policy.</p>
44
+
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
Get the autoscaling capacity. NOTE: This feature is designed for indirect use
93
-
by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
94
-
Direct use is not supported. This API gets the current autoscaling capacity based
95
-
on the configured autoscaling policy. It will return information to size the
96
-
cluster appropriately to the current workload. The `required_capacity` is calculated
97
-
as the maximum of the `required_capacity` result of all individual deciders that
98
-
are enabled for the policy. The operator should verify that the `current_nodes`
99
-
match the operator’s knowledge of the cluster to avoid making autoscaling decisions
100
-
based on stale or incomplete information. The response contains decider-specific
101
-
information you can use to diagnose how and why autoscaling determined a certain
102
-
capacity was required. This information is provided for diagnosis only. Do not
103
-
use this information to make autoscaling decisions.
94
+
.. raw:: html
95
+
96
+
<p>Get the autoscaling capacity.</p>
97
+
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
98
+
<p>This API gets the current autoscaling capacity based on the configured autoscaling policy.
99
+
It will return information to size the cluster appropriately to the current workload.</p>
100
+
<p>The <code>required_capacity</code> is calculated as the maximum of the <code>required_capacity</code> result of all individual deciders that are enabled for the policy.</p>
101
+
<p>The operator should verify that the <code>current_nodes</code> match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.</p>
102
+
<p>The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.
103
+
This information is provided for diagnosis only.
104
+
Do not use this information to make autoscaling decisions.</p>
Get an autoscaling policy. NOTE: This feature is designed for indirect use by
147
-
Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
148
-
Direct use is not supported.
148
+
.. raw:: html
149
+
150
+
<p>Get an autoscaling policy.</p>
151
+
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
Create or update an autoscaling policy. NOTE: This feature is designed for indirect
200
-
use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on
201
-
Kubernetes. Direct use is not supported.
203
+
.. raw:: html
204
+
205
+
<p>Create or update an autoscaling policy.</p>
206
+
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
0 commit comments