Skip to content

Commit 83a07f0

Browse files
Auto-generated code for 8.16 (#2672)
1 parent 4e34550 commit 83a07f0

Some content is hidden

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

78 files changed

+1880
-1292
lines changed

elasticsearch/_async/client/__init__.py

Lines changed: 98 additions & 57 deletions
Large diffs are not rendered by default.

elasticsearch/_async/client/async_search.py

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ async def delete(
3636
pretty: t.Optional[bool] = None,
3737
) -> ObjectApiResponse[t.Any]:
3838
"""
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.
4444
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>`_
4646
4747
:param id: A unique identifier for the async search.
4848
"""
@@ -85,12 +85,12 @@ async def get(
8585
] = None,
8686
) -> ObjectApiResponse[t.Any]:
8787
"""
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
9191
submitted it.
9292
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>`_
9494
9595
:param id: A unique identifier for the async search.
9696
:param keep_alive: Specifies how long the async search should be available in
@@ -148,12 +148,12 @@ async def status(
148148
pretty: t.Optional[bool] = None,
149149
) -> ObjectApiResponse[t.Any]:
150150
"""
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
152152
search request given its identifier, without retrieving search results. If the
153153
Elasticsearch security features are enabled, use of this API is restricted to
154154
the `monitoring_user` role.
155155
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>`_
157157
158158
:param id: A unique identifier for the async search.
159159
"""
@@ -323,17 +323,17 @@ async def submit(
323323
body: t.Optional[t.Dict[str, t.Any]] = None,
324324
) -> ObjectApiResponse[t.Any]:
325325
"""
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.
335335
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>`_
337337
338338
:param index: A comma-separated list of index names to search; use `_all` or
339339
empty string to perform the operation on all indices

elasticsearch/_async/client/autoscaling.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ async def delete_autoscaling_policy(
3939
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
4040
Direct use is not supported.
4141
42-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-delete-autoscaling-policy.html>`_
42+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html>`_
4343
4444
:param name: the name of the autoscaling policy
4545
"""
@@ -79,7 +79,7 @@ async def get_autoscaling_capacity(
7979
Gets the current autoscaling capacity based on the configured autoscaling policy.
8080
Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
8181
82-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
82+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html>`_
8383
"""
8484
__path_parts: t.Dict[str, str] = {}
8585
__path = "/_autoscaling/capacity"
@@ -116,7 +116,7 @@ async def get_autoscaling_policy(
116116
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
117117
Direct use is not supported.
118118
119-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
119+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html>`_
120120
121121
:param name: the name of the autoscaling policy
122122
"""
@@ -161,7 +161,7 @@ async def put_autoscaling_policy(
161161
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
162162
Direct use is not supported.
163163
164-
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-put-autoscaling-policy.html>`_
164+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-put-autoscaling-policy.html>`_
165165
166166
:param name: the name of the autoscaling policy
167167
:param policy:

0 commit comments

Comments
 (0)