elasticsearch 8.18.0__py3-none-any.whl → 9.0.1__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 (107) hide show
  1. elasticsearch/_async/client/__init__.py +62 -277
  2. elasticsearch/_async/client/_base.py +1 -1
  3. elasticsearch/_async/client/async_search.py +6 -10
  4. elasticsearch/_async/client/autoscaling.py +4 -4
  5. elasticsearch/_async/client/cat.py +26 -33
  6. elasticsearch/_async/client/ccr.py +13 -13
  7. elasticsearch/_async/client/cluster.py +20 -20
  8. elasticsearch/_async/client/connector.py +44 -30
  9. elasticsearch/_async/client/dangling_indices.py +3 -3
  10. elasticsearch/_async/client/enrich.py +5 -5
  11. elasticsearch/_async/client/eql.py +4 -4
  12. elasticsearch/_async/client/esql.py +7 -11
  13. elasticsearch/_async/client/features.py +2 -2
  14. elasticsearch/_async/client/fleet.py +18 -20
  15. elasticsearch/_async/client/graph.py +1 -1
  16. elasticsearch/_async/client/ilm.py +18 -11
  17. elasticsearch/_async/client/indices.py +75 -163
  18. elasticsearch/_async/client/inference.py +132 -25
  19. elasticsearch/_async/client/ingest.py +12 -12
  20. elasticsearch/_async/client/license.py +7 -7
  21. elasticsearch/_async/client/logstash.py +3 -3
  22. elasticsearch/_async/client/migration.py +3 -3
  23. elasticsearch/_async/client/ml.py +80 -85
  24. elasticsearch/_async/client/monitoring.py +1 -1
  25. elasticsearch/_async/client/nodes.py +8 -8
  26. elasticsearch/_async/client/query_rules.py +8 -8
  27. elasticsearch/_async/client/rollup.py +8 -8
  28. elasticsearch/_async/client/search_application.py +10 -10
  29. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  30. elasticsearch/_async/client/security.py +71 -68
  31. elasticsearch/_async/client/shutdown.py +3 -3
  32. elasticsearch/_async/client/simulate.py +1 -1
  33. elasticsearch/_async/client/slm.py +9 -9
  34. elasticsearch/_async/client/snapshot.py +280 -130
  35. elasticsearch/_async/client/sql.py +6 -6
  36. elasticsearch/_async/client/ssl.py +1 -1
  37. elasticsearch/_async/client/synonyms.py +7 -7
  38. elasticsearch/_async/client/tasks.py +3 -3
  39. elasticsearch/_async/client/text_structure.py +4 -4
  40. elasticsearch/_async/client/transform.py +11 -11
  41. elasticsearch/_async/client/watcher.py +14 -14
  42. elasticsearch/_async/client/xpack.py +2 -2
  43. elasticsearch/_sync/client/__init__.py +62 -277
  44. elasticsearch/_sync/client/_base.py +1 -1
  45. elasticsearch/_sync/client/async_search.py +6 -10
  46. elasticsearch/_sync/client/autoscaling.py +4 -4
  47. elasticsearch/_sync/client/cat.py +26 -33
  48. elasticsearch/_sync/client/ccr.py +13 -13
  49. elasticsearch/_sync/client/cluster.py +20 -20
  50. elasticsearch/_sync/client/connector.py +44 -30
  51. elasticsearch/_sync/client/dangling_indices.py +3 -3
  52. elasticsearch/_sync/client/enrich.py +5 -5
  53. elasticsearch/_sync/client/eql.py +4 -4
  54. elasticsearch/_sync/client/esql.py +7 -11
  55. elasticsearch/_sync/client/features.py +2 -2
  56. elasticsearch/_sync/client/fleet.py +18 -20
  57. elasticsearch/_sync/client/graph.py +1 -1
  58. elasticsearch/_sync/client/ilm.py +18 -11
  59. elasticsearch/_sync/client/indices.py +75 -163
  60. elasticsearch/_sync/client/inference.py +132 -25
  61. elasticsearch/_sync/client/ingest.py +12 -12
  62. elasticsearch/_sync/client/license.py +7 -7
  63. elasticsearch/_sync/client/logstash.py +3 -3
  64. elasticsearch/_sync/client/migration.py +3 -3
  65. elasticsearch/_sync/client/ml.py +80 -85
  66. elasticsearch/_sync/client/monitoring.py +1 -1
  67. elasticsearch/_sync/client/nodes.py +8 -8
  68. elasticsearch/_sync/client/query_rules.py +8 -8
  69. elasticsearch/_sync/client/rollup.py +8 -8
  70. elasticsearch/_sync/client/search_application.py +10 -10
  71. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  72. elasticsearch/_sync/client/security.py +71 -68
  73. elasticsearch/_sync/client/shutdown.py +3 -3
  74. elasticsearch/_sync/client/simulate.py +1 -1
  75. elasticsearch/_sync/client/slm.py +9 -9
  76. elasticsearch/_sync/client/snapshot.py +280 -130
  77. elasticsearch/_sync/client/sql.py +6 -6
  78. elasticsearch/_sync/client/ssl.py +1 -1
  79. elasticsearch/_sync/client/synonyms.py +7 -7
  80. elasticsearch/_sync/client/tasks.py +3 -3
  81. elasticsearch/_sync/client/text_structure.py +4 -4
  82. elasticsearch/_sync/client/transform.py +11 -11
  83. elasticsearch/_sync/client/utils.py +0 -37
  84. elasticsearch/_sync/client/watcher.py +14 -14
  85. elasticsearch/_sync/client/xpack.py +2 -2
  86. elasticsearch/_version.py +1 -1
  87. elasticsearch/dsl/_async/search.py +7 -3
  88. elasticsearch/dsl/_sync/search.py +7 -3
  89. elasticsearch/dsl/aggs.py +11 -7
  90. elasticsearch/dsl/faceted_search_base.py +4 -4
  91. elasticsearch/dsl/field.py +139 -1
  92. elasticsearch/dsl/query.py +7 -1
  93. elasticsearch/dsl/search_base.py +16 -3
  94. elasticsearch/dsl/types.py +66 -84
  95. elasticsearch/dsl/wrappers.py +25 -0
  96. elasticsearch/exceptions.py +2 -0
  97. elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
  98. elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
  99. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/METADATA +17 -29
  100. elasticsearch-9.0.1.dist-info/RECORD +162 -0
  101. elasticsearch-9.0.1.dist-info/licenses/LICENSE.txt +175 -0
  102. elasticsearch-9.0.1.dist-info/licenses/NOTICE.txt +559 -0
  103. elasticsearch/transport.py +0 -57
  104. elasticsearch-8.18.0.dist-info/RECORD +0 -161
  105. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/WHEEL +0 -0
  106. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/licenses/LICENSE +0 -0
  107. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/licenses/NOTICE +0 -0
@@ -174,7 +174,7 @@ def create_sniff_callback(
174
174
  "GET",
175
175
  "/_nodes/_all/http",
176
176
  headers={
177
- "accept": "application/vnd.elasticsearch+json; compatible-with=8"
177
+ "accept": "application/vnd.elasticsearch+json; compatible-with=9"
178
178
  },
179
179
  request_timeout=(
180
180
  sniff_options.sniff_timeout
@@ -44,7 +44,7 @@ class AsyncSearchClient(NamespacedClient):
44
44
  If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <code>cancel_task</code> cluster privilege.</p>
45
45
 
46
46
 
47
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html>`_
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit>`_
48
48
 
49
49
  :param id: A unique identifier for the async search.
50
50
  """
@@ -94,7 +94,7 @@ class AsyncSearchClient(NamespacedClient):
94
94
  If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</p>
95
95
 
96
96
 
97
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html>`_
97
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit>`_
98
98
 
99
99
  :param id: A unique identifier for the async search.
100
100
  :param keep_alive: The length of time that the async search should be available
@@ -164,7 +164,7 @@ class AsyncSearchClient(NamespacedClient):
164
164
  </ul>
165
165
 
166
166
 
167
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html>`_
167
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit>`_
168
168
 
169
169
  :param id: A unique identifier for the async search.
170
170
  :param keep_alive: The length of time that the async search needs to be available.
@@ -281,7 +281,6 @@ class AsyncSearchClient(NamespacedClient):
281
281
  ] = None,
282
282
  lenient: t.Optional[bool] = None,
283
283
  max_concurrent_shard_requests: t.Optional[int] = None,
284
- min_compatible_shard_node: t.Optional[str] = None,
285
284
  min_score: t.Optional[float] = None,
286
285
  pit: t.Optional[t.Mapping[str, t.Any]] = None,
287
286
  post_filter: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -299,7 +298,7 @@ class AsyncSearchClient(NamespacedClient):
299
298
  runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
300
299
  script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
301
300
  search_after: t.Optional[
302
- t.Sequence[t.Union[None, bool, float, int, str, t.Any]]
301
+ t.Sequence[t.Union[None, bool, float, int, str]]
303
302
  ] = None,
304
303
  search_type: t.Optional[
305
304
  t.Union[str, t.Literal["dfs_query_then_fetch", "query_then_fetch"]]
@@ -346,7 +345,7 @@ class AsyncSearchClient(NamespacedClient):
346
345
  The maximum allowed size for a stored async search response can be set by changing the <code>search.max_async_search_response_size</code> cluster level setting.</p>
347
346
 
348
347
 
349
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/async-search.html>`_
348
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit>`_
350
349
 
351
350
  :param index: A comma-separated list of index names to search; use `_all` or
352
351
  empty string to perform the operation on all indices
@@ -401,9 +400,8 @@ class AsyncSearchClient(NamespacedClient):
401
400
  per node this search executes concurrently. This value should be used to
402
401
  limit the impact of the search on the cluster in order to limit the number
403
402
  of concurrent shard requests
404
- :param min_compatible_shard_node:
405
403
  :param min_score: Minimum _score for matching documents. Documents with a lower
406
- _score are not included in the search results.
404
+ _score are not included in search results and results collected by aggregations.
407
405
  :param pit: Limits the search to a point in time (PIT). If you provide a PIT,
408
406
  you cannot specify an <index> in the request path.
409
407
  :param post_filter:
@@ -526,8 +524,6 @@ class AsyncSearchClient(NamespacedClient):
526
524
  __query["lenient"] = lenient
527
525
  if max_concurrent_shard_requests is not None:
528
526
  __query["max_concurrent_shard_requests"] = max_concurrent_shard_requests
529
- if min_compatible_shard_node is not None:
530
- __query["min_compatible_shard_node"] = min_compatible_shard_node
531
527
  if preference is not None:
532
528
  __query["preference"] = preference
533
529
  if pretty is not None:
@@ -44,7 +44,7 @@ class AutoscalingClient(NamespacedClient):
44
44
  <p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
45
45
 
46
46
 
47
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-delete-autoscaling-policy.html>`_
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-autoscaling-delete-autoscaling-policy>`_
48
48
 
49
49
  :param name: the name of the autoscaling policy
50
50
  :param master_timeout: Period to wait for a connection to the master node. If
@@ -104,7 +104,7 @@ class AutoscalingClient(NamespacedClient):
104
104
  Do not use this information to make autoscaling decisions.</p>
105
105
 
106
106
 
107
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html>`_
107
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-autoscaling-get-autoscaling-capacity>`_
108
108
 
109
109
  :param master_timeout: Period to wait for a connection to the master node. If
110
110
  no response is received before the timeout expires, the request fails and
@@ -151,7 +151,7 @@ class AutoscalingClient(NamespacedClient):
151
151
  <p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
152
152
 
153
153
 
154
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-get-autoscaling-capacity.html>`_
154
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-autoscaling-get-autoscaling-capacity>`_
155
155
 
156
156
  :param name: the name of the autoscaling policy
157
157
  :param master_timeout: Period to wait for a connection to the master node. If
@@ -206,7 +206,7 @@ class AutoscalingClient(NamespacedClient):
206
206
  <p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
207
207
 
208
208
 
209
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/autoscaling-put-autoscaling-policy.html>`_
209
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-autoscaling-put-autoscaling-policy>`_
210
210
 
211
211
  :param name: the name of the autoscaling policy
212
212
  :param policy:
@@ -50,7 +50,6 @@ class CatClient(NamespacedClient):
50
50
  h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
51
51
  help: t.Optional[bool] = None,
52
52
  human: t.Optional[bool] = None,
53
- local: t.Optional[bool] = None,
54
53
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
55
54
  pretty: t.Optional[bool] = None,
56
55
  s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -65,7 +64,7 @@ class CatClient(NamespacedClient):
65
64
  <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.18/cat-alias.html>`_
67
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-aliases>`_
69
68
 
70
69
  :param name: A comma-separated list of aliases to retrieve. Supports wildcards
71
70
  (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
@@ -78,10 +77,6 @@ class CatClient(NamespacedClient):
78
77
  :param h: List of columns to appear in the response. Supports simple wildcards.
79
78
  :param help: When set to `true` will output available columns. This option can't
80
79
  be combined with any other query string option.
81
- :param local: If `true`, the request computes the list of selected nodes from
82
- the local cluster state. If `false` the list of selected nodes are computed
83
- from the cluster state of the master node. In both cases the coordinating
84
- node will send requests for further information to each selected node.
85
80
  :param master_timeout: The period to wait for a connection to the master node.
86
81
  If the master node is not available before the timeout expires, the request
87
82
  fails and returns an error. To indicated that the request should never timeout,
@@ -113,8 +108,6 @@ class CatClient(NamespacedClient):
113
108
  __query["help"] = help
114
109
  if human is not None:
115
110
  __query["human"] = human
116
- if local is not None:
117
- __query["local"] = local
118
111
  if master_timeout is not None:
119
112
  __query["master_timeout"] = master_timeout
120
113
  if pretty is not None:
@@ -161,7 +154,7 @@ class CatClient(NamespacedClient):
161
154
  <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
155
 
163
156
 
164
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-allocation.html>`_
157
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-allocation>`_
165
158
 
166
159
  :param node_id: A comma-separated list of node identifiers or names used to limit
167
160
  the returned information.
@@ -250,7 +243,7 @@ class CatClient(NamespacedClient):
250
243
  They are not intended for use by applications. For application consumption, use the get component template API.</p>
251
244
 
252
245
 
253
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-component-templates.html>`_
246
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-component-templates>`_
254
247
 
255
248
  :param name: The name of the component template. It accepts wildcard expressions.
256
249
  If it is omitted, all component templates are returned.
@@ -334,7 +327,7 @@ class CatClient(NamespacedClient):
334
327
  They are not intended for use by applications. For application consumption, use the count API.</p>
335
328
 
336
329
 
337
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-count.html>`_
330
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count>`_
338
331
 
339
332
  :param index: A comma-separated list of data streams, indices, and aliases used
340
333
  to limit the request. It supports wildcards (`*`). To target all data streams
@@ -412,7 +405,7 @@ class CatClient(NamespacedClient):
412
405
  They are not intended for use by applications. For application consumption, use the nodes stats API.</p>
413
406
 
414
407
 
415
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-fielddata.html>`_
408
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-fielddata>`_
416
409
 
417
410
  :param fields: Comma-separated list of fields used to limit returned information.
418
411
  To retrieve all fields, omit this parameter.
@@ -498,7 +491,7 @@ class CatClient(NamespacedClient):
498
491
  You also can use the API to track the recovery of a large cluster over a longer period of time.</p>
499
492
 
500
493
 
501
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-health.html>`_
494
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-health>`_
502
495
 
503
496
  :param format: Specifies the format to return the columnar data in, can be set
504
497
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -556,7 +549,7 @@ class CatClient(NamespacedClient):
556
549
  <p>Get help for the CAT APIs.</p>
557
550
 
558
551
 
559
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat.html>`_
552
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat>`_
560
553
  """
561
554
  __path_parts: t.Dict[str, str] = {}
562
555
  __path = "/_cat"
@@ -623,7 +616,7 @@ class CatClient(NamespacedClient):
623
616
  They are not intended for use by applications. For application consumption, use an index endpoint.</p>
624
617
 
625
618
 
626
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-indices.html>`_
619
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-indices>`_
627
620
 
628
621
  :param index: Comma-separated list of data streams, indices, and aliases used
629
622
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -721,7 +714,7 @@ class CatClient(NamespacedClient):
721
714
  <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
715
 
723
716
 
724
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-master.html>`_
717
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-master>`_
725
718
 
726
719
  :param format: Specifies the format to return the columnar data in, can be set
727
720
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -899,7 +892,7 @@ class CatClient(NamespacedClient):
899
892
  application consumption, use the get data frame analytics jobs statistics API.</p>
900
893
 
901
894
 
902
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-dfanalytics.html>`_
895
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-data-frame-analytics>`_
903
896
 
904
897
  :param id: The ID of the data frame analytics to fetch
905
898
  :param allow_no_match: Whether to ignore if a wildcard expression matches no
@@ -1067,7 +1060,7 @@ class CatClient(NamespacedClient):
1067
1060
  application consumption, use the get datafeed statistics API.</p>
1068
1061
 
1069
1062
 
1070
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-datafeeds.html>`_
1063
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-datafeeds>`_
1071
1064
 
1072
1065
  :param datafeed_id: A numerical character string that uniquely identifies the
1073
1066
  datafeed.
@@ -1433,7 +1426,7 @@ class CatClient(NamespacedClient):
1433
1426
  application consumption, use the get anomaly detection job statistics API.</p>
1434
1427
 
1435
1428
 
1436
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-anomaly-detectors.html>`_
1429
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-jobs>`_
1437
1430
 
1438
1431
  :param job_id: Identifier for the anomaly detection job.
1439
1432
  :param allow_no_match: Specifies what to do when the request: * Contains wildcard
@@ -1618,7 +1611,7 @@ class CatClient(NamespacedClient):
1618
1611
  application consumption, use the get trained models statistics API.</p>
1619
1612
 
1620
1613
 
1621
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-trained-model.html>`_
1614
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-trained-models>`_
1622
1615
 
1623
1616
  :param model_id: A unique identifier for the trained model.
1624
1617
  :param allow_no_match: Specifies what to do when the request: contains wildcard
@@ -1711,7 +1704,7 @@ class CatClient(NamespacedClient):
1711
1704
  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
1705
 
1713
1706
 
1714
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-nodeattrs.html>`_
1707
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-nodeattrs>`_
1715
1708
 
1716
1709
  :param format: Specifies the format to return the columnar data in, can be set
1717
1710
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1794,7 +1787,7 @@ class CatClient(NamespacedClient):
1794
1787
  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
1788
 
1796
1789
 
1797
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-nodes.html>`_
1790
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-nodes>`_
1798
1791
 
1799
1792
  :param bytes: The unit used to display byte values.
1800
1793
  :param format: Specifies the format to return the columnar data in, can be set
@@ -1881,7 +1874,7 @@ class CatClient(NamespacedClient):
1881
1874
  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
1875
 
1883
1876
 
1884
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-pending-tasks.html>`_
1877
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-pending-tasks>`_
1885
1878
 
1886
1879
  :param format: Specifies the format to return the columnar data in, can be set
1887
1880
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -1961,7 +1954,7 @@ class CatClient(NamespacedClient):
1961
1954
  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
1955
 
1963
1956
 
1964
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-plugins.html>`_
1957
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-plugins>`_
1965
1958
 
1966
1959
  :param format: Specifies the format to return the columnar data in, can be set
1967
1960
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2049,7 +2042,7 @@ class CatClient(NamespacedClient):
2049
2042
  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
2043
 
2051
2044
 
2052
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-recovery.html>`_
2045
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-recovery>`_
2053
2046
 
2054
2047
  :param index: A comma-separated list of data streams, indices, and aliases used
2055
2048
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2137,7 +2130,7 @@ class CatClient(NamespacedClient):
2137
2130
  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
2131
 
2139
2132
 
2140
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-repositories.html>`_
2133
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-repositories>`_
2141
2134
 
2142
2135
  :param format: Specifies the format to return the columnar data in, can be set
2143
2136
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
@@ -2218,7 +2211,7 @@ class CatClient(NamespacedClient):
2218
2211
  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
2212
 
2220
2213
 
2221
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-segments.html>`_
2214
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-segments>`_
2222
2215
 
2223
2216
  :param index: A comma-separated list of data streams, indices, and aliases used
2224
2217
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2312,7 +2305,7 @@ class CatClient(NamespacedClient):
2312
2305
  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
2306
 
2314
2307
 
2315
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-shards.html>`_
2308
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-shards>`_
2316
2309
 
2317
2310
  :param index: A comma-separated list of data streams, indices, and aliases used
2318
2311
  to limit the request. Supports wildcards (`*`). To target all data streams
@@ -2401,7 +2394,7 @@ class CatClient(NamespacedClient):
2401
2394
  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
2395
 
2403
2396
 
2404
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-snapshots.html>`_
2397
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-snapshots>`_
2405
2398
 
2406
2399
  :param repository: A comma-separated list of snapshot repositories used to limit
2407
2400
  the request. Accepts wildcard expressions. `_all` returns all repositories.
@@ -2494,7 +2487,7 @@ class CatClient(NamespacedClient):
2494
2487
  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
2488
 
2496
2489
 
2497
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-tasks.html>`_
2490
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-tasks>`_
2498
2491
 
2499
2492
  :param actions: The task action names, which are used to limit the response.
2500
2493
  :param detailed: If `true`, the response includes detailed information about
@@ -2588,7 +2581,7 @@ class CatClient(NamespacedClient):
2588
2581
  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
2582
 
2590
2583
 
2591
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-templates.html>`_
2584
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-templates>`_
2592
2585
 
2593
2586
  :param name: The name of the template to return. Accepts wildcard expressions.
2594
2587
  If omitted, all templates are returned.
@@ -2676,7 +2669,7 @@ class CatClient(NamespacedClient):
2676
2669
  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
2670
 
2678
2671
 
2679
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-thread-pool.html>`_
2672
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-thread-pool>`_
2680
2673
 
2681
2674
  :param thread_pool_patterns: A comma-separated list of thread pool names used
2682
2675
  to limit the request. Accepts wildcard expressions.
@@ -2933,7 +2926,7 @@ class CatClient(NamespacedClient):
2933
2926
  application consumption, use the get transform statistics API.</p>
2934
2927
 
2935
2928
 
2936
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cat-transforms.html>`_
2929
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-transforms>`_
2937
2930
 
2938
2931
  :param transform_id: A transform identifier or a wildcard expression. If you
2939
2932
  do not specify one of these options, the API returns information for all
@@ -43,7 +43,7 @@ class CcrClient(NamespacedClient):
43
43
  <p>Delete a collection of cross-cluster replication auto-follow patterns.</p>
44
44
 
45
45
 
46
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-delete-auto-follow-pattern.html>`_
46
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-delete-auto-follow-pattern>`_
47
47
 
48
48
  :param name: The auto-follow pattern collection to delete.
49
49
  :param master_timeout: The period to wait for a connection to the master node.
@@ -130,7 +130,7 @@ class CcrClient(NamespacedClient):
130
130
  When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.</p>
131
131
 
132
132
 
133
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-put-follow.html>`_
133
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow>`_
134
134
 
135
135
  :param index: The name of the follower index.
136
136
  :param leader_index: The name of the index in the leader cluster to follow.
@@ -259,7 +259,7 @@ class CcrClient(NamespacedClient):
259
259
  For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.</p>
260
260
 
261
261
 
262
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-get-follow-info.html>`_
262
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-info>`_
263
263
 
264
264
  :param index: A comma-delimited list of follower index patterns.
265
265
  :param master_timeout: The period to wait for a connection to the master node.
@@ -311,7 +311,7 @@ class CcrClient(NamespacedClient):
311
311
  The API returns shard-level stats about the &quot;following tasks&quot; associated with each shard for the specified indices.</p>
312
312
 
313
313
 
314
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-get-follow-stats.html>`_
314
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-stats>`_
315
315
 
316
316
  :param index: A comma-delimited list of index patterns.
317
317
  :param timeout: The period to wait for a response. If no response is received
@@ -380,7 +380,7 @@ class CcrClient(NamespacedClient):
380
380
  The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.</p>
381
381
 
382
382
 
383
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-post-forget-follower.html>`_
383
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-forget-follower>`_
384
384
 
385
385
  :param index: the name of the leader index for which specified follower retention
386
386
  leases should be removed
@@ -445,7 +445,7 @@ class CcrClient(NamespacedClient):
445
445
  <p>Get cross-cluster replication auto-follow patterns.</p>
446
446
 
447
447
 
448
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-get-auto-follow-pattern.html>`_
448
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-get-auto-follow-pattern-1>`_
449
449
 
450
450
  :param name: The auto-follow pattern collection that you want to retrieve. If
451
451
  you do not specify a name, the API returns information for all collections.
@@ -505,7 +505,7 @@ class CcrClient(NamespacedClient):
505
505
  Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.</p>
506
506
 
507
507
 
508
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-pause-auto-follow-pattern.html>`_
508
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-auto-follow-pattern>`_
509
509
 
510
510
  :param name: The name of the auto-follow pattern to pause.
511
511
  :param master_timeout: The period to wait for a connection to the master node.
@@ -559,7 +559,7 @@ class CcrClient(NamespacedClient):
559
559
  You can pause and resume a follower index to change the configuration of the following task.</p>
560
560
 
561
561
 
562
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-post-pause-follow.html>`_
562
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-follow>`_
563
563
 
564
564
  :param index: The name of the follower index.
565
565
  :param master_timeout: The period to wait for a connection to the master node.
@@ -648,7 +648,7 @@ class CcrClient(NamespacedClient):
648
648
  NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.</p>
649
649
 
650
650
 
651
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-put-auto-follow-pattern.html>`_
651
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-put-auto-follow-pattern>`_
652
652
 
653
653
  :param name: The name of the collection of auto-follow patterns.
654
654
  :param remote_cluster: The remote cluster containing the leader indices to match
@@ -782,7 +782,7 @@ class CcrClient(NamespacedClient):
782
782
  Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.</p>
783
783
 
784
784
 
785
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-resume-auto-follow-pattern.html>`_
785
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-auto-follow-pattern>`_
786
786
 
787
787
  :param name: The name of the auto-follow pattern to resume.
788
788
  :param master_timeout: The period to wait for a connection to the master node.
@@ -860,7 +860,7 @@ class CcrClient(NamespacedClient):
860
860
  When this API returns, the follower index will resume fetching operations from the leader index.</p>
861
861
 
862
862
 
863
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-post-resume-follow.html>`_
863
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-follow>`_
864
864
 
865
865
  :param index: The name of the follow index to resume following.
866
866
  :param master_timeout: Period to wait for a connection to the master node.
@@ -951,7 +951,7 @@ class CcrClient(NamespacedClient):
951
951
  <p>This API returns stats about auto-following and the same shard-level stats as the get follower stats API.</p>
952
952
 
953
953
 
954
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-get-stats.html>`_
954
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-stats>`_
955
955
 
956
956
  :param master_timeout: The period to wait for a connection to the master node.
957
957
  If the master node is not available before the timeout expires, the request
@@ -1009,7 +1009,7 @@ class CcrClient(NamespacedClient):
1009
1009
  </blockquote>
1010
1010
 
1011
1011
 
1012
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ccr-post-unfollow.html>`_
1012
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-unfollow>`_
1013
1013
 
1014
1014
  :param index: The name of the follower index.
1015
1015
  :param master_timeout: The period to wait for a connection to the master node.