Skip to content

Commit 73b5396

Browse files
Auto-generated API code (#2778)
1 parent ab04a85 commit 73b5396

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+3162
-1846
lines changed

elasticsearch/_async/client/__init__.py

+670-225
Large diffs are not rendered by default.

elasticsearch/_async/client/async_search.py

+13-9
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ async def delete(
4444
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>
4545
4646
47-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
47+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_
4848
4949
:param id: A unique identifier for the async search.
5050
"""
@@ -94,11 +94,11 @@ async def get(
9494
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>
9595
9696
97-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
97+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_
9898
9999
:param id: A unique identifier for the async search.
100-
:param keep_alive: Specifies how long the async search should be available in
101-
the cluster. When not specified, the `keep_alive` set with the corresponding
100+
:param keep_alive: The length of time that the async search should be available
101+
in the cluster. When not specified, the `keep_alive` set with the corresponding
102102
submit async request will be used. Otherwise, it is possible to override
103103
the value and extend the validity of the request. When this period expires,
104104
the search, if still running, is cancelled. If the search is completed, its
@@ -157,13 +157,17 @@ async def status(
157157
158158
<p>Get the async search status.</p>
159159
<p>Get the status of a previously submitted async search request given its identifier, without retrieving search results.
160-
If the Elasticsearch security features are enabled, use of this API is restricted to the <code>monitoring_user</code> role.</p>
160+
If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:</p>
161+
<ul>
162+
<li>The user or API key that submitted the original async search request.</li>
163+
<li>Users that have the <code>monitor</code> cluster privilege or greater privileges.</li>
164+
</ul>
161165
162166
163-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
167+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_
164168
165169
:param id: A unique identifier for the async search.
166-
:param keep_alive: Specifies how long the async search needs to be available.
170+
:param keep_alive: The length of time that the async search needs to be available.
167171
Ongoing async searches and any saved search results are deleted after this
168172
period.
169173
"""
@@ -294,7 +298,7 @@ async def submit(
294298
runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
295299
script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
296300
search_after: t.Optional[
297-
t.Sequence[t.Union[None, bool, float, int, str, t.Any]]
301+
t.Sequence[t.Union[None, bool, float, int, str]]
298302
] = None,
299303
search_type: t.Optional[
300304
t.Union[str, t.Literal["dfs_query_then_fetch", "query_then_fetch"]]
@@ -341,7 +345,7 @@ async def submit(
341345
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>
342346
343347
344-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
348+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_
345349
346350
:param index: A comma-separated list of index names to search; use `_all` or
347351
empty string to perform the operation on all indices

elasticsearch/_async/client/autoscaling.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ async def delete_autoscaling_policy(
4444
<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>
4545
4646
47-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-delete-autoscaling-policy.html>`_
47+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy>`_
4848
4949
:param name: the name of the autoscaling policy
5050
:param master_timeout: Period to wait for a connection to the master node. If
@@ -104,7 +104,7 @@ async def get_autoscaling_capacity(
104104
Do not use this information to make autoscaling decisions.</p>
105105
106106
107-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
107+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity>`_
108108
109109
:param master_timeout: Period to wait for a connection to the master node. If
110110
no response is received before the timeout expires, the request fails and
@@ -151,7 +151,7 @@ async def get_autoscaling_policy(
151151
<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>
152152
153153
154-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
154+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity>`_
155155
156156
:param name: the name of the autoscaling policy
157157
:param master_timeout: Period to wait for a connection to the master node. If
@@ -206,7 +206,7 @@ async def put_autoscaling_policy(
206206
<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>
207207
208208
209-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-put-autoscaling-policy.html>`_
209+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy>`_
210210
211211
:param name: the name of the autoscaling policy
212212
:param policy:

0 commit comments

Comments
 (0)