elasticsearch 8.13.2__py3-none-any.whl → 8.15.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. elasticsearch/_async/client/__init__.py +204 -169
  2. elasticsearch/_async/client/async_search.py +35 -20
  3. elasticsearch/_async/client/autoscaling.py +4 -4
  4. elasticsearch/_async/client/cat.py +785 -180
  5. elasticsearch/_async/client/ccr.py +20 -32
  6. elasticsearch/_async/client/cluster.py +94 -88
  7. elasticsearch/_async/client/connector.py +1470 -0
  8. elasticsearch/_async/client/dangling_indices.py +7 -11
  9. elasticsearch/_async/client/enrich.py +8 -8
  10. elasticsearch/_async/client/eql.py +17 -16
  11. elasticsearch/_async/client/esql.py +2 -2
  12. elasticsearch/_async/client/features.py +2 -2
  13. elasticsearch/_async/client/fleet.py +18 -17
  14. elasticsearch/_async/client/graph.py +4 -4
  15. elasticsearch/_async/client/ilm.py +36 -44
  16. elasticsearch/_async/client/indices.py +401 -411
  17. elasticsearch/_async/client/inference.py +65 -39
  18. elasticsearch/_async/client/ingest.py +22 -23
  19. elasticsearch/_async/client/license.py +18 -10
  20. elasticsearch/_async/client/logstash.py +6 -6
  21. elasticsearch/_async/client/migration.py +3 -3
  22. elasticsearch/_async/client/ml.py +383 -176
  23. elasticsearch/_async/client/monitoring.py +2 -2
  24. elasticsearch/_async/client/nodes.py +32 -32
  25. elasticsearch/_async/client/query_rules.py +384 -0
  26. elasticsearch/_async/client/rollup.py +13 -13
  27. elasticsearch/_async/client/search_application.py +15 -10
  28. elasticsearch/_async/client/searchable_snapshots.py +9 -13
  29. elasticsearch/_async/client/security.py +587 -104
  30. elasticsearch/_async/client/shutdown.py +7 -7
  31. elasticsearch/_async/client/slm.py +11 -13
  32. elasticsearch/_async/client/snapshot.py +39 -52
  33. elasticsearch/_async/client/sql.py +12 -14
  34. elasticsearch/_async/client/ssl.py +1 -1
  35. elasticsearch/_async/client/synonyms.py +8 -8
  36. elasticsearch/_async/client/tasks.py +9 -10
  37. elasticsearch/_async/client/text_structure.py +3 -3
  38. elasticsearch/_async/client/transform.py +89 -34
  39. elasticsearch/_async/client/watcher.py +30 -15
  40. elasticsearch/_async/client/xpack.py +6 -7
  41. elasticsearch/_otel.py +2 -6
  42. elasticsearch/_sync/client/__init__.py +204 -169
  43. elasticsearch/_sync/client/async_search.py +35 -20
  44. elasticsearch/_sync/client/autoscaling.py +4 -4
  45. elasticsearch/_sync/client/cat.py +785 -180
  46. elasticsearch/_sync/client/ccr.py +20 -32
  47. elasticsearch/_sync/client/cluster.py +94 -88
  48. elasticsearch/_sync/client/connector.py +1470 -0
  49. elasticsearch/_sync/client/dangling_indices.py +7 -11
  50. elasticsearch/_sync/client/enrich.py +8 -8
  51. elasticsearch/_sync/client/eql.py +17 -16
  52. elasticsearch/_sync/client/esql.py +2 -2
  53. elasticsearch/_sync/client/features.py +2 -2
  54. elasticsearch/_sync/client/fleet.py +18 -17
  55. elasticsearch/_sync/client/graph.py +4 -4
  56. elasticsearch/_sync/client/ilm.py +36 -44
  57. elasticsearch/_sync/client/indices.py +401 -411
  58. elasticsearch/_sync/client/inference.py +65 -39
  59. elasticsearch/_sync/client/ingest.py +22 -23
  60. elasticsearch/_sync/client/license.py +18 -10
  61. elasticsearch/_sync/client/logstash.py +6 -6
  62. elasticsearch/_sync/client/migration.py +3 -3
  63. elasticsearch/_sync/client/ml.py +383 -176
  64. elasticsearch/_sync/client/monitoring.py +2 -2
  65. elasticsearch/_sync/client/nodes.py +32 -32
  66. elasticsearch/_sync/client/query_rules.py +384 -0
  67. elasticsearch/_sync/client/rollup.py +13 -13
  68. elasticsearch/_sync/client/search_application.py +15 -10
  69. elasticsearch/_sync/client/searchable_snapshots.py +9 -13
  70. elasticsearch/_sync/client/security.py +587 -104
  71. elasticsearch/_sync/client/shutdown.py +7 -7
  72. elasticsearch/_sync/client/slm.py +11 -13
  73. elasticsearch/_sync/client/snapshot.py +39 -52
  74. elasticsearch/_sync/client/sql.py +12 -14
  75. elasticsearch/_sync/client/ssl.py +1 -1
  76. elasticsearch/_sync/client/synonyms.py +8 -8
  77. elasticsearch/_sync/client/tasks.py +9 -10
  78. elasticsearch/_sync/client/text_structure.py +3 -3
  79. elasticsearch/_sync/client/transform.py +89 -34
  80. elasticsearch/_sync/client/watcher.py +30 -15
  81. elasticsearch/_sync/client/xpack.py +6 -7
  82. elasticsearch/_version.py +1 -1
  83. elasticsearch/client.py +3 -3
  84. elasticsearch/helpers/vectorstore/_async/vectorstore.py +36 -6
  85. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +36 -6
  86. elasticsearch/serializer.py +34 -1
  87. elasticsearch-8.15.0.dist-info/METADATA +177 -0
  88. elasticsearch-8.15.0.dist-info/RECORD +117 -0
  89. {elasticsearch-8.13.2.dist-info → elasticsearch-8.15.0.dist-info}/WHEEL +1 -2
  90. elasticsearch/_async/client/query_ruleset.py +0 -205
  91. elasticsearch/_sync/client/query_ruleset.py +0 -205
  92. elasticsearch-8.13.2.dist-info/METADATA +0 -147
  93. elasticsearch-8.13.2.dist-info/RECORD +0 -116
  94. elasticsearch-8.13.2.dist-info/top_level.txt +0 -1
  95. {elasticsearch-8.13.2.dist-info → elasticsearch-8.15.0.dist-info/licenses}/LICENSE +0 -0
  96. {elasticsearch-8.13.2.dist-info → elasticsearch-8.15.0.dist-info/licenses}/NOTICE +0 -0
@@ -34,9 +34,9 @@ class CatClient(NamespacedClient):
34
34
  expand_wildcards: t.Optional[
35
35
  t.Union[
36
36
  t.Sequence[
37
- t.Union["t.Literal['all', 'closed', 'hidden', 'none', 'open']", str]
37
+ t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
38
38
  ],
39
- t.Union["t.Literal['all', 'closed', 'hidden', 'none', 'open']", str],
39
+ t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
40
40
  ]
41
41
  ] = None,
42
42
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -45,18 +45,19 @@ class CatClient(NamespacedClient):
45
45
  help: t.Optional[bool] = None,
46
46
  human: t.Optional[bool] = None,
47
47
  local: t.Optional[bool] = None,
48
- master_timeout: t.Optional[
49
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
50
- ] = None,
48
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
51
49
  pretty: t.Optional[bool] = None,
52
50
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
53
51
  v: t.Optional[bool] = None,
54
52
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
55
53
  """
56
- Shows information about currently configured aliases to indices including filter
57
- and routing infos.
54
+ Retrieves the cluster’s index aliases, including filter and routing information.
55
+ The API does not return data stream aliases. IMPORTANT: cat APIs are only intended
56
+ for human consumption using the command line or the Kibana console. They are
57
+ not intended for use by applications. For application consumption, use the aliases
58
+ API.
58
59
 
59
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-alias.html>`_
60
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-alias.html>`_
60
61
 
61
62
  :param name: A comma-separated list of aliases to retrieve. Supports wildcards
62
63
  (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -125,7 +126,7 @@ class CatClient(NamespacedClient):
125
126
  *,
126
127
  node_id: t.Optional[t.Union[str, t.Sequence[str]]] = None,
127
128
  bytes: t.Optional[
128
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
129
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
129
130
  ] = None,
130
131
  error_trace: t.Optional[bool] = None,
131
132
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -134,18 +135,17 @@ class CatClient(NamespacedClient):
134
135
  help: t.Optional[bool] = None,
135
136
  human: t.Optional[bool] = None,
136
137
  local: t.Optional[bool] = None,
137
- master_timeout: t.Optional[
138
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
139
- ] = None,
138
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
140
139
  pretty: t.Optional[bool] = None,
141
140
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
142
141
  v: t.Optional[bool] = None,
143
142
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
144
143
  """
145
- Provides a snapshot of how many shards are allocated to each data node and how
146
- much disk space they are using.
144
+ Provides a snapshot of the number of shards allocated to each data node and their
145
+ disk space. IMPORTANT: cat APIs are only intended for human consumption using
146
+ the command line or Kibana console. They are not intended for use by applications.
147
147
 
148
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-allocation.html>`_
148
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-allocation.html>`_
149
149
 
150
150
  :param node_id: Comma-separated list of node identifiers or names used to limit
151
151
  the returned information.
@@ -219,17 +219,19 @@ class CatClient(NamespacedClient):
219
219
  help: t.Optional[bool] = None,
220
220
  human: t.Optional[bool] = None,
221
221
  local: t.Optional[bool] = None,
222
- master_timeout: t.Optional[
223
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
224
- ] = None,
222
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
225
223
  pretty: t.Optional[bool] = None,
226
224
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
227
225
  v: t.Optional[bool] = None,
228
226
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
229
227
  """
230
- Returns information about existing component_templates templates.
228
+ Returns information about component templates in a cluster. Component templates
229
+ are building blocks for constructing index templates that specify index mappings,
230
+ settings, and aliases. IMPORTANT: cat APIs are only intended for human consumption
231
+ using the command line or Kibana console. They are not intended for use by applications.
232
+ For application consumption, use the get component template API.
231
233
 
232
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-component-templates.html>`_
234
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-component-templates.html>`_
233
235
 
234
236
  :param name: The name of the component template. Accepts wildcard expressions.
235
237
  If omitted, all component templates are returned.
@@ -300,18 +302,20 @@ class CatClient(NamespacedClient):
300
302
  help: t.Optional[bool] = None,
301
303
  human: t.Optional[bool] = None,
302
304
  local: t.Optional[bool] = None,
303
- master_timeout: t.Optional[
304
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
305
- ] = None,
305
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
306
306
  pretty: t.Optional[bool] = None,
307
307
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
308
308
  v: t.Optional[bool] = None,
309
309
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
310
310
  """
311
- Provides quick access to the document count of the entire cluster, or individual
312
- indices.
311
+ Provides quick access to a document count for a data stream, an index, or an
312
+ entire cluster. NOTE: The document count only includes live documents, not deleted
313
+ documents which have not yet been removed by the merge process. IMPORTANT: cat
314
+ APIs are only intended for human consumption using the command line or Kibana
315
+ console. They are not intended for use by applications. For application consumption,
316
+ use the count API.
313
317
 
314
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-count.html>`_
318
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-count.html>`_
315
319
 
316
320
  :param index: Comma-separated list of data streams, indices, and aliases used
317
321
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -377,7 +381,7 @@ class CatClient(NamespacedClient):
377
381
  *,
378
382
  fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
379
383
  bytes: t.Optional[
380
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
384
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
381
385
  ] = None,
382
386
  error_trace: t.Optional[bool] = None,
383
387
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -386,18 +390,18 @@ class CatClient(NamespacedClient):
386
390
  help: t.Optional[bool] = None,
387
391
  human: t.Optional[bool] = None,
388
392
  local: t.Optional[bool] = None,
389
- master_timeout: t.Optional[
390
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
391
- ] = None,
393
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
392
394
  pretty: t.Optional[bool] = None,
393
395
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
394
396
  v: t.Optional[bool] = None,
395
397
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
396
398
  """
397
- Shows how much heap memory is currently being used by fielddata on every data
398
- node in the cluster.
399
+ Returns the amount of heap memory currently used by the field data cache on every
400
+ data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption
401
+ using the command line or Kibana console. They are not intended for use by applications.
402
+ For application consumption, use the nodes stats API.
399
403
 
400
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-fielddata.html>`_
404
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-fielddata.html>`_
401
405
 
402
406
  :param fields: Comma-separated list of fields used to limit returned information.
403
407
  To retrieve all fields, omit this parameter.
@@ -470,21 +474,29 @@ class CatClient(NamespacedClient):
470
474
  help: t.Optional[bool] = None,
471
475
  human: t.Optional[bool] = None,
472
476
  local: t.Optional[bool] = None,
473
- master_timeout: t.Optional[
474
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
475
- ] = None,
477
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
476
478
  pretty: t.Optional[bool] = None,
477
479
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
478
480
  time: t.Optional[
479
- t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
481
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
480
482
  ] = None,
481
483
  ts: t.Optional[bool] = None,
482
484
  v: t.Optional[bool] = None,
483
485
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
484
486
  """
485
- Returns a concise representation of the cluster health.
486
-
487
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-health.html>`_
487
+ Returns the health status of a cluster, similar to the cluster health API. IMPORTANT:
488
+ cat APIs are only intended for human consumption using the command line or Kibana
489
+ console. They are not intended for use by applications. For application consumption,
490
+ use the cluster health API. This API is often used to check malfunctioning clusters.
491
+ To help you track cluster health alongside log files and alerting systems, the
492
+ API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but
493
+ includes no date information; `Unix epoch time`, which is machine-sortable and
494
+ includes date information. The latter format is useful for cluster recoveries
495
+ that take multiple days. You can use the cat health API to verify cluster health
496
+ across multiple nodes. You also can use the API to track the recovery of a large
497
+ cluster over a longer period of time.
498
+
499
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-health.html>`_
488
500
 
489
501
  :param format: Specifies the format to return the columnar data in, can be set
490
502
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -553,9 +565,7 @@ class CatClient(NamespacedClient):
553
565
  help: t.Optional[bool] = None,
554
566
  human: t.Optional[bool] = None,
555
567
  local: t.Optional[bool] = None,
556
- master_timeout: t.Optional[
557
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
558
- ] = None,
568
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
559
569
  pretty: t.Optional[bool] = None,
560
570
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
561
571
  v: t.Optional[bool] = None,
@@ -563,7 +573,7 @@ class CatClient(NamespacedClient):
563
573
  """
564
574
  Returns help for the Cat APIs.
565
575
 
566
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat.html>`_
576
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat.html>`_
567
577
 
568
578
  :param format: Specifies the format to return the columnar data in, can be set
569
579
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -621,41 +631,47 @@ class CatClient(NamespacedClient):
621
631
  *,
622
632
  index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
623
633
  bytes: t.Optional[
624
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
634
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
625
635
  ] = None,
626
636
  error_trace: t.Optional[bool] = None,
627
637
  expand_wildcards: t.Optional[
628
638
  t.Union[
629
639
  t.Sequence[
630
- t.Union["t.Literal['all', 'closed', 'hidden', 'none', 'open']", str]
640
+ t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
631
641
  ],
632
- t.Union["t.Literal['all', 'closed', 'hidden', 'none', 'open']", str],
642
+ t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
633
643
  ]
634
644
  ] = None,
635
645
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
636
646
  format: t.Optional[str] = None,
637
647
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
638
- health: t.Optional[t.Union["t.Literal['green', 'red', 'yellow']", str]] = None,
648
+ health: t.Optional[t.Union[str, t.Literal["green", "red", "yellow"]]] = None,
639
649
  help: t.Optional[bool] = None,
640
650
  human: t.Optional[bool] = None,
641
651
  include_unloaded_segments: t.Optional[bool] = None,
642
652
  local: t.Optional[bool] = None,
643
- master_timeout: t.Optional[
644
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
645
- ] = None,
653
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
646
654
  pretty: t.Optional[bool] = None,
647
655
  pri: t.Optional[bool] = None,
648
656
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
649
657
  time: t.Optional[
650
- t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
658
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
651
659
  ] = None,
652
660
  v: t.Optional[bool] = None,
653
661
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
654
662
  """
655
- Returns information about indices: number of primaries and replicas, document
656
- counts, disk size, ...
657
-
658
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-indices.html>`_
663
+ Returns high-level information about indices in a cluster, including backing
664
+ indices for data streams. IMPORTANT: cat APIs are only intended for human consumption
665
+ using the command line or Kibana console. They are not intended for use by applications.
666
+ For application consumption, use the get index API. Use the cat indices API to
667
+ get the following information for each index in a cluster: shard count; document
668
+ count; deleted document count; primary store size; total store size of all shards,
669
+ including shard replicas. These metrics are retrieved directly from Lucene, which
670
+ Elasticsearch uses internally to power indexing and search. As a result, all
671
+ document counts include hidden nested documents. To get an accurate count of
672
+ Elasticsearch documents, use the cat count or count APIs.
673
+
674
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-indices.html>`_
659
675
 
660
676
  :param index: Comma-separated list of data streams, indices, and aliases used
661
677
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -746,17 +762,18 @@ class CatClient(NamespacedClient):
746
762
  help: t.Optional[bool] = None,
747
763
  human: t.Optional[bool] = None,
748
764
  local: t.Optional[bool] = None,
749
- master_timeout: t.Optional[
750
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
751
- ] = None,
765
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
752
766
  pretty: t.Optional[bool] = None,
753
767
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
754
768
  v: t.Optional[bool] = None,
755
769
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
756
770
  """
757
- Returns information about the master node.
771
+ Returns information about the master node, including the ID, bound IP address,
772
+ and name. IMPORTANT: cat APIs are only intended for human consumption using the
773
+ command line or Kibana console. They are not intended for use by applications.
774
+ For application consumption, use the nodes info API.
758
775
 
759
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-master.html>`_
776
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-master.html>`_
760
777
 
761
778
  :param format: Specifies the format to return the columnar data in, can be set
762
779
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -815,7 +832,7 @@ class CatClient(NamespacedClient):
815
832
  id: t.Optional[str] = None,
816
833
  allow_no_match: t.Optional[bool] = None,
817
834
  bytes: t.Optional[
818
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
835
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
819
836
  ] = None,
820
837
  error_trace: t.Optional[bool] = None,
821
838
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -824,44 +841,113 @@ class CatClient(NamespacedClient):
824
841
  t.Union[
825
842
  t.Sequence[
826
843
  t.Union[
827
- "t.Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version']",
828
844
  str,
845
+ t.Literal[
846
+ "assignment_explanation",
847
+ "create_time",
848
+ "description",
849
+ "dest_index",
850
+ "failure_reason",
851
+ "id",
852
+ "model_memory_limit",
853
+ "node.address",
854
+ "node.ephemeral_id",
855
+ "node.id",
856
+ "node.name",
857
+ "progress",
858
+ "source_index",
859
+ "state",
860
+ "type",
861
+ "version",
862
+ ],
829
863
  ]
830
864
  ],
831
865
  t.Union[
832
- "t.Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version']",
833
866
  str,
867
+ t.Literal[
868
+ "assignment_explanation",
869
+ "create_time",
870
+ "description",
871
+ "dest_index",
872
+ "failure_reason",
873
+ "id",
874
+ "model_memory_limit",
875
+ "node.address",
876
+ "node.ephemeral_id",
877
+ "node.id",
878
+ "node.name",
879
+ "progress",
880
+ "source_index",
881
+ "state",
882
+ "type",
883
+ "version",
884
+ ],
834
885
  ],
835
886
  ]
836
887
  ] = None,
837
888
  help: t.Optional[bool] = None,
838
889
  human: t.Optional[bool] = None,
839
890
  local: t.Optional[bool] = None,
840
- master_timeout: t.Optional[
841
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
842
- ] = None,
891
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
843
892
  pretty: t.Optional[bool] = None,
844
893
  s: t.Optional[
845
894
  t.Union[
846
895
  t.Sequence[
847
896
  t.Union[
848
- "t.Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version']",
849
897
  str,
898
+ t.Literal[
899
+ "assignment_explanation",
900
+ "create_time",
901
+ "description",
902
+ "dest_index",
903
+ "failure_reason",
904
+ "id",
905
+ "model_memory_limit",
906
+ "node.address",
907
+ "node.ephemeral_id",
908
+ "node.id",
909
+ "node.name",
910
+ "progress",
911
+ "source_index",
912
+ "state",
913
+ "type",
914
+ "version",
915
+ ],
850
916
  ]
851
917
  ],
852
918
  t.Union[
853
- "t.Literal['assignment_explanation', 'create_time', 'description', 'dest_index', 'failure_reason', 'id', 'model_memory_limit', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'progress', 'source_index', 'state', 'type', 'version']",
854
919
  str,
920
+ t.Literal[
921
+ "assignment_explanation",
922
+ "create_time",
923
+ "description",
924
+ "dest_index",
925
+ "failure_reason",
926
+ "id",
927
+ "model_memory_limit",
928
+ "node.address",
929
+ "node.ephemeral_id",
930
+ "node.id",
931
+ "node.name",
932
+ "progress",
933
+ "source_index",
934
+ "state",
935
+ "type",
936
+ "version",
937
+ ],
855
938
  ],
856
939
  ]
857
940
  ] = None,
858
- time: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
941
+ time: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
859
942
  v: t.Optional[bool] = None,
860
943
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
861
944
  """
862
- Gets configuration and usage information about data frame analytics jobs.
945
+ Returns configuration and usage information about data frame analytics jobs.
946
+ IMPORTANT: cat APIs are only intended for human consumption using the Kibana
947
+ console or command line. They are not intended for use by applications. For application
948
+ consumption, use the get data frame analytics jobs statistics API.
863
949
 
864
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-dfanalytics.html>`_
950
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-dfanalytics.html>`_
865
951
 
866
952
  :param id: The ID of the data frame analytics to fetch
867
953
  :param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -941,46 +1027,101 @@ class CatClient(NamespacedClient):
941
1027
  t.Union[
942
1028
  t.Sequence[
943
1029
  t.Union[
944
- "t.Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st']",
945
1030
  str,
1031
+ t.Literal[
1032
+ "ae",
1033
+ "bc",
1034
+ "id",
1035
+ "na",
1036
+ "ne",
1037
+ "ni",
1038
+ "nn",
1039
+ "s",
1040
+ "sba",
1041
+ "sc",
1042
+ "seah",
1043
+ "st",
1044
+ ],
946
1045
  ]
947
1046
  ],
948
1047
  t.Union[
949
- "t.Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st']",
950
1048
  str,
1049
+ t.Literal[
1050
+ "ae",
1051
+ "bc",
1052
+ "id",
1053
+ "na",
1054
+ "ne",
1055
+ "ni",
1056
+ "nn",
1057
+ "s",
1058
+ "sba",
1059
+ "sc",
1060
+ "seah",
1061
+ "st",
1062
+ ],
951
1063
  ],
952
1064
  ]
953
1065
  ] = None,
954
1066
  help: t.Optional[bool] = None,
955
1067
  human: t.Optional[bool] = None,
956
1068
  local: t.Optional[bool] = None,
957
- master_timeout: t.Optional[
958
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
959
- ] = None,
1069
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
960
1070
  pretty: t.Optional[bool] = None,
961
1071
  s: t.Optional[
962
1072
  t.Union[
963
1073
  t.Sequence[
964
1074
  t.Union[
965
- "t.Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st']",
966
1075
  str,
1076
+ t.Literal[
1077
+ "ae",
1078
+ "bc",
1079
+ "id",
1080
+ "na",
1081
+ "ne",
1082
+ "ni",
1083
+ "nn",
1084
+ "s",
1085
+ "sba",
1086
+ "sc",
1087
+ "seah",
1088
+ "st",
1089
+ ],
967
1090
  ]
968
1091
  ],
969
1092
  t.Union[
970
- "t.Literal['ae', 'bc', 'id', 'na', 'ne', 'ni', 'nn', 's', 'sba', 'sc', 'seah', 'st']",
971
1093
  str,
1094
+ t.Literal[
1095
+ "ae",
1096
+ "bc",
1097
+ "id",
1098
+ "na",
1099
+ "ne",
1100
+ "ni",
1101
+ "nn",
1102
+ "s",
1103
+ "sba",
1104
+ "sc",
1105
+ "seah",
1106
+ "st",
1107
+ ],
972
1108
  ],
973
1109
  ]
974
1110
  ] = None,
975
1111
  time: t.Optional[
976
- t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
1112
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
977
1113
  ] = None,
978
1114
  v: t.Optional[bool] = None,
979
1115
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
980
1116
  """
981
- Gets configuration and usage information about datafeeds.
1117
+ Returns configuration and usage information about datafeeds. This API returns
1118
+ a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled,
1119
+ you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges
1120
+ to use this API. IMPORTANT: cat APIs are only intended for human consumption
1121
+ using the Kibana console or command line. They are not intended for use by applications.
1122
+ For application consumption, use the get datafeed statistics API.
982
1123
 
983
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-datafeeds.html>`_
1124
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-datafeeds.html>`_
984
1125
 
985
1126
  :param datafeed_id: A numerical character string that uniquely identifies the
986
1127
  datafeed.
@@ -1057,7 +1198,7 @@ class CatClient(NamespacedClient):
1057
1198
  job_id: t.Optional[str] = None,
1058
1199
  allow_no_match: t.Optional[bool] = None,
1059
1200
  bytes: t.Optional[
1060
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
1201
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
1061
1202
  ] = None,
1062
1203
  error_trace: t.Optional[bool] = None,
1063
1204
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -1066,46 +1207,294 @@ class CatClient(NamespacedClient):
1066
1207
  t.Union[
1067
1208
  t.Sequence[
1068
1209
  t.Union[
1069
- "t.Literal['assignment_explanation', 'buckets.count', 'buckets.time.exp_avg', 'buckets.time.exp_avg_hour', 'buckets.time.max', 'buckets.time.min', 'buckets.time.total', 'data.buckets', 'data.earliest_record', 'data.empty_buckets', 'data.input_bytes', 'data.input_fields', 'data.input_records', 'data.invalid_dates', 'data.last', 'data.last_empty_bucket', 'data.last_sparse_bucket', 'data.latest_record', 'data.missing_fields', 'data.out_of_order_timestamps', 'data.processed_fields', 'data.processed_records', 'data.sparse_buckets', 'forecasts.memory.avg', 'forecasts.memory.max', 'forecasts.memory.min', 'forecasts.memory.total', 'forecasts.records.avg', 'forecasts.records.max', 'forecasts.records.min', 'forecasts.records.total', 'forecasts.time.avg', 'forecasts.time.max', 'forecasts.time.min', 'forecasts.time.total', 'forecasts.total', 'id', 'model.bucket_allocation_failures', 'model.by_fields', 'model.bytes', 'model.bytes_exceeded', 'model.categorization_status', 'model.categorized_doc_count', 'model.dead_category_count', 'model.failed_category_count', 'model.frequent_category_count', 'model.log_time', 'model.memory_limit', 'model.memory_status', 'model.over_fields', 'model.partition_fields', 'model.rare_category_count', 'model.timestamp', 'model.total_category_count', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'opened_time', 'state']",
1070
1210
  str,
1211
+ t.Literal[
1212
+ "assignment_explanation",
1213
+ "buckets.count",
1214
+ "buckets.time.exp_avg",
1215
+ "buckets.time.exp_avg_hour",
1216
+ "buckets.time.max",
1217
+ "buckets.time.min",
1218
+ "buckets.time.total",
1219
+ "data.buckets",
1220
+ "data.earliest_record",
1221
+ "data.empty_buckets",
1222
+ "data.input_bytes",
1223
+ "data.input_fields",
1224
+ "data.input_records",
1225
+ "data.invalid_dates",
1226
+ "data.last",
1227
+ "data.last_empty_bucket",
1228
+ "data.last_sparse_bucket",
1229
+ "data.latest_record",
1230
+ "data.missing_fields",
1231
+ "data.out_of_order_timestamps",
1232
+ "data.processed_fields",
1233
+ "data.processed_records",
1234
+ "data.sparse_buckets",
1235
+ "forecasts.memory.avg",
1236
+ "forecasts.memory.max",
1237
+ "forecasts.memory.min",
1238
+ "forecasts.memory.total",
1239
+ "forecasts.records.avg",
1240
+ "forecasts.records.max",
1241
+ "forecasts.records.min",
1242
+ "forecasts.records.total",
1243
+ "forecasts.time.avg",
1244
+ "forecasts.time.max",
1245
+ "forecasts.time.min",
1246
+ "forecasts.time.total",
1247
+ "forecasts.total",
1248
+ "id",
1249
+ "model.bucket_allocation_failures",
1250
+ "model.by_fields",
1251
+ "model.bytes",
1252
+ "model.bytes_exceeded",
1253
+ "model.categorization_status",
1254
+ "model.categorized_doc_count",
1255
+ "model.dead_category_count",
1256
+ "model.failed_category_count",
1257
+ "model.frequent_category_count",
1258
+ "model.log_time",
1259
+ "model.memory_limit",
1260
+ "model.memory_status",
1261
+ "model.over_fields",
1262
+ "model.partition_fields",
1263
+ "model.rare_category_count",
1264
+ "model.timestamp",
1265
+ "model.total_category_count",
1266
+ "node.address",
1267
+ "node.ephemeral_id",
1268
+ "node.id",
1269
+ "node.name",
1270
+ "opened_time",
1271
+ "state",
1272
+ ],
1071
1273
  ]
1072
1274
  ],
1073
1275
  t.Union[
1074
- "t.Literal['assignment_explanation', 'buckets.count', 'buckets.time.exp_avg', 'buckets.time.exp_avg_hour', 'buckets.time.max', 'buckets.time.min', 'buckets.time.total', 'data.buckets', 'data.earliest_record', 'data.empty_buckets', 'data.input_bytes', 'data.input_fields', 'data.input_records', 'data.invalid_dates', 'data.last', 'data.last_empty_bucket', 'data.last_sparse_bucket', 'data.latest_record', 'data.missing_fields', 'data.out_of_order_timestamps', 'data.processed_fields', 'data.processed_records', 'data.sparse_buckets', 'forecasts.memory.avg', 'forecasts.memory.max', 'forecasts.memory.min', 'forecasts.memory.total', 'forecasts.records.avg', 'forecasts.records.max', 'forecasts.records.min', 'forecasts.records.total', 'forecasts.time.avg', 'forecasts.time.max', 'forecasts.time.min', 'forecasts.time.total', 'forecasts.total', 'id', 'model.bucket_allocation_failures', 'model.by_fields', 'model.bytes', 'model.bytes_exceeded', 'model.categorization_status', 'model.categorized_doc_count', 'model.dead_category_count', 'model.failed_category_count', 'model.frequent_category_count', 'model.log_time', 'model.memory_limit', 'model.memory_status', 'model.over_fields', 'model.partition_fields', 'model.rare_category_count', 'model.timestamp', 'model.total_category_count', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'opened_time', 'state']",
1075
1276
  str,
1277
+ t.Literal[
1278
+ "assignment_explanation",
1279
+ "buckets.count",
1280
+ "buckets.time.exp_avg",
1281
+ "buckets.time.exp_avg_hour",
1282
+ "buckets.time.max",
1283
+ "buckets.time.min",
1284
+ "buckets.time.total",
1285
+ "data.buckets",
1286
+ "data.earliest_record",
1287
+ "data.empty_buckets",
1288
+ "data.input_bytes",
1289
+ "data.input_fields",
1290
+ "data.input_records",
1291
+ "data.invalid_dates",
1292
+ "data.last",
1293
+ "data.last_empty_bucket",
1294
+ "data.last_sparse_bucket",
1295
+ "data.latest_record",
1296
+ "data.missing_fields",
1297
+ "data.out_of_order_timestamps",
1298
+ "data.processed_fields",
1299
+ "data.processed_records",
1300
+ "data.sparse_buckets",
1301
+ "forecasts.memory.avg",
1302
+ "forecasts.memory.max",
1303
+ "forecasts.memory.min",
1304
+ "forecasts.memory.total",
1305
+ "forecasts.records.avg",
1306
+ "forecasts.records.max",
1307
+ "forecasts.records.min",
1308
+ "forecasts.records.total",
1309
+ "forecasts.time.avg",
1310
+ "forecasts.time.max",
1311
+ "forecasts.time.min",
1312
+ "forecasts.time.total",
1313
+ "forecasts.total",
1314
+ "id",
1315
+ "model.bucket_allocation_failures",
1316
+ "model.by_fields",
1317
+ "model.bytes",
1318
+ "model.bytes_exceeded",
1319
+ "model.categorization_status",
1320
+ "model.categorized_doc_count",
1321
+ "model.dead_category_count",
1322
+ "model.failed_category_count",
1323
+ "model.frequent_category_count",
1324
+ "model.log_time",
1325
+ "model.memory_limit",
1326
+ "model.memory_status",
1327
+ "model.over_fields",
1328
+ "model.partition_fields",
1329
+ "model.rare_category_count",
1330
+ "model.timestamp",
1331
+ "model.total_category_count",
1332
+ "node.address",
1333
+ "node.ephemeral_id",
1334
+ "node.id",
1335
+ "node.name",
1336
+ "opened_time",
1337
+ "state",
1338
+ ],
1076
1339
  ],
1077
1340
  ]
1078
1341
  ] = None,
1079
1342
  help: t.Optional[bool] = None,
1080
1343
  human: t.Optional[bool] = None,
1081
1344
  local: t.Optional[bool] = None,
1082
- master_timeout: t.Optional[
1083
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1084
- ] = None,
1345
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1085
1346
  pretty: t.Optional[bool] = None,
1086
1347
  s: t.Optional[
1087
1348
  t.Union[
1088
1349
  t.Sequence[
1089
1350
  t.Union[
1090
- "t.Literal['assignment_explanation', 'buckets.count', 'buckets.time.exp_avg', 'buckets.time.exp_avg_hour', 'buckets.time.max', 'buckets.time.min', 'buckets.time.total', 'data.buckets', 'data.earliest_record', 'data.empty_buckets', 'data.input_bytes', 'data.input_fields', 'data.input_records', 'data.invalid_dates', 'data.last', 'data.last_empty_bucket', 'data.last_sparse_bucket', 'data.latest_record', 'data.missing_fields', 'data.out_of_order_timestamps', 'data.processed_fields', 'data.processed_records', 'data.sparse_buckets', 'forecasts.memory.avg', 'forecasts.memory.max', 'forecasts.memory.min', 'forecasts.memory.total', 'forecasts.records.avg', 'forecasts.records.max', 'forecasts.records.min', 'forecasts.records.total', 'forecasts.time.avg', 'forecasts.time.max', 'forecasts.time.min', 'forecasts.time.total', 'forecasts.total', 'id', 'model.bucket_allocation_failures', 'model.by_fields', 'model.bytes', 'model.bytes_exceeded', 'model.categorization_status', 'model.categorized_doc_count', 'model.dead_category_count', 'model.failed_category_count', 'model.frequent_category_count', 'model.log_time', 'model.memory_limit', 'model.memory_status', 'model.over_fields', 'model.partition_fields', 'model.rare_category_count', 'model.timestamp', 'model.total_category_count', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'opened_time', 'state']",
1091
1351
  str,
1352
+ t.Literal[
1353
+ "assignment_explanation",
1354
+ "buckets.count",
1355
+ "buckets.time.exp_avg",
1356
+ "buckets.time.exp_avg_hour",
1357
+ "buckets.time.max",
1358
+ "buckets.time.min",
1359
+ "buckets.time.total",
1360
+ "data.buckets",
1361
+ "data.earliest_record",
1362
+ "data.empty_buckets",
1363
+ "data.input_bytes",
1364
+ "data.input_fields",
1365
+ "data.input_records",
1366
+ "data.invalid_dates",
1367
+ "data.last",
1368
+ "data.last_empty_bucket",
1369
+ "data.last_sparse_bucket",
1370
+ "data.latest_record",
1371
+ "data.missing_fields",
1372
+ "data.out_of_order_timestamps",
1373
+ "data.processed_fields",
1374
+ "data.processed_records",
1375
+ "data.sparse_buckets",
1376
+ "forecasts.memory.avg",
1377
+ "forecasts.memory.max",
1378
+ "forecasts.memory.min",
1379
+ "forecasts.memory.total",
1380
+ "forecasts.records.avg",
1381
+ "forecasts.records.max",
1382
+ "forecasts.records.min",
1383
+ "forecasts.records.total",
1384
+ "forecasts.time.avg",
1385
+ "forecasts.time.max",
1386
+ "forecasts.time.min",
1387
+ "forecasts.time.total",
1388
+ "forecasts.total",
1389
+ "id",
1390
+ "model.bucket_allocation_failures",
1391
+ "model.by_fields",
1392
+ "model.bytes",
1393
+ "model.bytes_exceeded",
1394
+ "model.categorization_status",
1395
+ "model.categorized_doc_count",
1396
+ "model.dead_category_count",
1397
+ "model.failed_category_count",
1398
+ "model.frequent_category_count",
1399
+ "model.log_time",
1400
+ "model.memory_limit",
1401
+ "model.memory_status",
1402
+ "model.over_fields",
1403
+ "model.partition_fields",
1404
+ "model.rare_category_count",
1405
+ "model.timestamp",
1406
+ "model.total_category_count",
1407
+ "node.address",
1408
+ "node.ephemeral_id",
1409
+ "node.id",
1410
+ "node.name",
1411
+ "opened_time",
1412
+ "state",
1413
+ ],
1092
1414
  ]
1093
1415
  ],
1094
1416
  t.Union[
1095
- "t.Literal['assignment_explanation', 'buckets.count', 'buckets.time.exp_avg', 'buckets.time.exp_avg_hour', 'buckets.time.max', 'buckets.time.min', 'buckets.time.total', 'data.buckets', 'data.earliest_record', 'data.empty_buckets', 'data.input_bytes', 'data.input_fields', 'data.input_records', 'data.invalid_dates', 'data.last', 'data.last_empty_bucket', 'data.last_sparse_bucket', 'data.latest_record', 'data.missing_fields', 'data.out_of_order_timestamps', 'data.processed_fields', 'data.processed_records', 'data.sparse_buckets', 'forecasts.memory.avg', 'forecasts.memory.max', 'forecasts.memory.min', 'forecasts.memory.total', 'forecasts.records.avg', 'forecasts.records.max', 'forecasts.records.min', 'forecasts.records.total', 'forecasts.time.avg', 'forecasts.time.max', 'forecasts.time.min', 'forecasts.time.total', 'forecasts.total', 'id', 'model.bucket_allocation_failures', 'model.by_fields', 'model.bytes', 'model.bytes_exceeded', 'model.categorization_status', 'model.categorized_doc_count', 'model.dead_category_count', 'model.failed_category_count', 'model.frequent_category_count', 'model.log_time', 'model.memory_limit', 'model.memory_status', 'model.over_fields', 'model.partition_fields', 'model.rare_category_count', 'model.timestamp', 'model.total_category_count', 'node.address', 'node.ephemeral_id', 'node.id', 'node.name', 'opened_time', 'state']",
1096
1417
  str,
1418
+ t.Literal[
1419
+ "assignment_explanation",
1420
+ "buckets.count",
1421
+ "buckets.time.exp_avg",
1422
+ "buckets.time.exp_avg_hour",
1423
+ "buckets.time.max",
1424
+ "buckets.time.min",
1425
+ "buckets.time.total",
1426
+ "data.buckets",
1427
+ "data.earliest_record",
1428
+ "data.empty_buckets",
1429
+ "data.input_bytes",
1430
+ "data.input_fields",
1431
+ "data.input_records",
1432
+ "data.invalid_dates",
1433
+ "data.last",
1434
+ "data.last_empty_bucket",
1435
+ "data.last_sparse_bucket",
1436
+ "data.latest_record",
1437
+ "data.missing_fields",
1438
+ "data.out_of_order_timestamps",
1439
+ "data.processed_fields",
1440
+ "data.processed_records",
1441
+ "data.sparse_buckets",
1442
+ "forecasts.memory.avg",
1443
+ "forecasts.memory.max",
1444
+ "forecasts.memory.min",
1445
+ "forecasts.memory.total",
1446
+ "forecasts.records.avg",
1447
+ "forecasts.records.max",
1448
+ "forecasts.records.min",
1449
+ "forecasts.records.total",
1450
+ "forecasts.time.avg",
1451
+ "forecasts.time.max",
1452
+ "forecasts.time.min",
1453
+ "forecasts.time.total",
1454
+ "forecasts.total",
1455
+ "id",
1456
+ "model.bucket_allocation_failures",
1457
+ "model.by_fields",
1458
+ "model.bytes",
1459
+ "model.bytes_exceeded",
1460
+ "model.categorization_status",
1461
+ "model.categorized_doc_count",
1462
+ "model.dead_category_count",
1463
+ "model.failed_category_count",
1464
+ "model.frequent_category_count",
1465
+ "model.log_time",
1466
+ "model.memory_limit",
1467
+ "model.memory_status",
1468
+ "model.over_fields",
1469
+ "model.partition_fields",
1470
+ "model.rare_category_count",
1471
+ "model.timestamp",
1472
+ "model.total_category_count",
1473
+ "node.address",
1474
+ "node.ephemeral_id",
1475
+ "node.id",
1476
+ "node.name",
1477
+ "opened_time",
1478
+ "state",
1479
+ ],
1097
1480
  ],
1098
1481
  ]
1099
1482
  ] = None,
1100
1483
  time: t.Optional[
1101
- t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
1484
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
1102
1485
  ] = None,
1103
1486
  v: t.Optional[bool] = None,
1104
1487
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1105
1488
  """
1106
- Gets configuration and usage information about anomaly detection jobs.
1489
+ Returns configuration and usage information for anomaly detection jobs. This
1490
+ API returns a maximum of 10,000 jobs. If the Elasticsearch security features
1491
+ are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
1492
+ cluster privileges to use this API. IMPORTANT: cat APIs are only intended for
1493
+ human consumption using the Kibana console or command line. They are not intended
1494
+ for use by applications. For application consumption, use the get anomaly detection
1495
+ job statistics API.
1107
1496
 
1108
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-anomaly-detectors.html>`_
1497
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-anomaly-detectors.html>`_
1109
1498
 
1110
1499
  :param job_id: Identifier for the anomaly detection job.
1111
1500
  :param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1186,7 +1575,7 @@ class CatClient(NamespacedClient):
1186
1575
  model_id: t.Optional[str] = None,
1187
1576
  allow_no_match: t.Optional[bool] = None,
1188
1577
  bytes: t.Optional[
1189
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
1578
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
1190
1579
  ] = None,
1191
1580
  error_trace: t.Optional[bool] = None,
1192
1581
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -1196,34 +1585,92 @@ class CatClient(NamespacedClient):
1196
1585
  t.Union[
1197
1586
  t.Sequence[
1198
1587
  t.Union[
1199
- "t.Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version']",
1200
1588
  str,
1589
+ t.Literal[
1590
+ "create_time",
1591
+ "created_by",
1592
+ "data_frame_analytics_id",
1593
+ "description",
1594
+ "heap_size",
1595
+ "id",
1596
+ "ingest.count",
1597
+ "ingest.current",
1598
+ "ingest.failed",
1599
+ "ingest.pipelines",
1600
+ "ingest.time",
1601
+ "license",
1602
+ "operations",
1603
+ "version",
1604
+ ],
1201
1605
  ]
1202
1606
  ],
1203
1607
  t.Union[
1204
- "t.Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version']",
1205
1608
  str,
1609
+ t.Literal[
1610
+ "create_time",
1611
+ "created_by",
1612
+ "data_frame_analytics_id",
1613
+ "description",
1614
+ "heap_size",
1615
+ "id",
1616
+ "ingest.count",
1617
+ "ingest.current",
1618
+ "ingest.failed",
1619
+ "ingest.pipelines",
1620
+ "ingest.time",
1621
+ "license",
1622
+ "operations",
1623
+ "version",
1624
+ ],
1206
1625
  ],
1207
1626
  ]
1208
1627
  ] = None,
1209
1628
  help: t.Optional[bool] = None,
1210
1629
  human: t.Optional[bool] = None,
1211
1630
  local: t.Optional[bool] = None,
1212
- master_timeout: t.Optional[
1213
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1214
- ] = None,
1631
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1215
1632
  pretty: t.Optional[bool] = None,
1216
1633
  s: t.Optional[
1217
1634
  t.Union[
1218
1635
  t.Sequence[
1219
1636
  t.Union[
1220
- "t.Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version']",
1221
1637
  str,
1638
+ t.Literal[
1639
+ "create_time",
1640
+ "created_by",
1641
+ "data_frame_analytics_id",
1642
+ "description",
1643
+ "heap_size",
1644
+ "id",
1645
+ "ingest.count",
1646
+ "ingest.current",
1647
+ "ingest.failed",
1648
+ "ingest.pipelines",
1649
+ "ingest.time",
1650
+ "license",
1651
+ "operations",
1652
+ "version",
1653
+ ],
1222
1654
  ]
1223
1655
  ],
1224
1656
  t.Union[
1225
- "t.Literal['create_time', 'created_by', 'data_frame_analytics_id', 'description', 'heap_size', 'id', 'ingest.count', 'ingest.current', 'ingest.failed', 'ingest.pipelines', 'ingest.time', 'license', 'operations', 'version']",
1226
1657
  str,
1658
+ t.Literal[
1659
+ "create_time",
1660
+ "created_by",
1661
+ "data_frame_analytics_id",
1662
+ "description",
1663
+ "heap_size",
1664
+ "id",
1665
+ "ingest.count",
1666
+ "ingest.current",
1667
+ "ingest.failed",
1668
+ "ingest.pipelines",
1669
+ "ingest.time",
1670
+ "license",
1671
+ "operations",
1672
+ "version",
1673
+ ],
1227
1674
  ],
1228
1675
  ]
1229
1676
  ] = None,
@@ -1231,9 +1678,12 @@ class CatClient(NamespacedClient):
1231
1678
  v: t.Optional[bool] = None,
1232
1679
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1233
1680
  """
1234
- Gets configuration and usage information about inference trained models.
1681
+ Returns configuration and usage information about inference trained models. IMPORTANT:
1682
+ cat APIs are only intended for human consumption using the Kibana console or
1683
+ command line. They are not intended for use by applications. For application
1684
+ consumption, use the get trained models statistics API.
1235
1685
 
1236
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-trained-model.html>`_
1686
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-trained-model.html>`_
1237
1687
 
1238
1688
  :param model_id: A unique identifier for the trained model.
1239
1689
  :param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1319,17 +1769,18 @@ class CatClient(NamespacedClient):
1319
1769
  help: t.Optional[bool] = None,
1320
1770
  human: t.Optional[bool] = None,
1321
1771
  local: t.Optional[bool] = None,
1322
- master_timeout: t.Optional[
1323
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1324
- ] = None,
1772
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1325
1773
  pretty: t.Optional[bool] = None,
1326
1774
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1327
1775
  v: t.Optional[bool] = None,
1328
1776
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1329
1777
  """
1330
- Returns information about custom node attributes.
1778
+ Returns information about custom node attributes. IMPORTANT: cat APIs are only
1779
+ intended for human consumption using the command line or Kibana console. They
1780
+ are not intended for use by applications. For application consumption, use the
1781
+ nodes info API.
1331
1782
 
1332
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-nodeattrs.html>`_
1783
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-nodeattrs.html>`_
1333
1784
 
1334
1785
  :param format: Specifies the format to return the columnar data in, can be set
1335
1786
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1386,7 +1837,7 @@ class CatClient(NamespacedClient):
1386
1837
  self,
1387
1838
  *,
1388
1839
  bytes: t.Optional[
1389
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
1840
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
1390
1841
  ] = None,
1391
1842
  error_trace: t.Optional[bool] = None,
1392
1843
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -1397,17 +1848,18 @@ class CatClient(NamespacedClient):
1397
1848
  human: t.Optional[bool] = None,
1398
1849
  include_unloaded_segments: t.Optional[bool] = None,
1399
1850
  local: t.Optional[bool] = None,
1400
- master_timeout: t.Optional[
1401
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1402
- ] = None,
1851
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1403
1852
  pretty: t.Optional[bool] = None,
1404
1853
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1405
1854
  v: t.Optional[bool] = None,
1406
1855
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1407
1856
  """
1408
- Returns basic statistics about performance of cluster nodes.
1857
+ Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only
1858
+ intended for human consumption using the command line or Kibana console. They
1859
+ are not intended for use by applications. For application consumption, use the
1860
+ nodes info API.
1409
1861
 
1410
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-nodes.html>`_
1862
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-nodes.html>`_
1411
1863
 
1412
1864
  :param bytes: The unit used to display byte values.
1413
1865
  :param format: Specifies the format to return the columnar data in, can be set
@@ -1481,17 +1933,18 @@ class CatClient(NamespacedClient):
1481
1933
  help: t.Optional[bool] = None,
1482
1934
  human: t.Optional[bool] = None,
1483
1935
  local: t.Optional[bool] = None,
1484
- master_timeout: t.Optional[
1485
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1486
- ] = None,
1936
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1487
1937
  pretty: t.Optional[bool] = None,
1488
1938
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1489
1939
  v: t.Optional[bool] = None,
1490
1940
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1491
1941
  """
1492
- Returns a concise representation of the cluster pending tasks.
1942
+ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat
1943
+ APIs are only intended for human consumption using the command line or Kibana
1944
+ console. They are not intended for use by applications. For application consumption,
1945
+ use the pending cluster tasks API.
1493
1946
 
1494
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-pending-tasks.html>`_
1947
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-pending-tasks.html>`_
1495
1948
 
1496
1949
  :param format: Specifies the format to return the columnar data in, can be set
1497
1950
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1554,17 +2007,18 @@ class CatClient(NamespacedClient):
1554
2007
  help: t.Optional[bool] = None,
1555
2008
  human: t.Optional[bool] = None,
1556
2009
  local: t.Optional[bool] = None,
1557
- master_timeout: t.Optional[
1558
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1559
- ] = None,
2010
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1560
2011
  pretty: t.Optional[bool] = None,
1561
2012
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1562
2013
  v: t.Optional[bool] = None,
1563
2014
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1564
2015
  """
1565
- Returns information about installed plugins across nodes node.
2016
+ Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs
2017
+ are only intended for human consumption using the command line or Kibana console.
2018
+ They are not intended for use by applications. For application consumption, use
2019
+ the nodes info API.
1566
2020
 
1567
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-plugins.html>`_
2021
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-plugins.html>`_
1568
2022
 
1569
2023
  :param format: Specifies the format to return the columnar data in, can be set
1570
2024
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1623,7 +2077,7 @@ class CatClient(NamespacedClient):
1623
2077
  index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1624
2078
  active_only: t.Optional[bool] = None,
1625
2079
  bytes: t.Optional[
1626
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
2080
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
1627
2081
  ] = None,
1628
2082
  detailed: t.Optional[bool] = None,
1629
2083
  error_trace: t.Optional[bool] = None,
@@ -1633,17 +2087,22 @@ class CatClient(NamespacedClient):
1633
2087
  help: t.Optional[bool] = None,
1634
2088
  human: t.Optional[bool] = None,
1635
2089
  local: t.Optional[bool] = None,
1636
- master_timeout: t.Optional[
1637
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1638
- ] = None,
2090
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1639
2091
  pretty: t.Optional[bool] = None,
1640
2092
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1641
2093
  v: t.Optional[bool] = None,
1642
2094
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1643
2095
  """
1644
- Returns information about index shard recoveries, both on-going completed.
2096
+ Returns information about ongoing and completed shard recoveries. Shard recovery
2097
+ is the process of initializing a shard copy, such as restoring a primary shard
2098
+ from a snapshot or syncing a replica shard from a primary shard. When a shard
2099
+ recovery completes, the recovered shard is available for search and indexing.
2100
+ For data streams, the API returns information about the stream’s backing indices.
2101
+ IMPORTANT: cat APIs are only intended for human consumption using the command
2102
+ line or Kibana console. They are not intended for use by applications. For application
2103
+ consumption, use the index recovery API.
1645
2104
 
1646
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-recovery.html>`_
2105
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-recovery.html>`_
1647
2106
 
1648
2107
  :param index: A comma-separated list of data streams, indices, and aliases used
1649
2108
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1724,17 +2183,18 @@ class CatClient(NamespacedClient):
1724
2183
  help: t.Optional[bool] = None,
1725
2184
  human: t.Optional[bool] = None,
1726
2185
  local: t.Optional[bool] = None,
1727
- master_timeout: t.Optional[
1728
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1729
- ] = None,
2186
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1730
2187
  pretty: t.Optional[bool] = None,
1731
2188
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1732
2189
  v: t.Optional[bool] = None,
1733
2190
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1734
2191
  """
1735
- Returns information about snapshot repositories registered in the cluster.
2192
+ Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only
2193
+ intended for human consumption using the command line or Kibana console. They
2194
+ are not intended for use by applications. For application consumption, use the
2195
+ get snapshot repository API.
1736
2196
 
1737
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-repositories.html>`_
2197
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-repositories.html>`_
1738
2198
 
1739
2199
  :param format: Specifies the format to return the columnar data in, can be set
1740
2200
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1792,7 +2252,7 @@ class CatClient(NamespacedClient):
1792
2252
  *,
1793
2253
  index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1794
2254
  bytes: t.Optional[
1795
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
2255
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
1796
2256
  ] = None,
1797
2257
  error_trace: t.Optional[bool] = None,
1798
2258
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -1801,17 +2261,19 @@ class CatClient(NamespacedClient):
1801
2261
  help: t.Optional[bool] = None,
1802
2262
  human: t.Optional[bool] = None,
1803
2263
  local: t.Optional[bool] = None,
1804
- master_timeout: t.Optional[
1805
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1806
- ] = None,
2264
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1807
2265
  pretty: t.Optional[bool] = None,
1808
2266
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1809
2267
  v: t.Optional[bool] = None,
1810
2268
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1811
2269
  """
1812
- Provides low-level information about the segments in the shards of an index.
2270
+ Returns low-level information about the Lucene segments in index shards. For
2271
+ data streams, the API returns information about the backing indices. IMPORTANT:
2272
+ cat APIs are only intended for human consumption using the command line or Kibana
2273
+ console. They are not intended for use by applications. For application consumption,
2274
+ use the index segments API.
1813
2275
 
1814
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-segments.html>`_
2276
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-segments.html>`_
1815
2277
 
1816
2278
  :param index: A comma-separated list of data streams, indices, and aliases used
1817
2279
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1880,7 +2342,7 @@ class CatClient(NamespacedClient):
1880
2342
  *,
1881
2343
  index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1882
2344
  bytes: t.Optional[
1883
- t.Union["t.Literal['b', 'gb', 'kb', 'mb', 'pb', 'tb']", str]
2345
+ t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
1884
2346
  ] = None,
1885
2347
  error_trace: t.Optional[bool] = None,
1886
2348
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -1889,17 +2351,18 @@ class CatClient(NamespacedClient):
1889
2351
  help: t.Optional[bool] = None,
1890
2352
  human: t.Optional[bool] = None,
1891
2353
  local: t.Optional[bool] = None,
1892
- master_timeout: t.Optional[
1893
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1894
- ] = None,
2354
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1895
2355
  pretty: t.Optional[bool] = None,
1896
2356
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1897
2357
  v: t.Optional[bool] = None,
1898
2358
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1899
2359
  """
1900
- Provides a detailed view of shard allocation on nodes.
2360
+ Returns information about the shards in a cluster. For data streams, the API
2361
+ returns information about the backing indices. IMPORTANT: cat APIs are only intended
2362
+ for human consumption using the command line or Kibana console. They are not
2363
+ intended for use by applications.
1901
2364
 
1902
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-shards.html>`_
2365
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-shards.html>`_
1903
2366
 
1904
2367
  :param index: A comma-separated list of data streams, indices, and aliases used
1905
2368
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -1975,17 +2438,19 @@ class CatClient(NamespacedClient):
1975
2438
  human: t.Optional[bool] = None,
1976
2439
  ignore_unavailable: t.Optional[bool] = None,
1977
2440
  local: t.Optional[bool] = None,
1978
- master_timeout: t.Optional[
1979
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
1980
- ] = None,
2441
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1981
2442
  pretty: t.Optional[bool] = None,
1982
2443
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1983
2444
  v: t.Optional[bool] = None,
1984
2445
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1985
2446
  """
1986
- Returns all snapshots in a specific repository.
2447
+ Returns information about the snapshots stored in one or more repositories. A
2448
+ snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT:
2449
+ cat APIs are only intended for human consumption using the command line or Kibana
2450
+ console. They are not intended for use by applications. For application consumption,
2451
+ use the get snapshot API.
1987
2452
 
1988
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-snapshots.html>`_
2453
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-snapshots.html>`_
1989
2454
 
1990
2455
  :param repository: A comma-separated list of snapshot repositories used to limit
1991
2456
  the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -2062,9 +2527,7 @@ class CatClient(NamespacedClient):
2062
2527
  help: t.Optional[bool] = None,
2063
2528
  human: t.Optional[bool] = None,
2064
2529
  local: t.Optional[bool] = None,
2065
- master_timeout: t.Optional[
2066
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
2067
- ] = None,
2530
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2068
2531
  node_id: t.Optional[t.Sequence[str]] = None,
2069
2532
  parent_task_id: t.Optional[str] = None,
2070
2533
  pretty: t.Optional[bool] = None,
@@ -2072,10 +2535,12 @@ class CatClient(NamespacedClient):
2072
2535
  v: t.Optional[bool] = None,
2073
2536
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2074
2537
  """
2075
- Returns information about the tasks currently executing on one or more nodes
2076
- in the cluster.
2538
+ Returns information about tasks currently executing in the cluster. IMPORTANT:
2539
+ cat APIs are only intended for human consumption using the command line or Kibana
2540
+ console. They are not intended for use by applications. For application consumption,
2541
+ use the task management API.
2077
2542
 
2078
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/tasks.html>`_
2543
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/tasks.html>`_
2079
2544
 
2080
2545
  :param actions: The task action names, which are used to limit the response.
2081
2546
  :param detailed: If `true`, the response includes detailed information about
@@ -2153,17 +2618,19 @@ class CatClient(NamespacedClient):
2153
2618
  help: t.Optional[bool] = None,
2154
2619
  human: t.Optional[bool] = None,
2155
2620
  local: t.Optional[bool] = None,
2156
- master_timeout: t.Optional[
2157
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
2158
- ] = None,
2621
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2159
2622
  pretty: t.Optional[bool] = None,
2160
2623
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2161
2624
  v: t.Optional[bool] = None,
2162
2625
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2163
2626
  """
2164
- Returns information about existing templates.
2627
+ Returns information about index templates in a cluster. You can use index templates
2628
+ to apply index settings and field mappings to new indices at creation. IMPORTANT:
2629
+ cat APIs are only intended for human consumption using the command line or Kibana
2630
+ console. They are not intended for use by applications. For application consumption,
2631
+ use the get index template API.
2165
2632
 
2166
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-templates.html>`_
2633
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-templates.html>`_
2167
2634
 
2168
2635
  :param name: The name of the template to return. Accepts wildcard expressions.
2169
2636
  If omitted, all templates are returned.
@@ -2234,21 +2701,22 @@ class CatClient(NamespacedClient):
2234
2701
  help: t.Optional[bool] = None,
2235
2702
  human: t.Optional[bool] = None,
2236
2703
  local: t.Optional[bool] = None,
2237
- master_timeout: t.Optional[
2238
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
2239
- ] = None,
2704
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2240
2705
  pretty: t.Optional[bool] = None,
2241
2706
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2242
2707
  time: t.Optional[
2243
- t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
2708
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
2244
2709
  ] = None,
2245
2710
  v: t.Optional[bool] = None,
2246
2711
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2247
2712
  """
2248
- Returns cluster-wide thread pool statistics per node. By default the active,
2249
- queue and rejected statistics are returned for all thread pools.
2713
+ Returns thread pool statistics for each node in a cluster. Returned information
2714
+ includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs
2715
+ are only intended for human consumption using the command line or Kibana console.
2716
+ They are not intended for use by applications. For application consumption, use
2717
+ the nodes info API.
2250
2718
 
2251
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-thread-pool.html>`_
2719
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-thread-pool.html>`_
2252
2720
 
2253
2721
  :param thread_pool_patterns: A comma-separated list of thread pool names used
2254
2722
  to limit the request. Accepts wildcard expressions.
@@ -2326,47 +2794,184 @@ class CatClient(NamespacedClient):
2326
2794
  t.Union[
2327
2795
  t.Sequence[
2328
2796
  t.Union[
2329
- "t.Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version']",
2330
2797
  str,
2798
+ t.Literal[
2799
+ "changes_last_detection_time",
2800
+ "checkpoint",
2801
+ "checkpoint_duration_time_exp_avg",
2802
+ "checkpoint_progress",
2803
+ "create_time",
2804
+ "delete_time",
2805
+ "description",
2806
+ "dest_index",
2807
+ "docs_per_second",
2808
+ "documents_deleted",
2809
+ "documents_indexed",
2810
+ "documents_processed",
2811
+ "frequency",
2812
+ "id",
2813
+ "index_failure",
2814
+ "index_time",
2815
+ "index_total",
2816
+ "indexed_documents_exp_avg",
2817
+ "last_search_time",
2818
+ "max_page_search_size",
2819
+ "pages_processed",
2820
+ "pipeline",
2821
+ "processed_documents_exp_avg",
2822
+ "processing_time",
2823
+ "reason",
2824
+ "search_failure",
2825
+ "search_time",
2826
+ "search_total",
2827
+ "source_index",
2828
+ "state",
2829
+ "transform_type",
2830
+ "trigger_count",
2831
+ "version",
2832
+ ],
2331
2833
  ]
2332
2834
  ],
2333
2835
  t.Union[
2334
- "t.Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version']",
2335
2836
  str,
2837
+ t.Literal[
2838
+ "changes_last_detection_time",
2839
+ "checkpoint",
2840
+ "checkpoint_duration_time_exp_avg",
2841
+ "checkpoint_progress",
2842
+ "create_time",
2843
+ "delete_time",
2844
+ "description",
2845
+ "dest_index",
2846
+ "docs_per_second",
2847
+ "documents_deleted",
2848
+ "documents_indexed",
2849
+ "documents_processed",
2850
+ "frequency",
2851
+ "id",
2852
+ "index_failure",
2853
+ "index_time",
2854
+ "index_total",
2855
+ "indexed_documents_exp_avg",
2856
+ "last_search_time",
2857
+ "max_page_search_size",
2858
+ "pages_processed",
2859
+ "pipeline",
2860
+ "processed_documents_exp_avg",
2861
+ "processing_time",
2862
+ "reason",
2863
+ "search_failure",
2864
+ "search_time",
2865
+ "search_total",
2866
+ "source_index",
2867
+ "state",
2868
+ "transform_type",
2869
+ "trigger_count",
2870
+ "version",
2871
+ ],
2336
2872
  ],
2337
2873
  ]
2338
2874
  ] = None,
2339
2875
  help: t.Optional[bool] = None,
2340
2876
  human: t.Optional[bool] = None,
2341
2877
  local: t.Optional[bool] = None,
2342
- master_timeout: t.Optional[
2343
- t.Union["t.Literal[-1]", "t.Literal[0]", str]
2344
- ] = None,
2878
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2345
2879
  pretty: t.Optional[bool] = None,
2346
2880
  s: t.Optional[
2347
2881
  t.Union[
2348
2882
  t.Sequence[
2349
2883
  t.Union[
2350
- "t.Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version']",
2351
2884
  str,
2885
+ t.Literal[
2886
+ "changes_last_detection_time",
2887
+ "checkpoint",
2888
+ "checkpoint_duration_time_exp_avg",
2889
+ "checkpoint_progress",
2890
+ "create_time",
2891
+ "delete_time",
2892
+ "description",
2893
+ "dest_index",
2894
+ "docs_per_second",
2895
+ "documents_deleted",
2896
+ "documents_indexed",
2897
+ "documents_processed",
2898
+ "frequency",
2899
+ "id",
2900
+ "index_failure",
2901
+ "index_time",
2902
+ "index_total",
2903
+ "indexed_documents_exp_avg",
2904
+ "last_search_time",
2905
+ "max_page_search_size",
2906
+ "pages_processed",
2907
+ "pipeline",
2908
+ "processed_documents_exp_avg",
2909
+ "processing_time",
2910
+ "reason",
2911
+ "search_failure",
2912
+ "search_time",
2913
+ "search_total",
2914
+ "source_index",
2915
+ "state",
2916
+ "transform_type",
2917
+ "trigger_count",
2918
+ "version",
2919
+ ],
2352
2920
  ]
2353
2921
  ],
2354
2922
  t.Union[
2355
- "t.Literal['changes_last_detection_time', 'checkpoint', 'checkpoint_duration_time_exp_avg', 'checkpoint_progress', 'create_time', 'delete_time', 'description', 'dest_index', 'docs_per_second', 'documents_deleted', 'documents_indexed', 'documents_processed', 'frequency', 'id', 'index_failure', 'index_time', 'index_total', 'indexed_documents_exp_avg', 'last_search_time', 'max_page_search_size', 'pages_processed', 'pipeline', 'processed_documents_exp_avg', 'processing_time', 'reason', 'search_failure', 'search_time', 'search_total', 'source_index', 'state', 'transform_type', 'trigger_count', 'version']",
2356
2923
  str,
2924
+ t.Literal[
2925
+ "changes_last_detection_time",
2926
+ "checkpoint",
2927
+ "checkpoint_duration_time_exp_avg",
2928
+ "checkpoint_progress",
2929
+ "create_time",
2930
+ "delete_time",
2931
+ "description",
2932
+ "dest_index",
2933
+ "docs_per_second",
2934
+ "documents_deleted",
2935
+ "documents_indexed",
2936
+ "documents_processed",
2937
+ "frequency",
2938
+ "id",
2939
+ "index_failure",
2940
+ "index_time",
2941
+ "index_total",
2942
+ "indexed_documents_exp_avg",
2943
+ "last_search_time",
2944
+ "max_page_search_size",
2945
+ "pages_processed",
2946
+ "pipeline",
2947
+ "processed_documents_exp_avg",
2948
+ "processing_time",
2949
+ "reason",
2950
+ "search_failure",
2951
+ "search_time",
2952
+ "search_total",
2953
+ "source_index",
2954
+ "state",
2955
+ "transform_type",
2956
+ "trigger_count",
2957
+ "version",
2958
+ ],
2357
2959
  ],
2358
2960
  ]
2359
2961
  ] = None,
2360
2962
  size: t.Optional[int] = None,
2361
2963
  time: t.Optional[
2362
- t.Union["t.Literal['d', 'h', 'm', 'micros', 'ms', 'nanos', 's']", str]
2964
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
2363
2965
  ] = None,
2364
2966
  v: t.Optional[bool] = None,
2365
2967
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2366
2968
  """
2367
- Gets configuration and usage information about transforms.
2969
+ Returns configuration and usage information about transforms. IMPORTANT: cat
2970
+ APIs are only intended for human consumption using the Kibana console or command
2971
+ line. They are not intended for use by applications. For application consumption,
2972
+ use the get transform statistics API.
2368
2973
 
2369
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/cat-transforms.html>`_
2974
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-transforms.html>`_
2370
2975
 
2371
2976
  :param transform_id: A transform identifier or a wildcard expression. If you
2372
2977
  do not specify one of these options, the API returns information for all