Skip to content

Commit

Permalink
Auto-generated API code
Browse files Browse the repository at this point in the history
  • Loading branch information
@elasticmachine
elasticmachine committed Oct 7, 2024
1 parent 14e6265 commit 4a5a3bd
Show file tree
Hide file tree
Showing 78 changed files with 1,180 additions and 970 deletions.
86 changes: 43 additions & 43 deletions elasticsearch/_async/client/__init__.py
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions elasticsearch/_async/client/async_search.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ async def delete(
search is restricted to: the authenticated user that submitted the original search
request; users that have the `cancel_task` cluster privilege.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/async-search.html>`_
:param id: A unique identifier for the async search.
"""
Expand Down Expand Up @@ -90,7 +90,7 @@ async def get(
results of a specific async search is restricted to the user or API key that
submitted it.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/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
Expand Down Expand Up @@ -153,7 +153,7 @@ async def status(
Elasticsearch security features are enabled, use of this API is restricted to
the `monitoring_user` role.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/async-search.html>`_
:param id: A unique identifier for the async search.
"""
Expand Down Expand Up @@ -333,7 +333,7 @@ async def submit(
response can be set by changing the `search.max_async_search_response_size` cluster
level setting.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/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
8 changes: 4 additions & 4 deletions elasticsearch/_async/client/autoscaling.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ async def delete_autoscaling_policy(
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
Direct use is not supported.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-delete-autoscaling-policy.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/autoscaling-delete-autoscaling-policy.html>`_
:param name: the name of the autoscaling policy
"""
Expand Down Expand Up @@ -79,7 +79,7 @@ async def get_autoscaling_capacity(
Gets the current autoscaling capacity based on the configured autoscaling policy.
Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/autoscaling-get-autoscaling-capacity.html>`_
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_autoscaling/capacity"
Expand Down Expand Up @@ -116,7 +116,7 @@ async def get_autoscaling_policy(
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
Direct use is not supported.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-get-autoscaling-capacity.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/autoscaling-get-autoscaling-capacity.html>`_
:param name: the name of the autoscaling policy
"""
Expand Down Expand Up @@ -161,7 +161,7 @@ async def put_autoscaling_policy(
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
Direct use is not supported.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-put-autoscaling-policy.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/autoscaling-put-autoscaling-policy.html>`_
: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
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ async def aliases(
not intended for use by applications. For application consumption, use the aliases
API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-alias.html>`_
: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 @@ -145,7 +145,7 @@ async def allocation(
disk space. IMPORTANT: cat APIs are only intended for human consumption using
the command line or Kibana console. They are not intended for use by applications.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-allocation.html>`_
:param node_id: Comma-separated list of node identifiers or names used to limit
the returned information.
Expand Down Expand Up @@ -232,7 +232,7 @@ async def component_templates(
for use by applications. For application consumption, use the get component template
API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-component-templates.html>`_
:param name: The name of the component template. Accepts wildcard expressions.
If omitted, all component templates are returned.
Expand Down Expand Up @@ -316,7 +316,7 @@ async def count(
console. They are not intended for use by applications. For application consumption,
use the count API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-count.html>`_
: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 @@ -402,7 +402,7 @@ async def fielddata(
using the command line or Kibana console. They are not intended for use by applications.
For application consumption, use the nodes stats API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-fielddata.html>`_
:param fields: Comma-separated list of fields used to limit returned information.
To retrieve all fields, omit this parameter.
Expand Down Expand Up @@ -497,7 +497,7 @@ async def health(
across multiple nodes. You also can use the API to track the recovery of a large
cluster over a longer period of time.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-health.html>`_
: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 @@ -574,7 +574,7 @@ async def help(
"""
Get CAT help. Returns help for the CAT APIs.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat.html>`_
: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 @@ -672,7 +672,7 @@ async def indices(
using the command line or Kibana console. They are not intended for use by applications.
For application consumption, use an index endpoint.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-indices.html>`_
: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 @@ -774,7 +774,7 @@ async def master(
command line or Kibana console. They are not intended for use by applications.
For application consumption, use the nodes info API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-master.html>`_
: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 @@ -949,7 +949,7 @@ async def ml_data_frame_analytics(
For application consumption, use the get data frame analytics jobs statistics
API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-dfanalytics.html>`_
: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 @@ -1123,7 +1123,7 @@ async def ml_datafeeds(
using the Kibana console or command line. They are not intended for use by applications.
For application consumption, use the get datafeed statistics API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-datafeeds.html>`_
:param datafeed_id: A numerical character string that uniquely identifies the
datafeed.
Expand Down Expand Up @@ -1496,7 +1496,7 @@ async def ml_jobs(
for use by applications. For application consumption, use the get anomaly detection
job statistics API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-anomaly-detectors.html>`_
: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 @@ -1685,7 +1685,7 @@ async def ml_trained_models(
console or command line. They are not intended for use by applications. For application
consumption, use the get trained models statistics API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-trained-model.html>`_
: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 @@ -1782,7 +1782,7 @@ async def nodeattrs(
are not intended for use by applications. For application consumption, use the
nodes info API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-nodeattrs.html>`_
: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 @@ -1861,7 +1861,7 @@ async def nodes(
are not intended for use by applications. For application consumption, use the
nodes info API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-nodes.html>`_
: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 @@ -1946,7 +1946,7 @@ async def pending_tasks(
console. They are not intended for use by applications. For application consumption,
use the pending cluster tasks API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-pending-tasks.html>`_
: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 @@ -2020,7 +2020,7 @@ async def plugins(
They are not intended for use by applications. For application consumption, use
the nodes info API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-plugins.html>`_
: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 @@ -2104,7 +2104,7 @@ async def recovery(
line or Kibana console. They are not intended for use by applications. For application
consumption, use the index recovery API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-recovery.html>`_
: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 @@ -2196,7 +2196,7 @@ async def repositories(
are not intended for use by applications. For application consumption, use the
get snapshot repository API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-repositories.html>`_
: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 @@ -2275,7 +2275,7 @@ async def segments(
console. They are not intended for use by applications. For application consumption,
use the index segments API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-segments.html>`_
: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 @@ -2364,7 +2364,7 @@ async def shards(
for human consumption using the command line or Kibana console. They are not
intended for use by applications.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-shards.html>`_
: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 @@ -2452,7 +2452,7 @@ async def snapshots(
console. They are not intended for use by applications. For application consumption,
use the get snapshot API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-snapshots.html>`_
: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 @@ -2542,7 +2542,7 @@ async def tasks(
console. They are not intended for use by applications. For application consumption,
use the task management API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/tasks.html>`_
: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 @@ -2632,7 +2632,7 @@ async def templates(
console. They are not intended for use by applications. For application consumption,
use the get index template API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-templates.html>`_
:param name: The name of the template to return. Accepts wildcard expressions.
If omitted, all templates are returned.
Expand Down Expand Up @@ -2718,7 +2718,7 @@ async def thread_pool(
They are not intended for use by applications. For application consumption, use
the nodes info API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-thread-pool.html>`_
:param thread_pool_patterns: A comma-separated list of thread pool names used
to limit the request. Accepts wildcard expressions.
Expand Down Expand Up @@ -2973,7 +2973,7 @@ async def transforms(
command line. They are not intended for use by applications. For application
consumption, use the get transform statistics API.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.x/cat-transforms.html>`_
: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

0 comments on commit 4a5a3bd

Please sign in to comment.