Skip to content

Commit

Permalink
update api to 8.4
Browse files Browse the repository at this point in the history
  • Loading branch information
@miriam-eid
miriam-eid committed Aug 2, 2022
1 parent 227c71f commit 54cd023
Show file tree
Hide file tree
Showing 66 changed files with 808 additions and 802 deletions.
84 changes: 42 additions & 42 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.4/async-search.html>`_
:param id: The async search ID
"""
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.4/async-search.html>`_
:param id: The async search ID
:param keep_alive: Specify the time interval in which the results (partial or
Expand Down Expand Up @@ -131,7 +131,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.4/async-search.html>`_
:param id: The async search ID
"""
Expand Down Expand Up @@ -304,7 +304,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.4/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.4/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.4/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.4/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.4/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.4/cat-alias.html>`_
:param name: A comma-separated list of alias names to return
:param expand_wildcards: Whether to expand wildcard expression to concrete indices
Expand Down Expand Up @@ -151,7 +151,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.4/cat-allocation.html>`_
:param node_id: A comma-separated list of node IDs or names to limit the returned
information
Expand Down Expand Up @@ -229,7 +229,7 @@ async def component_templates(
"""
Returns information about existing component_templates templates.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-compoentn-templates.html>`_
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.4/cat-compoentn-templates.html>`_
:param name: A pattern that returned component template names must match
:param format: Specifies the format to return the columnar data in, can be set
Expand Down Expand Up @@ -304,7 +304,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.4/cat-count.html>`_
:param index: A comma-separated list of index names to limit the returned information
:param format: Specifies the format to return the columnar data in, can be set
Expand Down Expand Up @@ -384,7 +384,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.4/cat-fielddata.html>`_
:param fields: A comma-separated list of fields to return the fielddata size
:param bytes: The unit in which to display byte values
Expand Down Expand Up @@ -461,7 +461,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.4/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 @@ -533,7 +533,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.4/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 @@ -628,7 +628,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.4/cat-indices.html>`_
:param index: A comma-separated list of index names to limit the returned information
:param bytes: The unit in which to display byte values
Expand Down Expand Up @@ -719,7 +719,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.4/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 @@ -838,7 +838,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.4/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 @@ -969,7 +969,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.4/cat-datafeeds.html>`_
:param datafeed_id: A numerical character string that uniquely identifies the
datafeed.
Expand Down Expand Up @@ -1106,7 +1106,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.4/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 @@ -1246,7 +1246,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.4/cat-trained-model.html>`_
:param model_id: The ID of the trained models stats to fetch
:param allow_no_match: Whether to ignore if a wildcard expression matches no
Expand Down Expand Up @@ -1331,7 +1331,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.4/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 @@ -1404,7 +1404,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.4/cat-nodes.html>`_
:param bytes: The unit in which to display byte values
:param format: Specifies the format to return the columnar data in, can be set
Expand Down Expand Up @@ -1480,7 +1480,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.4/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 @@ -1549,7 +1549,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.4/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 @@ -1624,7 +1624,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.4/cat-recovery.html>`_
:param index: Comma-separated list or wildcard expression of index names to limit
the returned information
Expand Down Expand Up @@ -1708,7 +1708,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.4/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 @@ -1781,7 +1781,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.4/cat-segments.html>`_
:param index: A comma-separated list of index names to limit the returned information
:param bytes: The unit in which to display byte values
Expand Down Expand Up @@ -1861,7 +1861,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.4/cat-shards.html>`_
:param index: A comma-separated list of index names to limit the returned information
:param bytes: The unit in which to display byte values
Expand Down Expand Up @@ -1941,7 +1941,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.4/cat-snapshots.html>`_
:param repository: Name of repository from which to fetch the snapshot information
:param format: Specifies the format to return the columnar data in, can be set
Expand Down Expand Up @@ -2022,7 +2022,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.4/tasks.html>`_
:param actions: A comma-separated list of actions that should be returned. Leave
empty to return all.
Expand Down Expand Up @@ -2105,7 +2105,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.4/cat-templates.html>`_
:param name: A pattern that returned template names must match
:param format: Specifies the format to return the columnar data in, can be set
Expand Down Expand Up @@ -2185,7 +2185,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.4/cat-thread-pool.html>`_
:param thread_pool_patterns: List of thread pool names used to limit the request.
Accepts wildcard expressions.
Expand Down Expand Up @@ -2315,7 +2315,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.4/cat-transforms.html>`_
:param transform_id: The id of the transform for which to get stats. '_all' or
'*' implies all transforms
Expand Down
Loading

0 comments on commit 54cd023

Please sign in to comment.