|
24 | 24 |
|
25 | 25 |
|
26 | 26 | class CatClient(NamespacedClient):
|
| 27 | + |
27 | 28 | @_rewrite_parameters()
|
28 | 29 | async def aliases(
|
29 | 30 | self,
|
@@ -55,7 +56,7 @@ async def aliases(
|
55 | 56 | Shows information about currently configured aliases to indices including filter
|
56 | 57 | and routing infos.
|
57 | 58 |
|
58 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_ |
| 59 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-alias.html>`_ |
59 | 60 |
|
60 | 61 | :param name: A comma-separated list of aliases to retrieve. Supports wildcards
|
61 | 62 | (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
|
@@ -136,7 +137,7 @@ async def allocation(
|
136 | 137 | Provides a snapshot of how many shards are allocated to each data node and how
|
137 | 138 | much disk space they are using.
|
138 | 139 |
|
139 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html>`_ |
| 140 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-allocation.html>`_ |
140 | 141 |
|
141 | 142 | :param node_id: Comma-separated list of node identifiers or names used to limit
|
142 | 143 | the returned information.
|
@@ -212,7 +213,7 @@ async def component_templates(
|
212 | 213 | """
|
213 | 214 | Returns information about existing component_templates templates.
|
214 | 215 |
|
215 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_ |
| 216 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-component-templates.html>`_ |
216 | 217 |
|
217 | 218 | :param name: The name of the component template. Accepts wildcard expressions.
|
218 | 219 | If omitted, all component templates are returned.
|
@@ -286,7 +287,7 @@ async def count(
|
286 | 287 | Provides quick access to the document count of the entire cluster, or individual
|
287 | 288 | indices.
|
288 | 289 |
|
289 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_ |
| 290 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-count.html>`_ |
290 | 291 |
|
291 | 292 | :param index: Comma-separated list of data streams, indices, and aliases used
|
292 | 293 | to limit the request. Supports wildcards (`*`). To target all data streams
|
@@ -364,7 +365,7 @@ async def fielddata(
|
364 | 365 | Shows how much heap memory is currently being used by fielddata on every data
|
365 | 366 | node in the cluster.
|
366 | 367 |
|
367 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html>`_ |
| 368 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-fielddata.html>`_ |
368 | 369 |
|
369 | 370 | :param fields: Comma-separated list of fields used to limit returned information.
|
370 | 371 | To retrieve all fields, omit this parameter.
|
@@ -443,7 +444,7 @@ async def health(
|
443 | 444 | """
|
444 | 445 | Returns a concise representation of the cluster health.
|
445 | 446 |
|
446 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html>`_ |
| 447 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-health.html>`_ |
447 | 448 |
|
448 | 449 | :param format: Specifies the format to return the columnar data in, can be set
|
449 | 450 | to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
@@ -516,7 +517,7 @@ async def help(
|
516 | 517 | """
|
517 | 518 | Returns help for the Cat APIs.
|
518 | 519 |
|
519 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_ |
| 520 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat.html>`_ |
520 | 521 |
|
521 | 522 | :param format: Specifies the format to return the columnar data in, can be set
|
522 | 523 | to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
@@ -602,7 +603,7 @@ async def indices(
|
602 | 603 | Returns information about indices: number of primaries and replicas, document
|
603 | 604 | counts, disk size, ...
|
604 | 605 |
|
605 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_ |
| 606 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-indices.html>`_ |
606 | 607 |
|
607 | 608 | :param index: Comma-separated list of data streams, indices, and aliases used
|
608 | 609 | to limit the request. Supports wildcards (`*`). To target all data streams
|
@@ -695,7 +696,7 @@ async def master(
|
695 | 696 | """
|
696 | 697 | Returns information about the master node.
|
697 | 698 |
|
698 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html>`_ |
| 699 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-master.html>`_ |
699 | 700 |
|
700 | 701 | :param format: Specifies the format to return the columnar data in, can be set
|
701 | 702 | to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
@@ -794,7 +795,7 @@ async def ml_data_frame_analytics(
|
794 | 795 | """
|
795 | 796 | Gets configuration and usage information about data frame analytics jobs.
|
796 | 797 |
|
797 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_ |
| 798 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-dfanalytics.html>`_ |
798 | 799 |
|
799 | 800 | :param id: The ID of the data frame analytics to fetch
|
800 | 801 | :param allow_no_match: Whether to ignore if a wildcard expression matches no
|
@@ -905,7 +906,7 @@ async def ml_datafeeds(
|
905 | 906 | """
|
906 | 907 | Gets configuration and usage information about datafeeds.
|
907 | 908 |
|
908 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_ |
| 909 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-datafeeds.html>`_ |
909 | 910 |
|
910 | 911 | :param datafeed_id: A numerical character string that uniquely identifies the
|
911 | 912 | datafeed.
|
@@ -1022,7 +1023,7 @@ async def ml_jobs(
|
1022 | 1023 | """
|
1023 | 1024 | Gets configuration and usage information about anomaly detection jobs.
|
1024 | 1025 |
|
1025 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_ |
| 1026 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-anomaly-detectors.html>`_ |
1026 | 1027 |
|
1027 | 1028 | :param job_id: Identifier for the anomaly detection job.
|
1028 | 1029 | :param allow_no_match: Specifies what to do when the request: * Contains wildcard
|
@@ -1142,7 +1143,7 @@ async def ml_trained_models(
|
1142 | 1143 | """
|
1143 | 1144 | Gets configuration and usage information about inference trained models.
|
1144 | 1145 |
|
1145 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_ |
| 1146 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-trained-model.html>`_ |
1146 | 1147 |
|
1147 | 1148 | :param model_id: A unique identifier for the trained model.
|
1148 | 1149 | :param allow_no_match: Specifies what to do when the request: contains wildcard
|
@@ -1230,7 +1231,7 @@ async def nodeattrs(
|
1230 | 1231 | """
|
1231 | 1232 | Returns information about custom node attributes.
|
1232 | 1233 |
|
1233 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html>`_ |
| 1234 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-nodeattrs.html>`_ |
1234 | 1235 |
|
1235 | 1236 | :param format: Specifies the format to return the columnar data in, can be set
|
1236 | 1237 | to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
@@ -1302,7 +1303,7 @@ async def nodes(
|
1302 | 1303 | """
|
1303 | 1304 | Returns basic statistics about performance of cluster nodes.
|
1304 | 1305 |
|
1305 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html>`_ |
| 1306 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-nodes.html>`_ |
1306 | 1307 |
|
1307 | 1308 | :param bytes: The unit used to display byte values.
|
1308 | 1309 | :param format: Specifies the format to return the columnar data in, can be set
|
@@ -1380,7 +1381,7 @@ async def pending_tasks(
|
1380 | 1381 | """
|
1381 | 1382 | Returns a concise representation of the cluster pending tasks.
|
1382 | 1383 |
|
1383 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html>`_ |
| 1384 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-pending-tasks.html>`_ |
1384 | 1385 |
|
1385 | 1386 | :param format: Specifies the format to return the columnar data in, can be set
|
1386 | 1387 | to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
@@ -1447,7 +1448,7 @@ async def plugins(
|
1447 | 1448 | """
|
1448 | 1449 | Returns information about installed plugins across nodes node.
|
1449 | 1450 |
|
1450 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html>`_ |
| 1451 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-plugins.html>`_ |
1451 | 1452 |
|
1452 | 1453 | :param format: Specifies the format to return the columnar data in, can be set
|
1453 | 1454 | to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
@@ -1520,7 +1521,7 @@ async def recovery(
|
1520 | 1521 | """
|
1521 | 1522 | Returns information about index shard recoveries, both on-going completed.
|
1522 | 1523 |
|
1523 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html>`_ |
| 1524 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-recovery.html>`_ |
1524 | 1525 |
|
1525 | 1526 | :param index: A comma-separated list of data streams, indices, and aliases used
|
1526 | 1527 | to limit the request. Supports wildcards (`*`). To target all data streams
|
@@ -1603,7 +1604,7 @@ async def repositories(
|
1603 | 1604 | """
|
1604 | 1605 | Returns information about snapshot repositories registered in the cluster.
|
1605 | 1606 |
|
1606 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html>`_ |
| 1607 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-repositories.html>`_ |
1607 | 1608 |
|
1608 | 1609 | :param format: Specifies the format to return the columnar data in, can be set
|
1609 | 1610 | to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
@@ -1674,7 +1675,7 @@ async def segments(
|
1674 | 1675 | """
|
1675 | 1676 | Provides low-level information about the segments in the shards of an index.
|
1676 | 1677 |
|
1677 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html>`_ |
| 1678 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-segments.html>`_ |
1678 | 1679 |
|
1679 | 1680 | :param index: A comma-separated list of data streams, indices, and aliases used
|
1680 | 1681 | to limit the request. Supports wildcards (`*`). To target all data streams
|
@@ -1754,7 +1755,7 @@ async def shards(
|
1754 | 1755 | """
|
1755 | 1756 | Provides a detailed view of shard allocation on nodes.
|
1756 | 1757 |
|
1757 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html>`_ |
| 1758 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-shards.html>`_ |
1758 | 1759 |
|
1759 | 1760 | :param index: A comma-separated list of data streams, indices, and aliases used
|
1760 | 1761 | to limit the request. Supports wildcards (`*`). To target all data streams
|
@@ -1832,7 +1833,7 @@ async def snapshots(
|
1832 | 1833 | """
|
1833 | 1834 | Returns all snapshots in a specific repository.
|
1834 | 1835 |
|
1835 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html>`_ |
| 1836 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-snapshots.html>`_ |
1836 | 1837 |
|
1837 | 1838 | :param repository: A comma-separated list of snapshot repositories used to limit
|
1838 | 1839 | the request. Accepts wildcard expressions. `_all` returns all repositories.
|
@@ -1914,7 +1915,7 @@ async def tasks(
|
1914 | 1915 | Returns information about the tasks currently executing on one or more nodes
|
1915 | 1916 | in the cluster.
|
1916 | 1917 |
|
1917 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html>`_ |
| 1918 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/tasks.html>`_ |
1918 | 1919 |
|
1919 | 1920 | :param actions: The task action names, which are used to limit the response.
|
1920 | 1921 | :param detailed: If `true`, the response includes detailed information about
|
@@ -1996,7 +1997,7 @@ async def templates(
|
1996 | 1997 | """
|
1997 | 1998 | Returns information about existing templates.
|
1998 | 1999 |
|
1999 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html>`_ |
| 2000 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-templates.html>`_ |
2000 | 2001 |
|
2001 | 2002 | :param name: The name of the template to return. Accepts wildcard expressions.
|
2002 | 2003 | If omitted, all templates are returned.
|
@@ -2073,7 +2074,7 @@ async def thread_pool(
|
2073 | 2074 | Returns cluster-wide thread pool statistics per node. By default the active,
|
2074 | 2075 | queue and rejected statistics are returned for all thread pools.
|
2075 | 2076 |
|
2076 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html>`_ |
| 2077 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-thread-pool.html>`_ |
2077 | 2078 |
|
2078 | 2079 | :param thread_pool_patterns: A comma-separated list of thread pool names used
|
2079 | 2080 | to limit the request. Accepts wildcard expressions.
|
@@ -2183,7 +2184,7 @@ async def transforms(
|
2183 | 2184 | """
|
2184 | 2185 | Gets configuration and usage information about transforms.
|
2185 | 2186 |
|
2186 |
| - `<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_ |
| 2187 | + `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-transforms.html>`_ |
2187 | 2188 |
|
2188 | 2189 | :param transform_id: A transform identifier or a wildcard expression. If you
|
2189 | 2190 | do not specify one of these options, the API returns information for all
|
|
0 commit comments