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 5, 2023
1 parent 65e0ea6 commit 1b47535
Show file tree
Hide file tree
Showing 72 changed files with 876 additions and 854 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 @@ -40,7 +40,7 @@ async def delete(
Deletes an async search by ID. If the search is still running, the search request
will be cancelled. Otherwise, the saved search results are deleted.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/async-search.html>`_
:param id: A unique identifier for the async search.
"""
Expand Down Expand Up @@ -82,7 +82,7 @@ async def get(
Retrieves the results of a previously submitted async search request given its
ID.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -139,7 +139,7 @@ async def status(
Retrieves the status of a previously submitted async search request given its
ID.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/async-search.html>`_
:param id: A unique identifier for the async search.
"""
Expand Down Expand Up @@ -310,7 +310,7 @@ async def submit(
"""
Executes a search request asynchronously.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/async-search.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -40,7 +40,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.11/autoscaling-delete-autoscaling-policy.html>`_
:param name: the name of the autoscaling policy
"""
Expand Down Expand Up @@ -76,7 +76,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.11/autoscaling-get-autoscaling-capacity.html>`_
"""
__path = "/_autoscaling/capacity"
__query: t.Dict[str, t.Any] = {}
Expand Down Expand Up @@ -109,7 +109,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.11/autoscaling-get-autoscaling-capacity.html>`_
:param name: the name of the autoscaling policy
"""
Expand Down Expand Up @@ -149,7 +149,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.11/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 @@ -67,7 +67,7 @@ async def aliases(
Shows information about currently configured aliases to indices including filter
and routing infos.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -152,7 +152,7 @@ async def allocation(
Provides a snapshot of how many shards are allocated to each data node and how
much disk space they are using.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-allocation.html>`_
:param node_id: Comma-separated list of node identifiers or names used to limit
the returned information.
Expand Down Expand Up @@ -230,7 +230,7 @@ async def component_templates(
"""
Returns information about existing component_templates templates.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -306,7 +306,7 @@ async def count(
Provides quick access to the document count of the entire cluster, or individual
indices.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -388,7 +388,7 @@ async def fielddata(
Shows how much heap memory is currently being used by fielddata on every data
node in the cluster.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -469,7 +469,7 @@ async def health(
"""
Returns a concise representation of the cluster health.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -544,7 +544,7 @@ async def 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.11/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 @@ -642,7 +642,7 @@ async def indices(
Returns information about indices: number of primaries and replicas, document
counts, disk size, ...
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -737,7 +737,7 @@ async def master(
"""
Returns information about the master node.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -856,7 +856,7 @@ async def ml_data_frame_analytics(
"""
Gets configuration and usage information about data frame analytics jobs.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -987,7 +987,7 @@ async def ml_datafeeds(
"""
Gets configuration and usage information about datafeeds.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/cat-datafeeds.html>`_
:param datafeed_id: A numerical character string that uniquely identifies the
datafeed.
Expand Down Expand Up @@ -1124,7 +1124,7 @@ async def ml_jobs(
"""
Gets configuration and usage information about anomaly detection jobs.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1264,7 +1264,7 @@ async def ml_trained_models(
"""
Gets configuration and usage information about inference trained models.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1354,7 +1354,7 @@ async def nodeattrs(
"""
Returns information about custom node attributes.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1428,7 +1428,7 @@ async def nodes(
"""
Returns basic statistics about performance of cluster nodes.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1508,7 +1508,7 @@ async def pending_tasks(
"""
Returns a concise representation of the cluster pending tasks.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1577,7 +1577,7 @@ async def plugins(
"""
Returns information about installed plugins across nodes node.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1652,7 +1652,7 @@ async def recovery(
"""
Returns information about index shard recoveries, both on-going completed.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1737,7 +1737,7 @@ async def repositories(
"""
Returns information about snapshot repositories registered in the cluster.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1810,7 +1810,7 @@ async def segments(
"""
Provides low-level information about the segments in the shards of an index.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1892,7 +1892,7 @@ async def shards(
"""
Provides a detailed view of shard allocation on nodes.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -1974,7 +1974,7 @@ async def snapshots(
"""
Returns all snapshots in a specific repository.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -2058,7 +2058,7 @@ async def tasks(
Returns information about the tasks currently executing on one or more nodes
in the cluster.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -2142,7 +2142,7 @@ async def templates(
"""
Returns information about existing templates.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -2223,7 +2223,7 @@ async def thread_pool(
Returns cluster-wide thread pool statistics per node. By default the active,
queue and rejected statistics are returned for all thread pools.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 @@ -2353,7 +2353,7 @@ async def transforms(
"""
Gets configuration and usage information about transforms.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/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 1b47535

Please sign in to comment.