Skip to content
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.

Sign up for GitHub

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

Auto-generated code for main #2778

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Auto-generated code for main #2778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
893 changes: 669 additions & 224 deletions elasticsearch/_async/client/__init__.py
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 12 additions & 8 deletions elasticsearch/_async/client/async_search.py
View file
Open in desktop
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/master/async-search.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_

: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/master/async-search.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_

: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/master/async-search.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_

: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 @@ -341,7 +345,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/master/async-search.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_

: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
8 changes: 4 additions & 4 deletions elasticsearch/_async/client/autoscaling.py
View file
Open in desktop
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/master/autoscaling-delete-autoscaling-policy.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy>`_

: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/master/autoscaling-get-autoscaling-capacity.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity>`_

: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/master/autoscaling-get-autoscaling-capacity.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity>`_

: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/master/autoscaling-put-autoscaling-policy.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy>`_

:param name: the name of the autoscaling policy
:param policy:
Expand Down
52 changes: 26 additions & 26 deletions elasticsearch/_async/client/cat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ async def aliases(
<p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases>`_

:param name: A comma-separated list of aliases to retrieve. Supports wildcards
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
Expand Down Expand Up @@ -154,7 +154,7 @@ async def allocation(
<p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation>`_

:param node_id: A comma-separated list of node identifiers or names used to limit
the returned information.
Expand Down Expand Up @@ -243,7 +243,7 @@ async def component_templates(
They are not intended for use by applications. For application consumption, use the get component template API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates>`_

:param name: The name of the component template. It accepts wildcard expressions.
If it is omitted, all component templates are returned.
Expand Down Expand Up @@ -327,7 +327,7 @@ async def count(
They are not intended for use by applications. For application consumption, use the count API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count>`_

:param index: A comma-separated list of data streams, indices, and aliases used
to limit the request. It supports wildcards (`*`). To target all data streams
Expand Down Expand Up @@ -405,7 +405,7 @@ async def fielddata(
They are not intended for use by applications. For application consumption, use the nodes stats API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata>`_

:param fields: Comma-separated list of fields used to limit returned information.
To retrieve all fields, omit this parameter.
Expand Down Expand Up @@ -491,7 +491,7 @@ async def health(
You also can use the API to track the recovery of a large cluster over a longer period of time.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health>`_

:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
Expand Down Expand Up @@ -549,7 +549,7 @@ async def help(self) -> TextApiResponse:
<p>Get help for the CAT APIs.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat>`_
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_cat"
Expand Down Expand Up @@ -616,7 +616,7 @@ async def indices(
They are not intended for use by applications. For application consumption, use an index endpoint.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices>`_

:param index: Comma-separated list of data streams, indices, and aliases used
to limit the request. Supports wildcards (`*`). To target all data streams
Expand Down Expand Up @@ -714,7 +714,7 @@ async def master(
<p>IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master>`_

:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
Expand Down Expand Up @@ -892,7 +892,7 @@ async def ml_data_frame_analytics(
application consumption, use the get data frame analytics jobs statistics API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics>`_

:param id: The ID of the data frame analytics to fetch
:param allow_no_match: Whether to ignore if a wildcard expression matches no
Expand Down Expand Up @@ -1060,7 +1060,7 @@ async def ml_datafeeds(
application consumption, use the get datafeed statistics API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds>`_

:param datafeed_id: A numerical character string that uniquely identifies the
datafeed.
Expand Down Expand Up @@ -1426,7 +1426,7 @@ async def ml_jobs(
application consumption, use the get anomaly detection job statistics API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs>`_

:param job_id: Identifier for the anomaly detection job.
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
Expand Down Expand Up @@ -1611,7 +1611,7 @@ async def ml_trained_models(
application consumption, use the get trained models statistics API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models>`_

:param model_id: A unique identifier for the trained model.
:param allow_no_match: Specifies what to do when the request: contains wildcard
Expand Down Expand Up @@ -1704,7 +1704,7 @@ async def nodeattrs(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs>`_

:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
Expand Down Expand Up @@ -1787,7 +1787,7 @@ async def nodes(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes>`_

:param bytes: The unit used to display byte values.
:param format: Specifies the format to return the columnar data in, can be set
Expand Down Expand Up @@ -1874,7 +1874,7 @@ async def pending_tasks(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks>`_

:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
Expand Down Expand Up @@ -1954,7 +1954,7 @@ async def plugins(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins>`_

:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
Expand Down Expand Up @@ -2042,7 +2042,7 @@ async def recovery(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery>`_

:param index: A comma-separated list of data streams, indices, and aliases used
to limit the request. Supports wildcards (`*`). To target all data streams
Expand Down Expand Up @@ -2130,7 +2130,7 @@ async def repositories(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories>`_

:param format: Specifies the format to return the columnar data in, can be set
to `text`, `json`, `cbor`, `yaml`, or `smile`.
Expand Down Expand Up @@ -2211,7 +2211,7 @@ async def segments(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments>`_

:param index: A comma-separated list of data streams, indices, and aliases used
to limit the request. Supports wildcards (`*`). To target all data streams
Expand Down Expand Up @@ -2305,7 +2305,7 @@ async def shards(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards>`_

:param index: A comma-separated list of data streams, indices, and aliases used
to limit the request. Supports wildcards (`*`). To target all data streams
Expand Down Expand Up @@ -2394,7 +2394,7 @@ async def snapshots(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots>`_

:param repository: A comma-separated list of snapshot repositories used to limit
the request. Accepts wildcard expressions. `_all` returns all repositories.
Expand Down Expand Up @@ -2487,7 +2487,7 @@ async def tasks(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks>`_

:param actions: The task action names, which are used to limit the response.
:param detailed: If `true`, the response includes detailed information about
Expand Down Expand Up @@ -2581,7 +2581,7 @@ async def templates(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates>`_

:param name: The name of the template to return. Accepts wildcard expressions.
If omitted, all templates are returned.
Expand Down Expand Up @@ -2669,7 +2669,7 @@ async def thread_pool(
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool>`_

:param thread_pool_patterns: A comma-separated list of thread pool names used
to limit the request. Accepts wildcard expressions.
Expand Down Expand Up @@ -2926,7 +2926,7 @@ async def transforms(
application consumption, use the get transform statistics API.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms>`_

:param transform_id: A transform identifier or a wildcard expression. If you
do not specify one of these options, the API returns information for all
Expand Down
Loading