elasticsearch 8.17.0__py3-none-any.whl → 8.17.2__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 (95) hide show
  1. elasticsearch/__init__.py +2 -2
  2. elasticsearch/_async/client/__init__.py +2034 -740
  3. elasticsearch/_async/client/async_search.py +33 -22
  4. elasticsearch/_async/client/autoscaling.py +27 -21
  5. elasticsearch/_async/client/cat.py +280 -336
  6. elasticsearch/_async/client/ccr.py +96 -70
  7. elasticsearch/_async/client/cluster.py +152 -144
  8. elasticsearch/_async/client/connector.py +488 -55
  9. elasticsearch/_async/client/dangling_indices.py +22 -16
  10. elasticsearch/_async/client/enrich.py +25 -6
  11. elasticsearch/_async/client/eql.py +22 -9
  12. elasticsearch/_async/client/esql.py +295 -3
  13. elasticsearch/_async/client/features.py +25 -25
  14. elasticsearch/_async/client/fleet.py +15 -9
  15. elasticsearch/_async/client/graph.py +9 -8
  16. elasticsearch/_async/client/ilm.py +91 -61
  17. elasticsearch/_async/client/indices.py +746 -324
  18. elasticsearch/_async/client/inference.py +101 -4
  19. elasticsearch/_async/client/ingest.py +231 -19
  20. elasticsearch/_async/client/license.py +48 -31
  21. elasticsearch/_async/client/logstash.py +20 -6
  22. elasticsearch/_async/client/migration.py +25 -7
  23. elasticsearch/_async/client/ml.py +532 -278
  24. elasticsearch/_async/client/monitoring.py +5 -1
  25. elasticsearch/_async/client/nodes.py +46 -30
  26. elasticsearch/_async/client/query_rules.py +65 -18
  27. elasticsearch/_async/client/rollup.py +126 -13
  28. elasticsearch/_async/client/search_application.py +170 -13
  29. elasticsearch/_async/client/searchable_snapshots.py +45 -23
  30. elasticsearch/_async/client/security.py +1299 -340
  31. elasticsearch/_async/client/shutdown.py +43 -15
  32. elasticsearch/_async/client/simulate.py +145 -0
  33. elasticsearch/_async/client/slm.py +163 -19
  34. elasticsearch/_async/client/snapshot.py +288 -23
  35. elasticsearch/_async/client/sql.py +94 -53
  36. elasticsearch/_async/client/ssl.py +16 -17
  37. elasticsearch/_async/client/synonyms.py +67 -26
  38. elasticsearch/_async/client/tasks.py +103 -28
  39. elasticsearch/_async/client/text_structure.py +475 -46
  40. elasticsearch/_async/client/transform.py +108 -72
  41. elasticsearch/_async/client/watcher.py +245 -43
  42. elasticsearch/_async/client/xpack.py +20 -6
  43. elasticsearch/_async/helpers.py +1 -1
  44. elasticsearch/_sync/client/__init__.py +2034 -740
  45. elasticsearch/_sync/client/async_search.py +33 -22
  46. elasticsearch/_sync/client/autoscaling.py +27 -21
  47. elasticsearch/_sync/client/cat.py +280 -336
  48. elasticsearch/_sync/client/ccr.py +96 -70
  49. elasticsearch/_sync/client/cluster.py +152 -144
  50. elasticsearch/_sync/client/connector.py +488 -55
  51. elasticsearch/_sync/client/dangling_indices.py +22 -16
  52. elasticsearch/_sync/client/enrich.py +25 -6
  53. elasticsearch/_sync/client/eql.py +22 -9
  54. elasticsearch/_sync/client/esql.py +295 -3
  55. elasticsearch/_sync/client/features.py +25 -25
  56. elasticsearch/_sync/client/fleet.py +15 -9
  57. elasticsearch/_sync/client/graph.py +9 -8
  58. elasticsearch/_sync/client/ilm.py +91 -61
  59. elasticsearch/_sync/client/indices.py +746 -324
  60. elasticsearch/_sync/client/inference.py +101 -4
  61. elasticsearch/_sync/client/ingest.py +231 -19
  62. elasticsearch/_sync/client/license.py +48 -31
  63. elasticsearch/_sync/client/logstash.py +20 -6
  64. elasticsearch/_sync/client/migration.py +25 -7
  65. elasticsearch/_sync/client/ml.py +532 -278
  66. elasticsearch/_sync/client/monitoring.py +5 -1
  67. elasticsearch/_sync/client/nodes.py +46 -30
  68. elasticsearch/_sync/client/query_rules.py +65 -18
  69. elasticsearch/_sync/client/rollup.py +126 -13
  70. elasticsearch/_sync/client/search_application.py +170 -13
  71. elasticsearch/_sync/client/searchable_snapshots.py +45 -23
  72. elasticsearch/_sync/client/security.py +1299 -340
  73. elasticsearch/_sync/client/shutdown.py +43 -15
  74. elasticsearch/_sync/client/simulate.py +145 -0
  75. elasticsearch/_sync/client/slm.py +163 -19
  76. elasticsearch/_sync/client/snapshot.py +288 -23
  77. elasticsearch/_sync/client/sql.py +94 -53
  78. elasticsearch/_sync/client/ssl.py +16 -17
  79. elasticsearch/_sync/client/synonyms.py +67 -26
  80. elasticsearch/_sync/client/tasks.py +103 -28
  81. elasticsearch/_sync/client/text_structure.py +475 -46
  82. elasticsearch/_sync/client/transform.py +108 -72
  83. elasticsearch/_sync/client/utils.py +1 -1
  84. elasticsearch/_sync/client/watcher.py +245 -43
  85. elasticsearch/_sync/client/xpack.py +20 -6
  86. elasticsearch/_version.py +1 -1
  87. elasticsearch/client.py +4 -0
  88. elasticsearch/helpers/actions.py +1 -1
  89. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
  90. {elasticsearch-8.17.0.dist-info → elasticsearch-8.17.2.dist-info}/METADATA +1 -1
  91. elasticsearch-8.17.2.dist-info/RECORD +119 -0
  92. elasticsearch-8.17.0.dist-info/RECORD +0 -117
  93. {elasticsearch-8.17.0.dist-info → elasticsearch-8.17.2.dist-info}/WHEEL +0 -0
  94. {elasticsearch-8.17.0.dist-info → elasticsearch-8.17.2.dist-info}/licenses/LICENSE +0 -0
  95. {elasticsearch-8.17.0.dist-info → elasticsearch-8.17.2.dist-info}/licenses/NOTICE +0 -0
@@ -57,18 +57,22 @@ class CatClient(NamespacedClient):
57
57
  v: t.Optional[bool] = None,
58
58
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
59
59
  """
60
- Get aliases. Retrieves the cluster’s index aliases, including filter and routing
61
- information. The API does not return data stream aliases. CAT APIs are only intended
62
- for human consumption using the command line or the Kibana console. They are
63
- not intended for use by applications. For application consumption, use the aliases
64
- API.
60
+ .. raw:: html
61
+
62
+ <p>Get aliases.</p>
63
+ <p>Get the cluster's index aliases, including filter and routing information.
64
+ This API does not return data stream aliases.</p>
65
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.</p>
66
+
65
67
 
66
68
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-alias.html>`_
67
69
 
68
70
  :param name: A comma-separated list of aliases to retrieve. Supports wildcards
69
71
  (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
70
- :param expand_wildcards: Whether to expand wildcard expression to concrete indices
71
- that are open, closed or both.
72
+ :param expand_wildcards: The type of index that wildcard patterns can match.
73
+ If the request can target data streams, this argument determines whether
74
+ wildcard expressions match hidden data streams. It supports comma-separated
75
+ values, such as `open,hidden`.
72
76
  :param format: Specifies the format to return the columnar data in, can be set
73
77
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
74
78
  :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -78,7 +82,10 @@ class CatClient(NamespacedClient):
78
82
  the local cluster state. If `false` the list of selected nodes are computed
79
83
  from the cluster state of the master node. In both cases the coordinating
80
84
  node will send requests for further information to each selected node.
81
- :param master_timeout: Period to wait for a connection to the master node.
85
+ :param master_timeout: The period to wait for a connection to the master node.
86
+ If the master node is not available before the timeout expires, the request
87
+ fails and returns an error. To indicated that the request should never timeout,
88
+ you can set it to `-1`.
82
89
  :param s: List of columns that determine how the table should be sorted. Sorting
83
90
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
84
91
  a suffix to the column name.
@@ -147,13 +154,16 @@ class CatClient(NamespacedClient):
147
154
  v: t.Optional[bool] = None,
148
155
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
149
156
  """
150
- Provides a snapshot of the number of shards allocated to each data node and their
151
- disk space. IMPORTANT: cat APIs are only intended for human consumption using
152
- the command line or Kibana console. They are not intended for use by applications.
157
+ .. raw:: html
158
+
159
+ <p>Get shard allocation information.</p>
160
+ <p>Get a snapshot of the number of shards allocated to each data node and their disk space.</p>
161
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.</p>
162
+
153
163
 
154
164
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-allocation.html>`_
155
165
 
156
- :param node_id: Comma-separated list of node identifiers or names used to limit
166
+ :param node_id: A comma-separated list of node identifiers or names used to limit
157
167
  the returned information.
158
168
  :param bytes: The unit used to display byte values.
159
169
  :param format: Specifies the format to return the columnar data in, can be set
@@ -231,17 +241,19 @@ class CatClient(NamespacedClient):
231
241
  v: t.Optional[bool] = None,
232
242
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
233
243
  """
234
- Get component templates. Returns information about component templates in a cluster.
235
- Component templates are building blocks for constructing index templates that
236
- specify index mappings, settings, and aliases. CAT APIs are only intended for
237
- human consumption using the command line or Kibana console. They are not intended
238
- for use by applications. For application consumption, use the get component template
239
- API.
244
+ .. raw:: html
245
+
246
+ <p>Get component templates.</p>
247
+ <p>Get information about component templates in a cluster.
248
+ Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
249
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.
250
+ They are not intended for use by applications. For application consumption, use the get component template API.</p>
251
+
240
252
 
241
253
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-component-templates.html>`_
242
254
 
243
- :param name: The name of the component template. Accepts wildcard expressions.
244
- If omitted, all component templates are returned.
255
+ :param name: The name of the component template. It accepts wildcard expressions.
256
+ If it is omitted, all component templates are returned.
245
257
  :param format: Specifies the format to return the columnar data in, can be set
246
258
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
247
259
  :param h: List of columns to appear in the response. Supports simple wildcards.
@@ -251,7 +263,7 @@ class CatClient(NamespacedClient):
251
263
  the local cluster state. If `false` the list of selected nodes are computed
252
264
  from the cluster state of the master node. In both cases the coordinating
253
265
  node will send requests for further information to each selected node.
254
- :param master_timeout: Period to wait for a connection to the master node.
266
+ :param master_timeout: The period to wait for a connection to the master node.
255
267
  :param s: List of columns that determine how the table should be sorted. Sorting
256
268
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
257
269
  a suffix to the column name.
@@ -308,35 +320,30 @@ class CatClient(NamespacedClient):
308
320
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
309
321
  help: t.Optional[bool] = None,
310
322
  human: t.Optional[bool] = None,
311
- local: t.Optional[bool] = None,
312
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
313
323
  pretty: t.Optional[bool] = None,
314
324
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
315
325
  v: t.Optional[bool] = None,
316
326
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
317
327
  """
318
- Get a document count. Provides quick access to a document count for a data stream,
319
- an index, or an entire cluster. The document count only includes live documents,
320
- not deleted documents which have not yet been removed by the merge process. CAT
321
- APIs are only intended for human consumption using the command line or Kibana
322
- console. They are not intended for use by applications. For application consumption,
323
- use the count API.
328
+ .. raw:: html
329
+
330
+ <p>Get a document count.</p>
331
+ <p>Get quick access to a document count for a data stream, an index, or an entire cluster.
332
+ The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.</p>
333
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.
334
+ They are not intended for use by applications. For application consumption, use the count API.</p>
335
+
324
336
 
325
337
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-count.html>`_
326
338
 
327
- :param index: Comma-separated list of data streams, indices, and aliases used
328
- to limit the request. Supports wildcards (`*`). To target all data streams
339
+ :param index: A comma-separated list of data streams, indices, and aliases used
340
+ to limit the request. It supports wildcards (`*`). To target all data streams
329
341
  and indices, omit this parameter or use `*` or `_all`.
330
342
  :param format: Specifies the format to return the columnar data in, can be set
331
343
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
332
344
  :param h: List of columns to appear in the response. Supports simple wildcards.
333
345
  :param help: When set to `true` will output available columns. This option can't
334
346
  be combined with any other query string option.
335
- :param local: If `true`, the request computes the list of selected nodes from
336
- the local cluster state. If `false` the list of selected nodes are computed
337
- from the cluster state of the master node. In both cases the coordinating
338
- node will send requests for further information to each selected node.
339
- :param master_timeout: Period to wait for a connection to the master node.
340
347
  :param s: List of columns that determine how the table should be sorted. Sorting
341
348
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
342
349
  a suffix to the column name.
@@ -362,10 +369,6 @@ class CatClient(NamespacedClient):
362
369
  __query["help"] = help
363
370
  if human is not None:
364
371
  __query["human"] = human
365
- if local is not None:
366
- __query["local"] = local
367
- if master_timeout is not None:
368
- __query["master_timeout"] = master_timeout
369
372
  if pretty is not None:
370
373
  __query["pretty"] = pretty
371
374
  if s is not None:
@@ -396,17 +399,18 @@ class CatClient(NamespacedClient):
396
399
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
397
400
  help: t.Optional[bool] = None,
398
401
  human: t.Optional[bool] = None,
399
- local: t.Optional[bool] = None,
400
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
401
402
  pretty: t.Optional[bool] = None,
402
403
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
403
404
  v: t.Optional[bool] = None,
404
405
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
405
406
  """
406
- Returns the amount of heap memory currently used by the field data cache on every
407
- data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption
408
- using the command line or Kibana console. They are not intended for use by applications.
409
- For application consumption, use the nodes stats API.
407
+ .. raw:: html
408
+
409
+ <p>Get field data cache information.</p>
410
+ <p>Get the amount of heap memory currently used by the field data cache on every data node in the cluster.</p>
411
+ <p>IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.
412
+ They are not intended for use by applications. For application consumption, use the nodes stats API.</p>
413
+
410
414
 
411
415
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-fielddata.html>`_
412
416
 
@@ -418,11 +422,6 @@ class CatClient(NamespacedClient):
418
422
  :param h: List of columns to appear in the response. Supports simple wildcards.
419
423
  :param help: When set to `true` will output available columns. This option can't
420
424
  be combined with any other query string option.
421
- :param local: If `true`, the request computes the list of selected nodes from
422
- the local cluster state. If `false` the list of selected nodes are computed
423
- from the cluster state of the master node. In both cases the coordinating
424
- node will send requests for further information to each selected node.
425
- :param master_timeout: Period to wait for a connection to the master node.
426
425
  :param s: List of columns that determine how the table should be sorted. Sorting
427
426
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
428
427
  a suffix to the column name.
@@ -450,10 +449,6 @@ class CatClient(NamespacedClient):
450
449
  __query["help"] = help
451
450
  if human is not None:
452
451
  __query["human"] = human
453
- if local is not None:
454
- __query["local"] = local
455
- if master_timeout is not None:
456
- __query["master_timeout"] = master_timeout
457
452
  if pretty is not None:
458
453
  __query["pretty"] = pretty
459
454
  if s is not None:
@@ -480,8 +475,6 @@ class CatClient(NamespacedClient):
480
475
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
481
476
  help: t.Optional[bool] = None,
482
477
  human: t.Optional[bool] = None,
483
- local: t.Optional[bool] = None,
484
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
485
478
  pretty: t.Optional[bool] = None,
486
479
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
487
480
  time: t.Optional[
@@ -491,17 +484,19 @@ class CatClient(NamespacedClient):
491
484
  v: t.Optional[bool] = None,
492
485
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
493
486
  """
494
- Returns the health status of a cluster, similar to the cluster health API. IMPORTANT:
495
- cat APIs are only intended for human consumption using the command line or Kibana
496
- console. They are not intended for use by applications. For application consumption,
497
- use the cluster health API. This API is often used to check malfunctioning clusters.
498
- To help you track cluster health alongside log files and alerting systems, the
499
- API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but
500
- includes no date information; `Unix epoch time`, which is machine-sortable and
501
- includes date information. The latter format is useful for cluster recoveries
502
- that take multiple days. You can use the cat health API to verify cluster health
503
- across multiple nodes. You also can use the API to track the recovery of a large
504
- cluster over a longer period of time.
487
+ .. raw:: html
488
+
489
+ <p>Get the cluster health status.</p>
490
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.
491
+ They are not intended for use by applications. For application consumption, use the cluster health API.
492
+ This API is often used to check malfunctioning clusters.
493
+ To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:
494
+ <code>HH:MM:SS</code>, which is human-readable but includes no date information;
495
+ <code>Unix epoch time</code>, which is machine-sortable and includes date information.
496
+ The latter format is useful for cluster recoveries that take multiple days.
497
+ You can use the cat health API to verify cluster health across multiple nodes.
498
+ You also can use the API to track the recovery of a large cluster over a longer period of time.</p>
499
+
505
500
 
506
501
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-health.html>`_
507
502
 
@@ -510,11 +505,6 @@ class CatClient(NamespacedClient):
510
505
  :param h: List of columns to appear in the response. Supports simple wildcards.
511
506
  :param help: When set to `true` will output available columns. This option can't
512
507
  be combined with any other query string option.
513
- :param local: If `true`, the request computes the list of selected nodes from
514
- the local cluster state. If `false` the list of selected nodes are computed
515
- from the cluster state of the master node. In both cases the coordinating
516
- node will send requests for further information to each selected node.
517
- :param master_timeout: Period to wait for a connection to the master node.
518
508
  :param s: List of columns that determine how the table should be sorted. Sorting
519
509
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
520
510
  a suffix to the column name.
@@ -537,10 +527,6 @@ class CatClient(NamespacedClient):
537
527
  __query["help"] = help
538
528
  if human is not None:
539
529
  __query["human"] = human
540
- if local is not None:
541
- __query["local"] = local
542
- if master_timeout is not None:
543
- __query["master_timeout"] = master_timeout
544
530
  if pretty is not None:
545
531
  __query["pretty"] = pretty
546
532
  if s is not None:
@@ -562,66 +548,19 @@ class CatClient(NamespacedClient):
562
548
  )
563
549
 
564
550
  @_rewrite_parameters()
565
- async def help(
566
- self,
567
- *,
568
- error_trace: t.Optional[bool] = None,
569
- filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
570
- format: t.Optional[str] = None,
571
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
572
- help: t.Optional[bool] = None,
573
- human: t.Optional[bool] = None,
574
- local: t.Optional[bool] = None,
575
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
576
- pretty: t.Optional[bool] = None,
577
- s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
578
- v: t.Optional[bool] = None,
579
- ) -> TextApiResponse:
551
+ async def help(self) -> TextApiResponse:
580
552
  """
581
- Get CAT help. Returns help for the CAT APIs.
553
+ .. raw:: html
582
554
 
583
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat.html>`_
555
+ <p>Get CAT help.</p>
556
+ <p>Get help for the CAT APIs.</p>
584
557
 
585
- :param format: Specifies the format to return the columnar data in, can be set
586
- to `text`, `json`, `cbor`, `yaml`, or `smile`.
587
- :param h: List of columns to appear in the response. Supports simple wildcards.
588
- :param help: When set to `true` will output available columns. This option can't
589
- be combined with any other query string option.
590
- :param local: If `true`, the request computes the list of selected nodes from
591
- the local cluster state. If `false` the list of selected nodes are computed
592
- from the cluster state of the master node. In both cases the coordinating
593
- node will send requests for further information to each selected node.
594
- :param master_timeout: Period to wait for a connection to the master node.
595
- :param s: List of columns that determine how the table should be sorted. Sorting
596
- defaults to ascending and can be changed by setting `:asc` or `:desc` as
597
- a suffix to the column name.
598
- :param v: When set to `true` will enable verbose output.
558
+
559
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat.html>`_
599
560
  """
600
561
  __path_parts: t.Dict[str, str] = {}
601
562
  __path = "/_cat"
602
563
  __query: t.Dict[str, t.Any] = {}
603
- if error_trace is not None:
604
- __query["error_trace"] = error_trace
605
- if filter_path is not None:
606
- __query["filter_path"] = filter_path
607
- if format is not None:
608
- __query["format"] = format
609
- if h is not None:
610
- __query["h"] = h
611
- if help is not None:
612
- __query["help"] = help
613
- if human is not None:
614
- __query["human"] = human
615
- if local is not None:
616
- __query["local"] = local
617
- if master_timeout is not None:
618
- __query["master_timeout"] = master_timeout
619
- if pretty is not None:
620
- __query["pretty"] = pretty
621
- if s is not None:
622
- __query["s"] = s
623
- if v is not None:
624
- __query["v"] = v
625
564
  __headers = {"accept": "text/plain"}
626
565
  return await self.perform_request( # type: ignore[return-value]
627
566
  "GET",
@@ -656,7 +595,6 @@ class CatClient(NamespacedClient):
656
595
  help: t.Optional[bool] = None,
657
596
  human: t.Optional[bool] = None,
658
597
  include_unloaded_segments: t.Optional[bool] = None,
659
- local: t.Optional[bool] = None,
660
598
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
661
599
  pretty: t.Optional[bool] = None,
662
600
  pri: t.Optional[bool] = None,
@@ -667,16 +605,23 @@ class CatClient(NamespacedClient):
667
605
  v: t.Optional[bool] = None,
668
606
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
669
607
  """
670
- Get index information. Returns high-level information about indices in a cluster,
671
- including backing indices for data streams. Use this request to get the following
672
- information for each index in a cluster: - shard count - document count - deleted
673
- document count - primary store size - total store size of all shards, including
674
- shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch
675
- uses internally to power indexing and search. As a result, all document counts
676
- include hidden nested documents. To get an accurate count of Elasticsearch documents,
677
- use the cat count or count APIs. CAT APIs are only intended for human consumption
678
- using the command line or Kibana console. They are not intended for use by applications.
679
- For application consumption, use an index endpoint.
608
+ .. raw:: html
609
+
610
+ <p>Get index information.</p>
611
+ <p>Get high-level information about indices in a cluster, including backing indices for data streams.</p>
612
+ <p>Use this request to get the following information for each index in a cluster:</p>
613
+ <ul>
614
+ <li>shard count</li>
615
+ <li>document count</li>
616
+ <li>deleted document count</li>
617
+ <li>primary store size</li>
618
+ <li>total store size of all shards, including shard replicas</li>
619
+ </ul>
620
+ <p>These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.
621
+ To get an accurate count of Elasticsearch documents, use the cat count or count APIs.</p>
622
+ <p>CAT APIs are only intended for human consumption using the command line or Kibana console.
623
+ They are not intended for use by applications. For application consumption, use an index endpoint.</p>
624
+
680
625
 
681
626
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-indices.html>`_
682
627
 
@@ -694,10 +639,6 @@ class CatClient(NamespacedClient):
694
639
  be combined with any other query string option.
695
640
  :param include_unloaded_segments: If true, the response includes information
696
641
  from segments that are not loaded into memory.
697
- :param local: If `true`, the request computes the list of selected nodes from
698
- the local cluster state. If `false` the list of selected nodes are computed
699
- from the cluster state of the master node. In both cases the coordinating
700
- node will send requests for further information to each selected node.
701
642
  :param master_timeout: Period to wait for a connection to the master node.
702
643
  :param pri: If true, the response only includes information from primary shards.
703
644
  :param s: List of columns that determine how the table should be sorted. Sorting
@@ -734,8 +675,6 @@ class CatClient(NamespacedClient):
734
675
  __query["human"] = human
735
676
  if include_unloaded_segments is not None:
736
677
  __query["include_unloaded_segments"] = include_unloaded_segments
737
- if local is not None:
738
- __query["local"] = local
739
678
  if master_timeout is not None:
740
679
  __query["master_timeout"] = master_timeout
741
680
  if pretty is not None:
@@ -775,10 +714,12 @@ class CatClient(NamespacedClient):
775
714
  v: t.Optional[bool] = None,
776
715
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
777
716
  """
778
- Returns information about the master node, including the ID, bound IP address,
779
- and name. IMPORTANT: cat APIs are only intended for human consumption using the
780
- command line or Kibana console. They are not intended for use by applications.
781
- For application consumption, use the nodes info API.
717
+ .. raw:: html
718
+
719
+ <p>Get master node information.</p>
720
+ <p>Get information about the master node, including the ID, bound IP address, and name.</p>
721
+ <p>IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
722
+
782
723
 
783
724
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-master.html>`_
784
725
 
@@ -894,8 +835,6 @@ class CatClient(NamespacedClient):
894
835
  ] = None,
895
836
  help: t.Optional[bool] = None,
896
837
  human: t.Optional[bool] = None,
897
- local: t.Optional[bool] = None,
898
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
899
838
  pretty: t.Optional[bool] = None,
900
839
  s: t.Optional[
901
840
  t.Union[
@@ -945,15 +884,20 @@ class CatClient(NamespacedClient):
945
884
  ],
946
885
  ]
947
886
  ] = None,
948
- time: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
887
+ time: t.Optional[
888
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
889
+ ] = None,
949
890
  v: t.Optional[bool] = None,
950
891
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
951
892
  """
952
- Get data frame analytics jobs. Returns configuration and usage information about
953
- data frame analytics jobs. CAT APIs are only intended for human consumption using
954
- the Kibana console or command line. They are not intended for use by applications.
955
- For application consumption, use the get data frame analytics jobs statistics
956
- API.
893
+ .. raw:: html
894
+
895
+ <p>Get data frame analytics jobs.</p>
896
+ <p>Get configuration and usage information about data frame analytics jobs.</p>
897
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
898
+ console or command line. They are not intended for use by applications. For
899
+ application consumption, use the get data frame analytics jobs statistics API.</p>
900
+
957
901
 
958
902
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-dfanalytics.html>`_
959
903
 
@@ -966,11 +910,6 @@ class CatClient(NamespacedClient):
966
910
  :param h: Comma-separated list of column names to display.
967
911
  :param help: When set to `true` will output available columns. This option can't
968
912
  be combined with any other query string option.
969
- :param local: If `true`, the request computes the list of selected nodes from
970
- the local cluster state. If `false` the list of selected nodes are computed
971
- from the cluster state of the master node. In both cases the coordinating
972
- node will send requests for further information to each selected node.
973
- :param master_timeout: Period to wait for a connection to the master node.
974
913
  :param s: Comma-separated list of column names or column aliases used to sort
975
914
  the response.
976
915
  :param time: Unit used to display time values.
@@ -1000,10 +939,6 @@ class CatClient(NamespacedClient):
1000
939
  __query["help"] = help
1001
940
  if human is not None:
1002
941
  __query["human"] = human
1003
- if local is not None:
1004
- __query["local"] = local
1005
- if master_timeout is not None:
1006
- __query["master_timeout"] = master_timeout
1007
942
  if pretty is not None:
1008
943
  __query["pretty"] = pretty
1009
944
  if s is not None:
@@ -1073,8 +1008,6 @@ class CatClient(NamespacedClient):
1073
1008
  ] = None,
1074
1009
  help: t.Optional[bool] = None,
1075
1010
  human: t.Optional[bool] = None,
1076
- local: t.Optional[bool] = None,
1077
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1078
1011
  pretty: t.Optional[bool] = None,
1079
1012
  s: t.Optional[
1080
1013
  t.Union[
@@ -1122,12 +1055,17 @@ class CatClient(NamespacedClient):
1122
1055
  v: t.Optional[bool] = None,
1123
1056
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1124
1057
  """
1125
- Get datafeeds. Returns configuration and usage information about datafeeds. This
1126
- API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features
1127
- are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
1128
- cluster privileges to use this API. CAT APIs are only intended for human consumption
1129
- using the Kibana console or command line. They are not intended for use by applications.
1130
- For application consumption, use the get datafeed statistics API.
1058
+ .. raw:: html
1059
+
1060
+ <p>Get datafeeds.</p>
1061
+ <p>Get configuration and usage information about datafeeds.
1062
+ This API returns a maximum of 10,000 datafeeds.
1063
+ If the Elasticsearch security features are enabled, you must have <code>monitor_ml</code>, <code>monitor</code>, <code>manage_ml</code>, or <code>manage</code>
1064
+ cluster privileges to use this API.</p>
1065
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
1066
+ console or command line. They are not intended for use by applications. For
1067
+ application consumption, use the get datafeed statistics API.</p>
1068
+
1131
1069
 
1132
1070
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-datafeeds.html>`_
1133
1071
 
@@ -1145,11 +1083,6 @@ class CatClient(NamespacedClient):
1145
1083
  :param h: Comma-separated list of column names to display.
1146
1084
  :param help: When set to `true` will output available columns. This option can't
1147
1085
  be combined with any other query string option.
1148
- :param local: If `true`, the request computes the list of selected nodes from
1149
- the local cluster state. If `false` the list of selected nodes are computed
1150
- from the cluster state of the master node. In both cases the coordinating
1151
- node will send requests for further information to each selected node.
1152
- :param master_timeout: Period to wait for a connection to the master node.
1153
1086
  :param s: Comma-separated list of column names or column aliases used to sort
1154
1087
  the response.
1155
1088
  :param time: The unit used to display time values.
@@ -1177,10 +1110,6 @@ class CatClient(NamespacedClient):
1177
1110
  __query["help"] = help
1178
1111
  if human is not None:
1179
1112
  __query["human"] = human
1180
- if local is not None:
1181
- __query["local"] = local
1182
- if master_timeout is not None:
1183
- __query["master_timeout"] = master_timeout
1184
1113
  if pretty is not None:
1185
1114
  __query["pretty"] = pretty
1186
1115
  if s is not None:
@@ -1349,8 +1278,6 @@ class CatClient(NamespacedClient):
1349
1278
  ] = None,
1350
1279
  help: t.Optional[bool] = None,
1351
1280
  human: t.Optional[bool] = None,
1352
- local: t.Optional[bool] = None,
1353
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1354
1281
  pretty: t.Optional[bool] = None,
1355
1282
  s: t.Optional[
1356
1283
  t.Union[
@@ -1494,13 +1421,17 @@ class CatClient(NamespacedClient):
1494
1421
  v: t.Optional[bool] = None,
1495
1422
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1496
1423
  """
1497
- Get anomaly detection jobs. Returns configuration and usage information for anomaly
1498
- detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch
1499
- security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`,
1500
- or `manage` cluster privileges to use this API. CAT APIs are only intended for
1501
- human consumption using the Kibana console or command line. They are not intended
1502
- for use by applications. For application consumption, use the get anomaly detection
1503
- job statistics API.
1424
+ .. raw:: html
1425
+
1426
+ <p>Get anomaly detection jobs.</p>
1427
+ <p>Get configuration and usage information for anomaly detection jobs.
1428
+ This API returns a maximum of 10,000 jobs.
1429
+ If the Elasticsearch security features are enabled, you must have <code>monitor_ml</code>,
1430
+ <code>monitor</code>, <code>manage_ml</code>, or <code>manage</code> cluster privileges to use this API.</p>
1431
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
1432
+ console or command line. They are not intended for use by applications. For
1433
+ application consumption, use the get anomaly detection job statistics API.</p>
1434
+
1504
1435
 
1505
1436
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-anomaly-detectors.html>`_
1506
1437
 
@@ -1518,11 +1449,6 @@ class CatClient(NamespacedClient):
1518
1449
  :param h: Comma-separated list of column names to display.
1519
1450
  :param help: When set to `true` will output available columns. This option can't
1520
1451
  be combined with any other query string option.
1521
- :param local: If `true`, the request computes the list of selected nodes from
1522
- the local cluster state. If `false` the list of selected nodes are computed
1523
- from the cluster state of the master node. In both cases the coordinating
1524
- node will send requests for further information to each selected node.
1525
- :param master_timeout: Period to wait for a connection to the master node.
1526
1452
  :param s: Comma-separated list of column names or column aliases used to sort
1527
1453
  the response.
1528
1454
  :param time: The unit used to display time values.
@@ -1552,10 +1478,6 @@ class CatClient(NamespacedClient):
1552
1478
  __query["help"] = help
1553
1479
  if human is not None:
1554
1480
  __query["human"] = human
1555
- if local is not None:
1556
- __query["local"] = local
1557
- if master_timeout is not None:
1558
- __query["master_timeout"] = master_timeout
1559
1481
  if pretty is not None:
1560
1482
  __query["pretty"] = pretty
1561
1483
  if s is not None:
@@ -1635,8 +1557,6 @@ class CatClient(NamespacedClient):
1635
1557
  ] = None,
1636
1558
  help: t.Optional[bool] = None,
1637
1559
  human: t.Optional[bool] = None,
1638
- local: t.Optional[bool] = None,
1639
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1640
1560
  pretty: t.Optional[bool] = None,
1641
1561
  s: t.Optional[
1642
1562
  t.Union[
@@ -1683,13 +1603,20 @@ class CatClient(NamespacedClient):
1683
1603
  ]
1684
1604
  ] = None,
1685
1605
  size: t.Optional[int] = None,
1606
+ time: t.Optional[
1607
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
1608
+ ] = None,
1686
1609
  v: t.Optional[bool] = None,
1687
1610
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1688
1611
  """
1689
- Get trained models. Returns configuration and usage information about inference
1690
- trained models. CAT APIs are only intended for human consumption using the Kibana
1691
- console or command line. They are not intended for use by applications. For application
1692
- consumption, use the get trained models statistics API.
1612
+ .. raw:: html
1613
+
1614
+ <p>Get trained models.</p>
1615
+ <p>Get configuration and usage information about inference trained models.</p>
1616
+ <p>IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
1617
+ console or command line. They are not intended for use by applications. For
1618
+ application consumption, use the get trained models statistics API.</p>
1619
+
1693
1620
 
1694
1621
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-trained-model.html>`_
1695
1622
 
@@ -1708,14 +1635,10 @@ class CatClient(NamespacedClient):
1708
1635
  :param h: A comma-separated list of column names to display.
1709
1636
  :param help: When set to `true` will output available columns. This option can't
1710
1637
  be combined with any other query string option.
1711
- :param local: If `true`, the request computes the list of selected nodes from
1712
- the local cluster state. If `false` the list of selected nodes are computed
1713
- from the cluster state of the master node. In both cases the coordinating
1714
- node will send requests for further information to each selected node.
1715
- :param master_timeout: Period to wait for a connection to the master node.
1716
1638
  :param s: A comma-separated list of column names or aliases used to sort the
1717
1639
  response.
1718
1640
  :param size: The maximum number of transforms to display.
1641
+ :param time: Unit used to display time values.
1719
1642
  :param v: When set to `true` will enable verbose output.
1720
1643
  """
1721
1644
  __path_parts: t.Dict[str, str]
@@ -1744,16 +1667,14 @@ class CatClient(NamespacedClient):
1744
1667
  __query["help"] = help
1745
1668
  if human is not None:
1746
1669
  __query["human"] = human
1747
- if local is not None:
1748
- __query["local"] = local
1749
- if master_timeout is not None:
1750
- __query["master_timeout"] = master_timeout
1751
1670
  if pretty is not None:
1752
1671
  __query["pretty"] = pretty
1753
1672
  if s is not None:
1754
1673
  __query["s"] = s
1755
1674
  if size is not None:
1756
1675
  __query["size"] = size
1676
+ if time is not None:
1677
+ __query["time"] = time
1757
1678
  if v is not None:
1758
1679
  __query["v"] = v
1759
1680
  __headers = {"accept": "text/plain,application/json"}
@@ -1783,10 +1704,12 @@ class CatClient(NamespacedClient):
1783
1704
  v: t.Optional[bool] = None,
1784
1705
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1785
1706
  """
1786
- Returns information about custom node attributes. IMPORTANT: cat APIs are only
1787
- intended for human consumption using the command line or Kibana console. They
1788
- are not intended for use by applications. For application consumption, use the
1789
- nodes info API.
1707
+ .. raw:: html
1708
+
1709
+ <p>Get node attribute information.</p>
1710
+ <p>Get information about custom node attributes.
1711
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
1712
+
1790
1713
 
1791
1714
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodeattrs.html>`_
1792
1715
 
@@ -1855,17 +1778,21 @@ class CatClient(NamespacedClient):
1855
1778
  help: t.Optional[bool] = None,
1856
1779
  human: t.Optional[bool] = None,
1857
1780
  include_unloaded_segments: t.Optional[bool] = None,
1858
- local: t.Optional[bool] = None,
1859
1781
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1860
1782
  pretty: t.Optional[bool] = None,
1861
1783
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1784
+ time: t.Optional[
1785
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
1786
+ ] = None,
1862
1787
  v: t.Optional[bool] = None,
1863
1788
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1864
1789
  """
1865
- Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only
1866
- intended for human consumption using the command line or Kibana console. They
1867
- are not intended for use by applications. For application consumption, use the
1868
- nodes info API.
1790
+ .. raw:: html
1791
+
1792
+ <p>Get node information.</p>
1793
+ <p>Get information about the nodes in a cluster.
1794
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
1795
+
1869
1796
 
1870
1797
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-nodes.html>`_
1871
1798
 
@@ -1879,14 +1806,11 @@ class CatClient(NamespacedClient):
1879
1806
  be combined with any other query string option.
1880
1807
  :param include_unloaded_segments: If true, the response includes information
1881
1808
  from segments that are not loaded into memory.
1882
- :param local: If `true`, the request computes the list of selected nodes from
1883
- the local cluster state. If `false` the list of selected nodes are computed
1884
- from the cluster state of the master node. In both cases the coordinating
1885
- node will send requests for further information to each selected node.
1886
1809
  :param master_timeout: Period to wait for a connection to the master node.
1887
1810
  :param s: List of columns that determine how the table should be sorted. Sorting
1888
1811
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
1889
1812
  a suffix to the column name.
1813
+ :param time: Unit used to display time values.
1890
1814
  :param v: When set to `true` will enable verbose output.
1891
1815
  """
1892
1816
  __path_parts: t.Dict[str, str] = {}
@@ -1910,14 +1834,14 @@ class CatClient(NamespacedClient):
1910
1834
  __query["human"] = human
1911
1835
  if include_unloaded_segments is not None:
1912
1836
  __query["include_unloaded_segments"] = include_unloaded_segments
1913
- if local is not None:
1914
- __query["local"] = local
1915
1837
  if master_timeout is not None:
1916
1838
  __query["master_timeout"] = master_timeout
1917
1839
  if pretty is not None:
1918
1840
  __query["pretty"] = pretty
1919
1841
  if s is not None:
1920
1842
  __query["s"] = s
1843
+ if time is not None:
1844
+ __query["time"] = time
1921
1845
  if v is not None:
1922
1846
  __query["v"] = v
1923
1847
  __headers = {"accept": "text/plain,application/json"}
@@ -1944,13 +1868,18 @@ class CatClient(NamespacedClient):
1944
1868
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1945
1869
  pretty: t.Optional[bool] = None,
1946
1870
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1871
+ time: t.Optional[
1872
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
1873
+ ] = None,
1947
1874
  v: t.Optional[bool] = None,
1948
1875
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1949
1876
  """
1950
- Returns cluster-level changes that have not yet been executed. IMPORTANT: cat
1951
- APIs are only intended for human consumption using the command line or Kibana
1952
- console. They are not intended for use by applications. For application consumption,
1953
- use the pending cluster tasks API.
1877
+ .. raw:: html
1878
+
1879
+ <p>Get pending task information.</p>
1880
+ <p>Get information about cluster-level changes that have not yet taken effect.
1881
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.</p>
1882
+
1954
1883
 
1955
1884
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-pending-tasks.html>`_
1956
1885
 
@@ -1967,6 +1896,7 @@ class CatClient(NamespacedClient):
1967
1896
  :param s: List of columns that determine how the table should be sorted. Sorting
1968
1897
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
1969
1898
  a suffix to the column name.
1899
+ :param time: Unit used to display time values.
1970
1900
  :param v: When set to `true` will enable verbose output.
1971
1901
  """
1972
1902
  __path_parts: t.Dict[str, str] = {}
@@ -1992,6 +1922,8 @@ class CatClient(NamespacedClient):
1992
1922
  __query["pretty"] = pretty
1993
1923
  if s is not None:
1994
1924
  __query["s"] = s
1925
+ if time is not None:
1926
+ __query["time"] = time
1995
1927
  if v is not None:
1996
1928
  __query["v"] = v
1997
1929
  __headers = {"accept": "text/plain,application/json"}
@@ -2014,6 +1946,7 @@ class CatClient(NamespacedClient):
2014
1946
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2015
1947
  help: t.Optional[bool] = None,
2016
1948
  human: t.Optional[bool] = None,
1949
+ include_bootstrap: t.Optional[bool] = None,
2017
1950
  local: t.Optional[bool] = None,
2018
1951
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2019
1952
  pretty: t.Optional[bool] = None,
@@ -2021,10 +1954,12 @@ class CatClient(NamespacedClient):
2021
1954
  v: t.Optional[bool] = None,
2022
1955
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2023
1956
  """
2024
- Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs
2025
- are only intended for human consumption using the command line or Kibana console.
2026
- They are not intended for use by applications. For application consumption, use
2027
- the nodes info API.
1957
+ .. raw:: html
1958
+
1959
+ <p>Get plugin information.</p>
1960
+ <p>Get a list of plugins running on each node of a cluster.
1961
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
1962
+
2028
1963
 
2029
1964
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-plugins.html>`_
2030
1965
 
@@ -2033,6 +1968,7 @@ class CatClient(NamespacedClient):
2033
1968
  :param h: List of columns to appear in the response. Supports simple wildcards.
2034
1969
  :param help: When set to `true` will output available columns. This option can't
2035
1970
  be combined with any other query string option.
1971
+ :param include_bootstrap: Include bootstrap plugins in the response
2036
1972
  :param local: If `true`, the request computes the list of selected nodes from
2037
1973
  the local cluster state. If `false` the list of selected nodes are computed
2038
1974
  from the cluster state of the master node. In both cases the coordinating
@@ -2058,6 +1994,8 @@ class CatClient(NamespacedClient):
2058
1994
  __query["help"] = help
2059
1995
  if human is not None:
2060
1996
  __query["human"] = human
1997
+ if include_bootstrap is not None:
1998
+ __query["include_bootstrap"] = include_bootstrap
2061
1999
  if local is not None:
2062
2000
  __query["local"] = local
2063
2001
  if master_timeout is not None:
@@ -2094,21 +2032,22 @@ class CatClient(NamespacedClient):
2094
2032
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2095
2033
  help: t.Optional[bool] = None,
2096
2034
  human: t.Optional[bool] = None,
2097
- local: t.Optional[bool] = None,
2098
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2099
2035
  pretty: t.Optional[bool] = None,
2100
2036
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2037
+ time: t.Optional[
2038
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
2039
+ ] = None,
2101
2040
  v: t.Optional[bool] = None,
2102
2041
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2103
2042
  """
2104
- Returns information about ongoing and completed shard recoveries. Shard recovery
2105
- is the process of initializing a shard copy, such as restoring a primary shard
2106
- from a snapshot or syncing a replica shard from a primary shard. When a shard
2107
- recovery completes, the recovered shard is available for search and indexing.
2108
- For data streams, the API returns information about the stream’s backing indices.
2109
- IMPORTANT: cat APIs are only intended for human consumption using the command
2110
- line or Kibana console. They are not intended for use by applications. For application
2111
- consumption, use the index recovery API.
2043
+ .. raw:: html
2044
+
2045
+ <p>Get shard recovery information.</p>
2046
+ <p>Get information about ongoing and completed shard recoveries.
2047
+ Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.
2048
+ For data streams, the API returns information about the stream’s backing indices.
2049
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.</p>
2050
+
2112
2051
 
2113
2052
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-recovery.html>`_
2114
2053
 
@@ -2124,14 +2063,10 @@ class CatClient(NamespacedClient):
2124
2063
  :param h: List of columns to appear in the response. Supports simple wildcards.
2125
2064
  :param help: When set to `true` will output available columns. This option can't
2126
2065
  be combined with any other query string option.
2127
- :param local: If `true`, the request computes the list of selected nodes from
2128
- the local cluster state. If `false` the list of selected nodes are computed
2129
- from the cluster state of the master node. In both cases the coordinating
2130
- node will send requests for further information to each selected node.
2131
- :param master_timeout: Period to wait for a connection to the master node.
2132
2066
  :param s: List of columns that determine how the table should be sorted. Sorting
2133
2067
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
2134
2068
  a suffix to the column name.
2069
+ :param time: Unit used to display time values.
2135
2070
  :param v: When set to `true` will enable verbose output.
2136
2071
  """
2137
2072
  __path_parts: t.Dict[str, str]
@@ -2160,14 +2095,12 @@ class CatClient(NamespacedClient):
2160
2095
  __query["help"] = help
2161
2096
  if human is not None:
2162
2097
  __query["human"] = human
2163
- if local is not None:
2164
- __query["local"] = local
2165
- if master_timeout is not None:
2166
- __query["master_timeout"] = master_timeout
2167
2098
  if pretty is not None:
2168
2099
  __query["pretty"] = pretty
2169
2100
  if s is not None:
2170
2101
  __query["s"] = s
2102
+ if time is not None:
2103
+ __query["time"] = time
2171
2104
  if v is not None:
2172
2105
  __query["v"] = v
2173
2106
  __headers = {"accept": "text/plain,application/json"}
@@ -2197,10 +2130,12 @@ class CatClient(NamespacedClient):
2197
2130
  v: t.Optional[bool] = None,
2198
2131
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2199
2132
  """
2200
- Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only
2201
- intended for human consumption using the command line or Kibana console. They
2202
- are not intended for use by applications. For application consumption, use the
2203
- get snapshot repository API.
2133
+ .. raw:: html
2134
+
2135
+ <p>Get snapshot repository information.</p>
2136
+ <p>Get a list of snapshot repositories for a cluster.
2137
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.</p>
2138
+
2204
2139
 
2205
2140
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-repositories.html>`_
2206
2141
 
@@ -2275,11 +2210,13 @@ class CatClient(NamespacedClient):
2275
2210
  v: t.Optional[bool] = None,
2276
2211
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2277
2212
  """
2278
- Returns low-level information about the Lucene segments in index shards. For
2279
- data streams, the API returns information about the backing indices. IMPORTANT:
2280
- cat APIs are only intended for human consumption using the command line or Kibana
2281
- console. They are not intended for use by applications. For application consumption,
2282
- use the index segments API.
2213
+ .. raw:: html
2214
+
2215
+ <p>Get segment information.</p>
2216
+ <p>Get low-level information about the Lucene segments in index shards.
2217
+ For data streams, the API returns information about the backing indices.
2218
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.</p>
2219
+
2283
2220
 
2284
2221
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-segments.html>`_
2285
2222
 
@@ -2358,17 +2295,22 @@ class CatClient(NamespacedClient):
2358
2295
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2359
2296
  help: t.Optional[bool] = None,
2360
2297
  human: t.Optional[bool] = None,
2361
- local: t.Optional[bool] = None,
2362
2298
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2363
2299
  pretty: t.Optional[bool] = None,
2364
2300
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2301
+ time: t.Optional[
2302
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
2303
+ ] = None,
2365
2304
  v: t.Optional[bool] = None,
2366
2305
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2367
2306
  """
2368
- Returns information about the shards in a cluster. For data streams, the API
2369
- returns information about the backing indices. IMPORTANT: cat APIs are only intended
2370
- for human consumption using the command line or Kibana console. They are not
2371
- intended for use by applications.
2307
+ .. raw:: html
2308
+
2309
+ <p>Get shard information.</p>
2310
+ <p>Get information about the shards in a cluster.
2311
+ For data streams, the API returns information about the backing indices.
2312
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.</p>
2313
+
2372
2314
 
2373
2315
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-shards.html>`_
2374
2316
 
@@ -2381,14 +2323,11 @@ class CatClient(NamespacedClient):
2381
2323
  :param h: List of columns to appear in the response. Supports simple wildcards.
2382
2324
  :param help: When set to `true` will output available columns. This option can't
2383
2325
  be combined with any other query string option.
2384
- :param local: If `true`, the request computes the list of selected nodes from
2385
- the local cluster state. If `false` the list of selected nodes are computed
2386
- from the cluster state of the master node. In both cases the coordinating
2387
- node will send requests for further information to each selected node.
2388
2326
  :param master_timeout: Period to wait for a connection to the master node.
2389
2327
  :param s: List of columns that determine how the table should be sorted. Sorting
2390
2328
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
2391
2329
  a suffix to the column name.
2330
+ :param time: Unit used to display time values.
2392
2331
  :param v: When set to `true` will enable verbose output.
2393
2332
  """
2394
2333
  __path_parts: t.Dict[str, str]
@@ -2413,14 +2352,14 @@ class CatClient(NamespacedClient):
2413
2352
  __query["help"] = help
2414
2353
  if human is not None:
2415
2354
  __query["human"] = human
2416
- if local is not None:
2417
- __query["local"] = local
2418
2355
  if master_timeout is not None:
2419
2356
  __query["master_timeout"] = master_timeout
2420
2357
  if pretty is not None:
2421
2358
  __query["pretty"] = pretty
2422
2359
  if s is not None:
2423
2360
  __query["s"] = s
2361
+ if time is not None:
2362
+ __query["time"] = time
2424
2363
  if v is not None:
2425
2364
  __query["v"] = v
2426
2365
  __headers = {"accept": "text/plain,application/json"}
@@ -2445,18 +2384,22 @@ class CatClient(NamespacedClient):
2445
2384
  help: t.Optional[bool] = None,
2446
2385
  human: t.Optional[bool] = None,
2447
2386
  ignore_unavailable: t.Optional[bool] = None,
2448
- local: t.Optional[bool] = None,
2449
2387
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2450
2388
  pretty: t.Optional[bool] = None,
2451
2389
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2390
+ time: t.Optional[
2391
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
2392
+ ] = None,
2452
2393
  v: t.Optional[bool] = None,
2453
2394
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2454
2395
  """
2455
- Returns information about the snapshots stored in one or more repositories. A
2456
- snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT:
2457
- cat APIs are only intended for human consumption using the command line or Kibana
2458
- console. They are not intended for use by applications. For application consumption,
2459
- use the get snapshot API.
2396
+ .. raw:: html
2397
+
2398
+ <p>Get snapshot information.</p>
2399
+ <p>Get information about the snapshots stored in one or more repositories.
2400
+ A snapshot is a backup of an index or running Elasticsearch cluster.
2401
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.</p>
2402
+
2460
2403
 
2461
2404
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-snapshots.html>`_
2462
2405
 
@@ -2470,14 +2413,11 @@ class CatClient(NamespacedClient):
2470
2413
  be combined with any other query string option.
2471
2414
  :param ignore_unavailable: If `true`, the response does not include information
2472
2415
  from unavailable snapshots.
2473
- :param local: If `true`, the request computes the list of selected nodes from
2474
- the local cluster state. If `false` the list of selected nodes are computed
2475
- from the cluster state of the master node. In both cases the coordinating
2476
- node will send requests for further information to each selected node.
2477
2416
  :param master_timeout: Period to wait for a connection to the master node.
2478
2417
  :param s: List of columns that determine how the table should be sorted. Sorting
2479
2418
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
2480
2419
  a suffix to the column name.
2420
+ :param time: Unit used to display time values.
2481
2421
  :param v: When set to `true` will enable verbose output.
2482
2422
  """
2483
2423
  __path_parts: t.Dict[str, str]
@@ -2502,14 +2442,14 @@ class CatClient(NamespacedClient):
2502
2442
  __query["human"] = human
2503
2443
  if ignore_unavailable is not None:
2504
2444
  __query["ignore_unavailable"] = ignore_unavailable
2505
- if local is not None:
2506
- __query["local"] = local
2507
2445
  if master_timeout is not None:
2508
2446
  __query["master_timeout"] = master_timeout
2509
2447
  if pretty is not None:
2510
2448
  __query["pretty"] = pretty
2511
2449
  if s is not None:
2512
2450
  __query["s"] = s
2451
+ if time is not None:
2452
+ __query["time"] = time
2513
2453
  if v is not None:
2514
2454
  __query["v"] = v
2515
2455
  __headers = {"accept": "text/plain,application/json"}
@@ -2535,19 +2475,24 @@ class CatClient(NamespacedClient):
2535
2475
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2536
2476
  help: t.Optional[bool] = None,
2537
2477
  human: t.Optional[bool] = None,
2538
- local: t.Optional[bool] = None,
2539
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2540
- node_id: t.Optional[t.Sequence[str]] = None,
2478
+ nodes: t.Optional[t.Sequence[str]] = None,
2541
2479
  parent_task_id: t.Optional[str] = None,
2542
2480
  pretty: t.Optional[bool] = None,
2543
2481
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2482
+ time: t.Optional[
2483
+ t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
2484
+ ] = None,
2485
+ timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2544
2486
  v: t.Optional[bool] = None,
2487
+ wait_for_completion: t.Optional[bool] = None,
2545
2488
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2546
2489
  """
2547
- Returns information about tasks currently executing in the cluster. IMPORTANT:
2548
- cat APIs are only intended for human consumption using the command line or Kibana
2549
- console. They are not intended for use by applications. For application consumption,
2550
- use the task management API.
2490
+ .. raw:: html
2491
+
2492
+ <p>Get task information.</p>
2493
+ <p>Get information about tasks currently running in the cluster.
2494
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.</p>
2495
+
2551
2496
 
2552
2497
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
2553
2498
 
@@ -2559,18 +2504,18 @@ class CatClient(NamespacedClient):
2559
2504
  :param h: List of columns to appear in the response. Supports simple wildcards.
2560
2505
  :param help: When set to `true` will output available columns. This option can't
2561
2506
  be combined with any other query string option.
2562
- :param local: If `true`, the request computes the list of selected nodes from
2563
- the local cluster state. If `false` the list of selected nodes are computed
2564
- from the cluster state of the master node. In both cases the coordinating
2565
- node will send requests for further information to each selected node.
2566
- :param master_timeout: Period to wait for a connection to the master node.
2567
- :param node_id: Unique node identifiers, which are used to limit the response.
2507
+ :param nodes: Unique node identifiers, which are used to limit the response.
2568
2508
  :param parent_task_id: The parent task identifier, which is used to limit the
2569
2509
  response.
2570
2510
  :param s: List of columns that determine how the table should be sorted. Sorting
2571
2511
  defaults to ascending and can be changed by setting `:asc` or `:desc` as
2572
2512
  a suffix to the column name.
2513
+ :param time: Unit used to display time values.
2514
+ :param timeout: Period to wait for a response. If no response is received before
2515
+ the timeout expires, the request fails and returns an error.
2573
2516
  :param v: When set to `true` will enable verbose output.
2517
+ :param wait_for_completion: If `true`, the request blocks until the task has
2518
+ completed.
2574
2519
  """
2575
2520
  __path_parts: t.Dict[str, str] = {}
2576
2521
  __path = "/_cat/tasks"
@@ -2591,20 +2536,22 @@ class CatClient(NamespacedClient):
2591
2536
  __query["help"] = help
2592
2537
  if human is not None:
2593
2538
  __query["human"] = human
2594
- if local is not None:
2595
- __query["local"] = local
2596
- if master_timeout is not None:
2597
- __query["master_timeout"] = master_timeout
2598
- if node_id is not None:
2599
- __query["node_id"] = node_id
2539
+ if nodes is not None:
2540
+ __query["nodes"] = nodes
2600
2541
  if parent_task_id is not None:
2601
2542
  __query["parent_task_id"] = parent_task_id
2602
2543
  if pretty is not None:
2603
2544
  __query["pretty"] = pretty
2604
2545
  if s is not None:
2605
2546
  __query["s"] = s
2547
+ if time is not None:
2548
+ __query["time"] = time
2549
+ if timeout is not None:
2550
+ __query["timeout"] = timeout
2606
2551
  if v is not None:
2607
2552
  __query["v"] = v
2553
+ if wait_for_completion is not None:
2554
+ __query["wait_for_completion"] = wait_for_completion
2608
2555
  __headers = {"accept": "text/plain,application/json"}
2609
2556
  return await self.perform_request( # type: ignore[return-value]
2610
2557
  "GET",
@@ -2633,11 +2580,13 @@ class CatClient(NamespacedClient):
2633
2580
  v: t.Optional[bool] = None,
2634
2581
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2635
2582
  """
2636
- Returns information about index templates in a cluster. You can use index templates
2637
- to apply index settings and field mappings to new indices at creation. IMPORTANT:
2638
- cat APIs are only intended for human consumption using the command line or Kibana
2639
- console. They are not intended for use by applications. For application consumption,
2640
- use the get index template API.
2583
+ .. raw:: html
2584
+
2585
+ <p>Get index template information.</p>
2586
+ <p>Get information about the index templates in a cluster.
2587
+ You can use index templates to apply index settings and field mappings to new indices at creation.
2588
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.</p>
2589
+
2641
2590
 
2642
2591
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-templates.html>`_
2643
2592
 
@@ -2719,11 +2668,13 @@ class CatClient(NamespacedClient):
2719
2668
  v: t.Optional[bool] = None,
2720
2669
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2721
2670
  """
2722
- Returns thread pool statistics for each node in a cluster. Returned information
2723
- includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs
2724
- are only intended for human consumption using the command line or Kibana console.
2725
- They are not intended for use by applications. For application consumption, use
2726
- the nodes info API.
2671
+ .. raw:: html
2672
+
2673
+ <p>Get thread pool statistics.</p>
2674
+ <p>Get thread pool statistics for each node in a cluster.
2675
+ Returned information includes all built-in thread pools and custom thread pools.
2676
+ IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
2677
+
2727
2678
 
2728
2679
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-thread-pool.html>`_
2729
2680
 
@@ -2883,8 +2834,6 @@ class CatClient(NamespacedClient):
2883
2834
  ] = None,
2884
2835
  help: t.Optional[bool] = None,
2885
2836
  human: t.Optional[bool] = None,
2886
- local: t.Optional[bool] = None,
2887
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2888
2837
  pretty: t.Optional[bool] = None,
2889
2838
  s: t.Optional[
2890
2839
  t.Union[
@@ -2975,10 +2924,14 @@ class CatClient(NamespacedClient):
2975
2924
  v: t.Optional[bool] = None,
2976
2925
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2977
2926
  """
2978
- Get transforms. Returns configuration and usage information about transforms.
2979
- CAT APIs are only intended for human consumption using the Kibana console or
2980
- command line. They are not intended for use by applications. For application
2981
- consumption, use the get transform statistics API.
2927
+ .. raw:: html
2928
+
2929
+ <p>Get transform information.</p>
2930
+ <p>Get configuration and usage information about transforms.</p>
2931
+ <p>CAT APIs are only intended for human consumption using the Kibana
2932
+ console or command line. They are not intended for use by applications. For
2933
+ application consumption, use the get transform statistics API.</p>
2934
+
2982
2935
 
2983
2936
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-transforms.html>`_
2984
2937
 
@@ -2998,11 +2951,6 @@ class CatClient(NamespacedClient):
2998
2951
  :param h: Comma-separated list of column names to display.
2999
2952
  :param help: When set to `true` will output available columns. This option can't
3000
2953
  be combined with any other query string option.
3001
- :param local: If `true`, the request computes the list of selected nodes from
3002
- the local cluster state. If `false` the list of selected nodes are computed
3003
- from the cluster state of the master node. In both cases the coordinating
3004
- node will send requests for further information to each selected node.
3005
- :param master_timeout: Period to wait for a connection to the master node.
3006
2954
  :param s: Comma-separated list of column names or column aliases used to sort
3007
2955
  the response.
3008
2956
  :param size: The maximum number of transforms to obtain.
@@ -3033,10 +2981,6 @@ class CatClient(NamespacedClient):
3033
2981
  __query["help"] = help
3034
2982
  if human is not None:
3035
2983
  __query["human"] = human
3036
- if local is not None:
3037
- __query["local"] = local
3038
- if master_timeout is not None:
3039
- __query["master_timeout"] = master_timeout
3040
2984
  if pretty is not None:
3041
2985
  __query["pretty"] = pretty
3042
2986
  if s is not None: