Skip to content

Auto-generated code for 8.18 #2823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,092 changes: 821 additions & 271 deletions elasticsearch/_async/client/__init__.py

Large diffs are not rendered by default.

26 changes: 18 additions & 8 deletions elasticsearch/_async/client/async_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ async def delete(
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>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html>`_

:param id: A unique identifier for the async search.
"""
Expand Down Expand Up @@ -94,11 +94,11 @@ async def get(
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>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html>`_

:param id: A unique identifier for the async search.
:param keep_alive: Specifies how long the async search should be available in
the cluster. When not specified, the `keep_alive` set with the corresponding
:param keep_alive: The length of time that the async search should be available
in the cluster. When not specified, the `keep_alive` set with the corresponding
submit async request will be used. Otherwise, it is possible to override
the value and extend the validity of the request. When this period expires,
the search, if still running, is cancelled. If the search is completed, its
Expand Down Expand Up @@ -157,13 +157,17 @@ async def status(

<p>Get the async search status.</p>
<p>Get the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, use of this API is restricted to the <code>monitoring_user</code> role.</p>
If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:</p>
<ul>
<li>The user or API key that submitted the original async search request.</li>
<li>Users that have the <code>monitor</code> cluster privilege or greater privileges.</li>
</ul>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html>`_

:param id: A unique identifier for the async search.
:param keep_alive: Specifies how long the async search needs to be available.
:param keep_alive: The length of time that the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this
period.
"""
Expand Down Expand Up @@ -270,6 +274,7 @@ async def submit(
ignore_throttled: t.Optional[bool] = None,
ignore_unavailable: t.Optional[bool] = None,
indices_boost: t.Optional[t.Sequence[t.Mapping[str, float]]] = None,
keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
keep_on_completion: t.Optional[bool] = None,
knn: t.Optional[
t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]]
Expand Down Expand Up @@ -341,7 +346,7 @@ async def submit(
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>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html>`_

:param index: A comma-separated list of index names to search; use `_all` or
empty string to perform the operation on all indices
Expand Down Expand Up @@ -384,6 +389,9 @@ async def submit(
:param ignore_unavailable: Whether specified concrete indices should be ignored
when unavailable (missing or closed)
:param indices_boost: Boosts the _score of documents from specified indices.
:param keep_alive: Specifies how long the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this
period.
:param keep_on_completion: If `true`, results are stored for later retrieval
when the search completes within the `wait_for_completion_timeout`.
:param knn: Defines the approximate kNN search to run.
Expand Down Expand Up @@ -510,6 +518,8 @@ async def submit(
__query["ignore_throttled"] = ignore_throttled
if ignore_unavailable is not None:
__query["ignore_unavailable"] = ignore_unavailable
if keep_alive is not None:
__query["keep_alive"] = keep_alive
if keep_on_completion is not None:
__query["keep_on_completion"] = keep_on_completion
if lenient is not None:
Expand Down
8 changes: 4 additions & 4 deletions elasticsearch/_async/client/autoscaling.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ async def delete_autoscaling_policy(
<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>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-delete-autoscaling-policy.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-delete-autoscaling-policy.html>`_

:param name: the name of the autoscaling policy
:param master_timeout: Period to wait for a connection to the master node. If
Expand Down Expand Up @@ -104,7 +104,7 @@ async def get_autoscaling_capacity(
Do not use this information to make autoscaling decisions.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html>`_

:param master_timeout: Period to wait for a connection to the master node. If
no response is received before the timeout expires, the request fails and
Expand Down Expand Up @@ -151,7 +151,7 @@ async def get_autoscaling_policy(
<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>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-get-autoscaling-capacity.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html>`_

:param name: the name of the autoscaling policy
:param master_timeout: Period to wait for a connection to the master node. If
Expand Down Expand Up @@ -206,7 +206,7 @@ async def put_autoscaling_policy(
<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>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-put-autoscaling-policy.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-put-autoscaling-policy.html>`_

:param name: the name of the autoscaling policy
:param policy:
Expand Down
Loading