elasticsearch 8.15.0__py3-none-any.whl → 8.16.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 (94) hide show
  1. elasticsearch/_async/client/__init__.py +202 -117
  2. elasticsearch/_async/client/async_search.py +25 -25
  3. elasticsearch/_async/client/autoscaling.py +24 -11
  4. elasticsearch/_async/client/cat.py +75 -66
  5. elasticsearch/_async/client/ccr.py +13 -13
  6. elasticsearch/_async/client/cluster.py +40 -37
  7. elasticsearch/_async/client/connector.py +112 -51
  8. elasticsearch/_async/client/dangling_indices.py +27 -12
  9. elasticsearch/_async/client/enrich.py +10 -10
  10. elasticsearch/_async/client/eql.py +4 -4
  11. elasticsearch/_async/client/esql.py +42 -4
  12. elasticsearch/_async/client/features.py +4 -3
  13. elasticsearch/_async/client/fleet.py +10 -2
  14. elasticsearch/_async/client/graph.py +1 -1
  15. elasticsearch/_async/client/ilm.py +16 -12
  16. elasticsearch/_async/client/indices.py +189 -108
  17. elasticsearch/_async/client/inference.py +15 -5
  18. elasticsearch/_async/client/ingest.py +200 -9
  19. elasticsearch/_async/client/license.py +10 -10
  20. elasticsearch/_async/client/logstash.py +3 -3
  21. elasticsearch/_async/client/migration.py +3 -3
  22. elasticsearch/_async/client/ml.py +294 -291
  23. elasticsearch/_async/client/monitoring.py +1 -1
  24. elasticsearch/_async/client/nodes.py +16 -8
  25. elasticsearch/_async/client/query_rules.py +61 -8
  26. elasticsearch/_async/client/rollup.py +23 -9
  27. elasticsearch/_async/client/search_application.py +35 -16
  28. elasticsearch/_async/client/searchable_snapshots.py +13 -5
  29. elasticsearch/_async/client/security.py +371 -180
  30. elasticsearch/_async/client/slm.py +9 -9
  31. elasticsearch/_async/client/snapshot.py +97 -12
  32. elasticsearch/_async/client/sql.py +11 -7
  33. elasticsearch/_async/client/ssl.py +18 -3
  34. elasticsearch/_async/client/synonyms.py +10 -8
  35. elasticsearch/_async/client/tasks.py +19 -9
  36. elasticsearch/_async/client/text_structure.py +2 -2
  37. elasticsearch/_async/client/transform.py +78 -72
  38. elasticsearch/_async/client/utils.py +4 -0
  39. elasticsearch/_async/client/watcher.py +11 -11
  40. elasticsearch/_async/client/xpack.py +5 -3
  41. elasticsearch/_async/helpers.py +19 -10
  42. elasticsearch/_otel.py +23 -1
  43. elasticsearch/_sync/client/__init__.py +202 -117
  44. elasticsearch/_sync/client/async_search.py +25 -25
  45. elasticsearch/_sync/client/autoscaling.py +24 -11
  46. elasticsearch/_sync/client/cat.py +75 -66
  47. elasticsearch/_sync/client/ccr.py +13 -13
  48. elasticsearch/_sync/client/cluster.py +40 -37
  49. elasticsearch/_sync/client/connector.py +112 -51
  50. elasticsearch/_sync/client/dangling_indices.py +27 -12
  51. elasticsearch/_sync/client/enrich.py +10 -10
  52. elasticsearch/_sync/client/eql.py +4 -4
  53. elasticsearch/_sync/client/esql.py +42 -4
  54. elasticsearch/_sync/client/features.py +4 -3
  55. elasticsearch/_sync/client/fleet.py +10 -2
  56. elasticsearch/_sync/client/graph.py +1 -1
  57. elasticsearch/_sync/client/ilm.py +16 -12
  58. elasticsearch/_sync/client/indices.py +189 -108
  59. elasticsearch/_sync/client/inference.py +15 -5
  60. elasticsearch/_sync/client/ingest.py +200 -9
  61. elasticsearch/_sync/client/license.py +10 -10
  62. elasticsearch/_sync/client/logstash.py +3 -3
  63. elasticsearch/_sync/client/migration.py +3 -3
  64. elasticsearch/_sync/client/ml.py +294 -291
  65. elasticsearch/_sync/client/monitoring.py +1 -1
  66. elasticsearch/_sync/client/nodes.py +16 -8
  67. elasticsearch/_sync/client/query_rules.py +61 -8
  68. elasticsearch/_sync/client/rollup.py +23 -9
  69. elasticsearch/_sync/client/search_application.py +35 -16
  70. elasticsearch/_sync/client/searchable_snapshots.py +13 -5
  71. elasticsearch/_sync/client/security.py +371 -180
  72. elasticsearch/_sync/client/slm.py +9 -9
  73. elasticsearch/_sync/client/snapshot.py +97 -12
  74. elasticsearch/_sync/client/sql.py +11 -7
  75. elasticsearch/_sync/client/ssl.py +18 -3
  76. elasticsearch/_sync/client/synonyms.py +10 -8
  77. elasticsearch/_sync/client/tasks.py +19 -9
  78. elasticsearch/_sync/client/text_structure.py +2 -2
  79. elasticsearch/_sync/client/transform.py +78 -72
  80. elasticsearch/_sync/client/utils.py +40 -0
  81. elasticsearch/_sync/client/watcher.py +11 -11
  82. elasticsearch/_sync/client/xpack.py +5 -3
  83. elasticsearch/_version.py +1 -1
  84. elasticsearch/exceptions.py +4 -0
  85. elasticsearch/helpers/actions.py +134 -111
  86. elasticsearch/helpers/errors.py +12 -4
  87. elasticsearch/helpers/vectorstore/_async/strategies.py +30 -9
  88. elasticsearch/helpers/vectorstore/_sync/strategies.py +30 -9
  89. {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/METADATA +6 -7
  90. elasticsearch-8.16.0.dist-info/RECORD +117 -0
  91. {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/WHEEL +1 -1
  92. elasticsearch-8.15.0.dist-info/RECORD +0 -117
  93. {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/licenses/LICENSE +0 -0
  94. {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/licenses/NOTICE +0 -0
@@ -36,13 +36,13 @@ class AsyncSearchClient(NamespacedClient):
36
36
  pretty: t.Optional[bool] = None,
37
37
  ) -> ObjectApiResponse[t.Any]:
38
38
  """
39
- Deletes an async search by identifier. If the search is still running, the search
40
- request will be cancelled. Otherwise, the saved search results are deleted. If
41
- the Elasticsearch security features are enabled, the deletion of a specific async
42
- search is restricted to: the authenticated user that submitted the original search
43
- request; users that have the `cancel_task` cluster privilege.
39
+ Delete an async search. If the asynchronous search is still running, it is cancelled.
40
+ Otherwise, the saved search results are deleted. If the Elasticsearch security
41
+ features are enabled, the deletion of a specific async search is restricted to:
42
+ the authenticated user that submitted the original search request; users that
43
+ have the `cancel_task` cluster privilege.
44
44
 
45
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/async-search.html>`_
45
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
46
46
 
47
47
  :param id: A unique identifier for the async search.
48
48
  """
@@ -85,12 +85,12 @@ class AsyncSearchClient(NamespacedClient):
85
85
  ] = None,
86
86
  ) -> ObjectApiResponse[t.Any]:
87
87
  """
88
- Retrieves the results of a previously submitted async search request given its
89
- identifier. If the Elasticsearch security features are enabled, access to the
90
- results of a specific async search is restricted to the user or API key that
88
+ Get async search results. Retrieve the results of a previously submitted asynchronous
89
+ search request. If the Elasticsearch security features are enabled, access to
90
+ the results of a specific async search is restricted to the user or API key that
91
91
  submitted it.
92
92
 
93
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/async-search.html>`_
93
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
94
94
 
95
95
  :param id: A unique identifier for the async search.
96
96
  :param keep_alive: Specifies how long the async search should be available in
@@ -148,12 +148,12 @@ class AsyncSearchClient(NamespacedClient):
148
148
  pretty: t.Optional[bool] = None,
149
149
  ) -> ObjectApiResponse[t.Any]:
150
150
  """
151
- Get async search status Retrieves the status of a previously submitted async
152
- search request given its identifier, without retrieving search results. If the
153
- Elasticsearch security features are enabled, use of this API is restricted to
154
- the `monitoring_user` role.
151
+ Get the async search status. Get the status of a previously submitted async search
152
+ request given its identifier, without retrieving search results. If the Elasticsearch
153
+ security features are enabled, use of this API is restricted to the `monitoring_user`
154
+ role.
155
155
 
156
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/async-search.html>`_
156
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
157
157
 
158
158
  :param id: A unique identifier for the async search.
159
159
  """
@@ -323,17 +323,17 @@ class AsyncSearchClient(NamespacedClient):
323
323
  body: t.Optional[t.Dict[str, t.Any]] = None,
324
324
  ) -> ObjectApiResponse[t.Any]:
325
325
  """
326
- Runs a search request asynchronously. When the primary sort of the results is
327
- an indexed field, shards get sorted based on minimum and maximum value that they
328
- hold for that field, hence partial results become available following the sort
329
- criteria that was requested. Warning: Async search does not support scroll nor
330
- search requests that only include the suggest section. By default, Elasticsearch
331
- doesn’t allow you to store an async search response larger than 10Mb and an attempt
332
- to do this results in an error. The maximum allowed size for a stored async search
333
- response can be set by changing the `search.max_async_search_response_size` cluster
334
- level setting.
326
+ Run an async search. When the primary sort of the results is an indexed field,
327
+ shards get sorted based on minimum and maximum value that they hold for that
328
+ field. Partial results become available following the sort criteria that was
329
+ requested. Warning: Asynchronous search does not support scroll or search requests
330
+ that include only the suggest section. By default, Elasticsearch does not allow
331
+ you to store an async search response larger than 10Mb and an attempt to do this
332
+ results in an error. The maximum allowed size for a stored async search response
333
+ can be set by changing the `search.max_async_search_response_size` cluster level
334
+ setting.
335
335
 
336
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/async-search.html>`_
336
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
337
337
 
338
338
  :param index: A comma-separated list of index names to search; use `_all` or
339
339
  empty string to perform the operation on all indices
@@ -36,10 +36,11 @@ class AutoscalingClient(NamespacedClient):
36
36
  pretty: t.Optional[bool] = None,
37
37
  ) -> ObjectApiResponse[t.Any]:
38
38
  """
39
- Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
39
+ Delete an autoscaling policy. NOTE: This feature is designed for indirect use
40
+ by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
40
41
  Direct use is not supported.
41
42
 
42
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/autoscaling-delete-autoscaling-policy.html>`_
43
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html>`_
43
44
 
44
45
  :param name: the name of the autoscaling policy
45
46
  """
@@ -76,10 +77,20 @@ class AutoscalingClient(NamespacedClient):
76
77
  pretty: t.Optional[bool] = None,
77
78
  ) -> ObjectApiResponse[t.Any]:
78
79
  """
79
- Gets the current autoscaling capacity based on the configured autoscaling policy.
80
- Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
81
-
82
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/autoscaling-get-autoscaling-capacity.html>`_
80
+ Get the autoscaling capacity. NOTE: This feature is designed for indirect use
81
+ by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
82
+ Direct use is not supported. This API gets the current autoscaling capacity based
83
+ on the configured autoscaling policy. It will return information to size the
84
+ cluster appropriately to the current workload. The `required_capacity` is calculated
85
+ as the maximum of the `required_capacity` result of all individual deciders that
86
+ are enabled for the policy. The operator should verify that the `current_nodes`
87
+ match the operator’s knowledge of the cluster to avoid making autoscaling decisions
88
+ based on stale or incomplete information. The response contains decider-specific
89
+ information you can use to diagnose how and why autoscaling determined a certain
90
+ capacity was required. This information is provided for diagnosis only. Do not
91
+ use this information to make autoscaling decisions.
92
+
93
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html>`_
83
94
  """
84
95
  __path_parts: t.Dict[str, str] = {}
85
96
  __path = "/_autoscaling/capacity"
@@ -113,10 +124,11 @@ class AutoscalingClient(NamespacedClient):
113
124
  pretty: t.Optional[bool] = None,
114
125
  ) -> ObjectApiResponse[t.Any]:
115
126
  """
116
- Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
127
+ Get an autoscaling policy. NOTE: This feature is designed for indirect use by
128
+ Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.
117
129
  Direct use is not supported.
118
130
 
119
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/autoscaling-get-autoscaling-capacity.html>`_
131
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html>`_
120
132
 
121
133
  :param name: the name of the autoscaling policy
122
134
  """
@@ -158,10 +170,11 @@ class AutoscalingClient(NamespacedClient):
158
170
  pretty: t.Optional[bool] = None,
159
171
  ) -> ObjectApiResponse[t.Any]:
160
172
  """
161
- Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
162
- Direct use is not supported.
173
+ Create or update an autoscaling policy. NOTE: This feature is designed for indirect
174
+ use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on
175
+ Kubernetes. Direct use is not supported.
163
176
 
164
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/autoscaling-put-autoscaling-policy.html>`_
177
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-put-autoscaling-policy.html>`_
165
178
 
166
179
  :param name: the name of the autoscaling policy
167
180
  :param policy:
@@ -20,7 +20,13 @@ import typing as t
20
20
  from elastic_transport import ObjectApiResponse, TextApiResponse
21
21
 
22
22
  from ._base import NamespacedClient
23
- from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23
+ from .utils import (
24
+ SKIP_IN_PATH,
25
+ Stability,
26
+ _quote,
27
+ _rewrite_parameters,
28
+ _stability_warning,
29
+ )
24
30
 
25
31
 
26
32
  class CatClient(NamespacedClient):
@@ -51,13 +57,13 @@ class CatClient(NamespacedClient):
51
57
  v: t.Optional[bool] = None,
52
58
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
53
59
  """
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
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
56
62
  for human consumption using the command line or the Kibana console. They are
57
63
  not intended for use by applications. For application consumption, use the aliases
58
64
  API.
59
65
 
60
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-alias.html>`_
66
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-alias.html>`_
61
67
 
62
68
  :param name: A comma-separated list of aliases to retrieve. Supports wildcards
63
69
  (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -145,7 +151,7 @@ class CatClient(NamespacedClient):
145
151
  disk space. IMPORTANT: cat APIs are only intended for human consumption using
146
152
  the command line or Kibana console. They are not intended for use by applications.
147
153
 
148
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-allocation.html>`_
154
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-allocation.html>`_
149
155
 
150
156
  :param node_id: Comma-separated list of node identifiers or names used to limit
151
157
  the returned information.
@@ -225,13 +231,14 @@ class CatClient(NamespacedClient):
225
231
  v: t.Optional[bool] = None,
226
232
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
227
233
  """
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.
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.
233
240
 
234
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-component-templates.html>`_
241
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-component-templates.html>`_
235
242
 
236
243
  :param name: The name of the component template. Accepts wildcard expressions.
237
244
  If omitted, all component templates are returned.
@@ -308,14 +315,14 @@ class CatClient(NamespacedClient):
308
315
  v: t.Optional[bool] = None,
309
316
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
310
317
  """
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
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
314
321
  APIs are only intended for human consumption using the command line or Kibana
315
322
  console. They are not intended for use by applications. For application consumption,
316
323
  use the count API.
317
324
 
318
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-count.html>`_
325
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-count.html>`_
319
326
 
320
327
  :param index: Comma-separated list of data streams, indices, and aliases used
321
328
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -401,7 +408,7 @@ class CatClient(NamespacedClient):
401
408
  using the command line or Kibana console. They are not intended for use by applications.
402
409
  For application consumption, use the nodes stats API.
403
410
 
404
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-fielddata.html>`_
411
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-fielddata.html>`_
405
412
 
406
413
  :param fields: Comma-separated list of fields used to limit returned information.
407
414
  To retrieve all fields, omit this parameter.
@@ -496,7 +503,7 @@ class CatClient(NamespacedClient):
496
503
  across multiple nodes. You also can use the API to track the recovery of a large
497
504
  cluster over a longer period of time.
498
505
 
499
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-health.html>`_
506
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-health.html>`_
500
507
 
501
508
  :param format: Specifies the format to return the columnar data in, can be set
502
509
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -571,9 +578,9 @@ class CatClient(NamespacedClient):
571
578
  v: t.Optional[bool] = None,
572
579
  ) -> TextApiResponse:
573
580
  """
574
- Returns help for the Cat APIs.
581
+ Get CAT help. Returns help for the CAT APIs.
575
582
 
576
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat.html>`_
583
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat.html>`_
577
584
 
578
585
  :param format: Specifies the format to return the columnar data in, can be set
579
586
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -660,18 +667,18 @@ class CatClient(NamespacedClient):
660
667
  v: t.Optional[bool] = None,
661
668
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
662
669
  """
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
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
665
678
  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.
679
+ For application consumption, use an index endpoint.
673
680
 
674
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-indices.html>`_
681
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-indices.html>`_
675
682
 
676
683
  :param index: Comma-separated list of data streams, indices, and aliases used
677
684
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -773,7 +780,7 @@ class CatClient(NamespacedClient):
773
780
  command line or Kibana console. They are not intended for use by applications.
774
781
  For application consumption, use the nodes info API.
775
782
 
776
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-master.html>`_
783
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-master.html>`_
777
784
 
778
785
  :param format: Specifies the format to return the columnar data in, can be set
779
786
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -942,12 +949,13 @@ class CatClient(NamespacedClient):
942
949
  v: t.Optional[bool] = None,
943
950
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
944
951
  """
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.
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.
949
957
 
950
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-dfanalytics.html>`_
958
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-dfanalytics.html>`_
951
959
 
952
960
  :param id: The ID of the data frame analytics to fetch
953
961
  :param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1114,14 +1122,14 @@ class CatClient(NamespacedClient):
1114
1122
  v: t.Optional[bool] = None,
1115
1123
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1116
1124
  """
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
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
1121
1129
  using the Kibana console or command line. They are not intended for use by applications.
1122
1130
  For application consumption, use the get datafeed statistics API.
1123
1131
 
1124
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-datafeeds.html>`_
1132
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-datafeeds.html>`_
1125
1133
 
1126
1134
  :param datafeed_id: A numerical character string that uniquely identifies the
1127
1135
  datafeed.
@@ -1486,15 +1494,15 @@ class CatClient(NamespacedClient):
1486
1494
  v: t.Optional[bool] = None,
1487
1495
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1488
1496
  """
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
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
1493
1501
  human consumption using the Kibana console or command line. They are not intended
1494
1502
  for use by applications. For application consumption, use the get anomaly detection
1495
1503
  job statistics API.
1496
1504
 
1497
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-anomaly-detectors.html>`_
1505
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-anomaly-detectors.html>`_
1498
1506
 
1499
1507
  :param job_id: Identifier for the anomaly detection job.
1500
1508
  :param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1678,12 +1686,12 @@ class CatClient(NamespacedClient):
1678
1686
  v: t.Optional[bool] = None,
1679
1687
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1680
1688
  """
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
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
1684
1692
  consumption, use the get trained models statistics API.
1685
1693
 
1686
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-trained-model.html>`_
1694
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-trained-model.html>`_
1687
1695
 
1688
1696
  :param model_id: A unique identifier for the trained model.
1689
1697
  :param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1780,7 +1788,7 @@ class CatClient(NamespacedClient):
1780
1788
  are not intended for use by applications. For application consumption, use the
1781
1789
  nodes info API.
1782
1790
 
1783
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-nodeattrs.html>`_
1791
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodeattrs.html>`_
1784
1792
 
1785
1793
  :param format: Specifies the format to return the columnar data in, can be set
1786
1794
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1859,7 +1867,7 @@ class CatClient(NamespacedClient):
1859
1867
  are not intended for use by applications. For application consumption, use the
1860
1868
  nodes info API.
1861
1869
 
1862
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-nodes.html>`_
1870
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-nodes.html>`_
1863
1871
 
1864
1872
  :param bytes: The unit used to display byte values.
1865
1873
  :param format: Specifies the format to return the columnar data in, can be set
@@ -1944,7 +1952,7 @@ class CatClient(NamespacedClient):
1944
1952
  console. They are not intended for use by applications. For application consumption,
1945
1953
  use the pending cluster tasks API.
1946
1954
 
1947
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-pending-tasks.html>`_
1955
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-pending-tasks.html>`_
1948
1956
 
1949
1957
  :param format: Specifies the format to return the columnar data in, can be set
1950
1958
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2018,7 +2026,7 @@ class CatClient(NamespacedClient):
2018
2026
  They are not intended for use by applications. For application consumption, use
2019
2027
  the nodes info API.
2020
2028
 
2021
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-plugins.html>`_
2029
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-plugins.html>`_
2022
2030
 
2023
2031
  :param format: Specifies the format to return the columnar data in, can be set
2024
2032
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2102,7 +2110,7 @@ class CatClient(NamespacedClient):
2102
2110
  line or Kibana console. They are not intended for use by applications. For application
2103
2111
  consumption, use the index recovery API.
2104
2112
 
2105
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-recovery.html>`_
2113
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-recovery.html>`_
2106
2114
 
2107
2115
  :param index: A comma-separated list of data streams, indices, and aliases used
2108
2116
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2194,7 +2202,7 @@ class CatClient(NamespacedClient):
2194
2202
  are not intended for use by applications. For application consumption, use the
2195
2203
  get snapshot repository API.
2196
2204
 
2197
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-repositories.html>`_
2205
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-repositories.html>`_
2198
2206
 
2199
2207
  :param format: Specifies the format to return the columnar data in, can be set
2200
2208
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2273,7 +2281,7 @@ class CatClient(NamespacedClient):
2273
2281
  console. They are not intended for use by applications. For application consumption,
2274
2282
  use the index segments API.
2275
2283
 
2276
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-segments.html>`_
2284
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-segments.html>`_
2277
2285
 
2278
2286
  :param index: A comma-separated list of data streams, indices, and aliases used
2279
2287
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2362,7 +2370,7 @@ class CatClient(NamespacedClient):
2362
2370
  for human consumption using the command line or Kibana console. They are not
2363
2371
  intended for use by applications.
2364
2372
 
2365
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-shards.html>`_
2373
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-shards.html>`_
2366
2374
 
2367
2375
  :param index: A comma-separated list of data streams, indices, and aliases used
2368
2376
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2450,7 +2458,7 @@ class CatClient(NamespacedClient):
2450
2458
  console. They are not intended for use by applications. For application consumption,
2451
2459
  use the get snapshot API.
2452
2460
 
2453
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-snapshots.html>`_
2461
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-snapshots.html>`_
2454
2462
 
2455
2463
  :param repository: A comma-separated list of snapshot repositories used to limit
2456
2464
  the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -2515,6 +2523,7 @@ class CatClient(NamespacedClient):
2515
2523
  )
2516
2524
 
2517
2525
  @_rewrite_parameters()
2526
+ @_stability_warning(Stability.EXPERIMENTAL)
2518
2527
  async def tasks(
2519
2528
  self,
2520
2529
  *,
@@ -2540,7 +2549,7 @@ class CatClient(NamespacedClient):
2540
2549
  console. They are not intended for use by applications. For application consumption,
2541
2550
  use the task management API.
2542
2551
 
2543
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/tasks.html>`_
2552
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html>`_
2544
2553
 
2545
2554
  :param actions: The task action names, which are used to limit the response.
2546
2555
  :param detailed: If `true`, the response includes detailed information about
@@ -2630,7 +2639,7 @@ class CatClient(NamespacedClient):
2630
2639
  console. They are not intended for use by applications. For application consumption,
2631
2640
  use the get index template API.
2632
2641
 
2633
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-templates.html>`_
2642
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-templates.html>`_
2634
2643
 
2635
2644
  :param name: The name of the template to return. Accepts wildcard expressions.
2636
2645
  If omitted, all templates are returned.
@@ -2716,7 +2725,7 @@ class CatClient(NamespacedClient):
2716
2725
  They are not intended for use by applications. For application consumption, use
2717
2726
  the nodes info API.
2718
2727
 
2719
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-thread-pool.html>`_
2728
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-thread-pool.html>`_
2720
2729
 
2721
2730
  :param thread_pool_patterns: A comma-separated list of thread pool names used
2722
2731
  to limit the request. Accepts wildcard expressions.
@@ -2966,12 +2975,12 @@ class CatClient(NamespacedClient):
2966
2975
  v: t.Optional[bool] = None,
2967
2976
  ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2968
2977
  """
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.
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.
2973
2982
 
2974
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cat-transforms.html>`_
2983
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cat-transforms.html>`_
2975
2984
 
2976
2985
  :param transform_id: A transform identifier or a wildcard expression. If you
2977
2986
  do not specify one of these options, the API returns information for all
@@ -38,7 +38,7 @@ class CcrClient(NamespacedClient):
38
38
  """
39
39
  Deletes auto-follow patterns.
40
40
 
41
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-delete-auto-follow-pattern.html>`_
41
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-delete-auto-follow-pattern.html>`_
42
42
 
43
43
  :param name: The name of the auto follow pattern.
44
44
  """
@@ -109,7 +109,7 @@ class CcrClient(NamespacedClient):
109
109
  """
110
110
  Creates a new follower index configured to follow the referenced leader index.
111
111
 
112
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-put-follow.html>`_
112
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-follow.html>`_
113
113
 
114
114
  :param index: The name of the follower index
115
115
  :param leader_index:
@@ -201,7 +201,7 @@ class CcrClient(NamespacedClient):
201
201
  Retrieves information about all follower indices, including parameters and status
202
202
  for each follower index
203
203
 
204
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-follow-info.html>`_
204
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-info.html>`_
205
205
 
206
206
  :param index: A comma-separated list of index patterns; use `_all` to perform
207
207
  the operation on all indices
@@ -243,7 +243,7 @@ class CcrClient(NamespacedClient):
243
243
  Retrieves follower stats. return shard-level stats about the following tasks
244
244
  associated with each shard for the specified indices.
245
245
 
246
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-follow-stats.html>`_
246
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-follow-stats.html>`_
247
247
 
248
248
  :param index: A comma-separated list of index patterns; use `_all` to perform
249
249
  the operation on all indices
@@ -296,7 +296,7 @@ class CcrClient(NamespacedClient):
296
296
  """
297
297
  Removes the follower retention leases from the leader.
298
298
 
299
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-forget-follower.html>`_
299
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-forget-follower.html>`_
300
300
 
301
301
  :param index: the name of the leader index for which specified follower retention
302
302
  leases should be removed
@@ -353,7 +353,7 @@ class CcrClient(NamespacedClient):
353
353
  Gets configured auto-follow patterns. Returns the specified auto-follow pattern
354
354
  collection.
355
355
 
356
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-auto-follow-pattern.html>`_
356
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-auto-follow-pattern.html>`_
357
357
 
358
358
  :param name: Specifies the auto-follow pattern collection that you want to retrieve.
359
359
  If you do not specify a name, the API returns information for all collections.
@@ -397,7 +397,7 @@ class CcrClient(NamespacedClient):
397
397
  """
398
398
  Pauses an auto-follow pattern
399
399
 
400
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-pause-auto-follow-pattern.html>`_
400
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-pause-auto-follow-pattern.html>`_
401
401
 
402
402
  :param name: The name of the auto follow pattern that should pause discovering
403
403
  new indices to follow.
@@ -439,7 +439,7 @@ class CcrClient(NamespacedClient):
439
439
  Pauses a follower index. The follower index will not fetch any additional operations
440
440
  from the leader index.
441
441
 
442
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-pause-follow.html>`_
442
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-pause-follow.html>`_
443
443
 
444
444
  :param index: The name of the follower index that should pause following its
445
445
  leader index.
@@ -516,7 +516,7 @@ class CcrClient(NamespacedClient):
516
516
  cluster. Newly created indices on the remote cluster matching any of the specified
517
517
  patterns will be automatically configured as follower indices.
518
518
 
519
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-put-auto-follow-pattern.html>`_
519
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-put-auto-follow-pattern.html>`_
520
520
 
521
521
  :param name: The name of the collection of auto-follow patterns.
522
522
  :param remote_cluster: The remote cluster containing the leader indices to match
@@ -640,7 +640,7 @@ class CcrClient(NamespacedClient):
640
640
  """
641
641
  Resumes an auto-follow pattern that has been paused
642
642
 
643
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-resume-auto-follow-pattern.html>`_
643
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-resume-auto-follow-pattern.html>`_
644
644
 
645
645
  :param name: The name of the auto follow pattern to resume discovering new indices
646
646
  to follow.
@@ -705,7 +705,7 @@ class CcrClient(NamespacedClient):
705
705
  """
706
706
  Resumes a follower index that has been paused
707
707
 
708
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-resume-follow.html>`_
708
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-resume-follow.html>`_
709
709
 
710
710
  :param index: The name of the follow index to resume following.
711
711
  :param max_outstanding_read_requests:
@@ -787,7 +787,7 @@ class CcrClient(NamespacedClient):
787
787
  """
788
788
  Gets all stats related to cross-cluster replication.
789
789
 
790
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-stats.html>`_
790
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-get-stats.html>`_
791
791
  """
792
792
  __path_parts: t.Dict[str, str] = {}
793
793
  __path = "/_ccr/stats"
@@ -824,7 +824,7 @@ class CcrClient(NamespacedClient):
824
824
  Stops the following task associated with a follower index and removes index metadata
825
825
  and settings associated with cross-cluster replication.
826
826
 
827
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-unfollow.html>`_
827
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ccr-post-unfollow.html>`_
828
828
 
829
829
  :param index: The name of the follower index that should be turned into a regular
830
830
  index.