elasticsearch 9.1.2__py3-none-any.whl → 9.1.3__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 (117) hide show
  1. elasticsearch/_async/client/__init__.py +67 -65
  2. elasticsearch/_async/client/async_search.py +3 -3
  3. elasticsearch/_async/client/autoscaling.py +8 -4
  4. elasticsearch/_async/client/cat.py +40 -2
  5. elasticsearch/_async/client/ccr.py +10 -10
  6. elasticsearch/_async/client/cluster.py +34 -33
  7. elasticsearch/_async/client/connector.py +42 -41
  8. elasticsearch/_async/client/dangling_indices.py +8 -12
  9. elasticsearch/_async/client/enrich.py +10 -10
  10. elasticsearch/_async/client/eql.py +10 -10
  11. elasticsearch/_async/client/esql.py +16 -16
  12. elasticsearch/_async/client/features.py +6 -6
  13. elasticsearch/_async/client/fleet.py +8 -12
  14. elasticsearch/_async/client/graph.py +3 -7
  15. elasticsearch/_async/client/ilm.py +20 -28
  16. elasticsearch/_async/client/indices.py +140 -160
  17. elasticsearch/_async/client/inference.py +30 -126
  18. elasticsearch/_async/client/ingest.py +9 -9
  19. elasticsearch/_async/client/license.py +5 -7
  20. elasticsearch/_async/client/logstash.py +4 -4
  21. elasticsearch/_async/client/migration.py +6 -6
  22. elasticsearch/_async/client/ml.py +125 -85
  23. elasticsearch/_async/client/monitoring.py +4 -3
  24. elasticsearch/_async/client/nodes.py +15 -15
  25. elasticsearch/_async/client/query_rules.py +16 -16
  26. elasticsearch/_async/client/rollup.py +21 -21
  27. elasticsearch/_async/client/search_application.py +19 -19
  28. elasticsearch/_async/client/searchable_snapshots.py +10 -10
  29. elasticsearch/_async/client/security.py +8 -7
  30. elasticsearch/_async/client/shutdown.py +9 -4
  31. elasticsearch/_async/client/simulate.py +4 -4
  32. elasticsearch/_async/client/slm.py +18 -22
  33. elasticsearch/_async/client/snapshot.py +20 -20
  34. elasticsearch/_async/client/sql.py +10 -10
  35. elasticsearch/_async/client/streams.py +6 -6
  36. elasticsearch/_async/client/synonyms.py +10 -10
  37. elasticsearch/_async/client/tasks.py +8 -8
  38. elasticsearch/_async/client/text_structure.py +13 -9
  39. elasticsearch/_async/client/transform.py +51 -12
  40. elasticsearch/_async/client/utils.py +4 -2
  41. elasticsearch/_async/client/watcher.py +26 -26
  42. elasticsearch/_async/client/xpack.py +6 -5
  43. elasticsearch/_sync/client/__init__.py +69 -65
  44. elasticsearch/_sync/client/async_search.py +3 -3
  45. elasticsearch/_sync/client/autoscaling.py +8 -4
  46. elasticsearch/_sync/client/cat.py +40 -2
  47. elasticsearch/_sync/client/ccr.py +10 -10
  48. elasticsearch/_sync/client/cluster.py +34 -33
  49. elasticsearch/_sync/client/connector.py +42 -41
  50. elasticsearch/_sync/client/dangling_indices.py +8 -12
  51. elasticsearch/_sync/client/enrich.py +10 -10
  52. elasticsearch/_sync/client/eql.py +10 -10
  53. elasticsearch/_sync/client/esql.py +16 -16
  54. elasticsearch/_sync/client/features.py +6 -6
  55. elasticsearch/_sync/client/fleet.py +8 -12
  56. elasticsearch/_sync/client/graph.py +3 -7
  57. elasticsearch/_sync/client/ilm.py +20 -28
  58. elasticsearch/_sync/client/indices.py +140 -160
  59. elasticsearch/_sync/client/inference.py +30 -126
  60. elasticsearch/_sync/client/ingest.py +9 -9
  61. elasticsearch/_sync/client/license.py +5 -7
  62. elasticsearch/_sync/client/logstash.py +4 -4
  63. elasticsearch/_sync/client/migration.py +6 -6
  64. elasticsearch/_sync/client/ml.py +125 -85
  65. elasticsearch/_sync/client/monitoring.py +4 -3
  66. elasticsearch/_sync/client/nodes.py +15 -15
  67. elasticsearch/_sync/client/query_rules.py +16 -16
  68. elasticsearch/_sync/client/rollup.py +21 -21
  69. elasticsearch/_sync/client/search_application.py +19 -19
  70. elasticsearch/_sync/client/searchable_snapshots.py +10 -10
  71. elasticsearch/_sync/client/security.py +8 -7
  72. elasticsearch/_sync/client/shutdown.py +9 -4
  73. elasticsearch/_sync/client/simulate.py +4 -4
  74. elasticsearch/_sync/client/slm.py +18 -22
  75. elasticsearch/_sync/client/snapshot.py +20 -20
  76. elasticsearch/_sync/client/sql.py +10 -10
  77. elasticsearch/_sync/client/streams.py +6 -6
  78. elasticsearch/_sync/client/synonyms.py +10 -10
  79. elasticsearch/_sync/client/tasks.py +8 -8
  80. elasticsearch/_sync/client/text_structure.py +13 -9
  81. elasticsearch/_sync/client/transform.py +51 -12
  82. elasticsearch/_sync/client/utils.py +16 -2
  83. elasticsearch/_sync/client/watcher.py +26 -26
  84. elasticsearch/_sync/client/xpack.py +6 -5
  85. elasticsearch/_version.py +2 -2
  86. elasticsearch/dsl/_async/document.py +4 -5
  87. elasticsearch/dsl/_async/index.py +1 -1
  88. elasticsearch/dsl/_async/search.py +2 -3
  89. elasticsearch/dsl/_sync/document.py +4 -5
  90. elasticsearch/dsl/_sync/index.py +1 -1
  91. elasticsearch/dsl/_sync/search.py +2 -3
  92. elasticsearch/dsl/aggs.py +3 -3
  93. elasticsearch/dsl/async_connections.py +1 -2
  94. elasticsearch/dsl/connections.py +1 -2
  95. elasticsearch/dsl/document_base.py +1 -1
  96. elasticsearch/dsl/field.py +1 -9
  97. elasticsearch/dsl/query.py +24 -5
  98. elasticsearch/dsl/serializer.py +1 -2
  99. elasticsearch/dsl/types.py +11 -43
  100. elasticsearch/dsl/utils.py +1 -2
  101. elasticsearch/esql/esql.py +1 -1
  102. elasticsearch/esql/functions.py +2 -2
  103. elasticsearch/helpers/vectorstore/__init__.py +7 -7
  104. elasticsearch/helpers/vectorstore/_async/_utils.py +1 -1
  105. elasticsearch/helpers/vectorstore/_async/embedding_service.py +2 -2
  106. elasticsearch/helpers/vectorstore/_async/strategies.py +3 -3
  107. elasticsearch/helpers/vectorstore/_async/vectorstore.py +5 -5
  108. elasticsearch/helpers/vectorstore/_sync/_utils.py +1 -1
  109. elasticsearch/helpers/vectorstore/_sync/embedding_service.py +2 -2
  110. elasticsearch/helpers/vectorstore/_sync/strategies.py +3 -3
  111. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +5 -5
  112. {elasticsearch-9.1.2.dist-info → elasticsearch-9.1.3.dist-info}/METADATA +1 -1
  113. elasticsearch-9.1.3.dist-info/RECORD +165 -0
  114. {elasticsearch-9.1.2.dist-info → elasticsearch-9.1.3.dist-info}/WHEEL +1 -1
  115. elasticsearch-9.1.2.dist-info/RECORD +0 -165
  116. {elasticsearch-9.1.2.dist-info → elasticsearch-9.1.3.dist-info}/licenses/LICENSE +0 -0
  117. {elasticsearch-9.1.2.dist-info → elasticsearch-9.1.3.dist-info}/licenses/NOTICE +0 -0
@@ -40,8 +40,8 @@ class SlmClient(NamespacedClient):
40
40
  """
41
41
  .. raw:: html
42
42
 
43
- <p>Delete a policy.
44
- Delete a snapshot lifecycle policy definition.
43
+ <p>Delete a policy.</p>
44
+ <p>Delete a snapshot lifecycle policy definition.
45
45
  This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.</p>
46
46
 
47
47
 
@@ -96,8 +96,8 @@ class SlmClient(NamespacedClient):
96
96
  """
97
97
  .. raw:: html
98
98
 
99
- <p>Run a policy.
100
- Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.
99
+ <p>Run a policy.</p>
100
+ <p>Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.
101
101
  The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.</p>
102
102
 
103
103
 
@@ -151,8 +151,8 @@ class SlmClient(NamespacedClient):
151
151
  """
152
152
  .. raw:: html
153
153
 
154
- <p>Run a retention policy.
155
- Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.
154
+ <p>Run a retention policy.</p>
155
+ <p>Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.
156
156
  The retention policy is normally applied according to its schedule.</p>
157
157
 
158
158
 
@@ -204,13 +204,13 @@ class SlmClient(NamespacedClient):
204
204
  """
205
205
  .. raw:: html
206
206
 
207
- <p>Get policy information.
208
- Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.</p>
207
+ <p>Get policy information.</p>
208
+ <p>Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.</p>
209
209
 
210
210
 
211
211
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle>`_
212
212
 
213
- :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve
213
+ :param policy_id: A comma-separated list of snapshot lifecycle policy identifiers.
214
214
  :param master_timeout: The period to wait for a connection to the master node.
215
215
  If no response is received before the timeout expires, the request fails
216
216
  and returns an error.
@@ -261,8 +261,8 @@ class SlmClient(NamespacedClient):
261
261
  """
262
262
  .. raw:: html
263
263
 
264
- <p>Get snapshot lifecycle management statistics.
265
- Get global and policy-level statistics about actions taken by snapshot lifecycle management.</p>
264
+ <p>Get snapshot lifecycle management statistics.</p>
265
+ <p>Get global and policy-level statistics about actions taken by snapshot lifecycle management.</p>
266
266
 
267
267
 
268
268
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats>`_
@@ -373,8 +373,8 @@ class SlmClient(NamespacedClient):
373
373
  """
374
374
  .. raw:: html
375
375
 
376
- <p>Create or update a policy.
377
- Create or update a snapshot lifecycle policy.
376
+ <p>Create or update a policy.</p>
377
+ <p>Create or update a snapshot lifecycle policy.
378
378
  If the policy already exists, this request increments the policy version.
379
379
  Only the latest version of a policy is stored.</p>
380
380
 
@@ -431,11 +431,7 @@ class SlmClient(NamespacedClient):
431
431
  __body["retention"] = retention
432
432
  if schedule is not None:
433
433
  __body["schedule"] = schedule
434
- if not __body:
435
- __body = None # type: ignore[assignment]
436
- __headers = {"accept": "application/json"}
437
- if __body is not None:
438
- __headers["content-type"] = "application/json"
434
+ __headers = {"accept": "application/json", "content-type": "application/json"}
439
435
  return await self.perform_request( # type: ignore[return-value]
440
436
  "PUT",
441
437
  __path,
@@ -460,8 +456,8 @@ class SlmClient(NamespacedClient):
460
456
  """
461
457
  .. raw:: html
462
458
 
463
- <p>Start snapshot lifecycle management.
464
- Snapshot lifecycle management (SLM) starts automatically when a cluster is formed.
459
+ <p>Start snapshot lifecycle management.</p>
460
+ <p>Snapshot lifecycle management (SLM) starts automatically when a cluster is formed.
465
461
  Manually starting SLM is necessary only if it has been stopped using the stop SLM API.</p>
466
462
 
467
463
 
@@ -514,8 +510,8 @@ class SlmClient(NamespacedClient):
514
510
  """
515
511
  .. raw:: html
516
512
 
517
- <p>Stop snapshot lifecycle management.
518
- Stop all snapshot lifecycle management (SLM) operations and the SLM plugin.
513
+ <p>Stop snapshot lifecycle management.</p>
514
+ <p>Stop all snapshot lifecycle management (SLM) operations and the SLM plugin.
519
515
  This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.
520
516
  Stopping SLM does not stop any snapshots that are in progress.
521
517
  You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.</p>
@@ -23,9 +23,9 @@ from ._base import NamespacedClient
23
23
  from .utils import (
24
24
  SKIP_IN_PATH,
25
25
  Stability,
26
+ _availability_warning,
26
27
  _quote,
27
28
  _rewrite_parameters,
28
- _stability_warning,
29
29
  )
30
30
 
31
31
 
@@ -46,8 +46,8 @@ class SnapshotClient(NamespacedClient):
46
46
  """
47
47
  .. raw:: html
48
48
 
49
- <p>Clean up the snapshot repository.
50
- Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.</p>
49
+ <p>Clean up the snapshot repository.</p>
50
+ <p>Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.</p>
51
51
 
52
52
 
53
53
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository>`_
@@ -110,8 +110,8 @@ class SnapshotClient(NamespacedClient):
110
110
  """
111
111
  .. raw:: html
112
112
 
113
- <p>Clone a snapshot.
114
- Clone part of all of a snapshot into another snapshot in the same repository.</p>
113
+ <p>Clone a snapshot.</p>
114
+ <p>Clone part of all of a snapshot into another snapshot in the same repository.</p>
115
115
 
116
116
 
117
117
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone>`_
@@ -207,8 +207,8 @@ class SnapshotClient(NamespacedClient):
207
207
  """
208
208
  .. raw:: html
209
209
 
210
- <p>Create a snapshot.
211
- Take a snapshot of a cluster or of data streams and indices.</p>
210
+ <p>Create a snapshot.</p>
211
+ <p>Take a snapshot of a cluster or of data streams and indices.</p>
212
212
 
213
213
 
214
214
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create>`_
@@ -330,8 +330,8 @@ class SnapshotClient(NamespacedClient):
330
330
  """
331
331
  .. raw:: html
332
332
 
333
- <p>Create or update a snapshot repository.
334
- IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.
333
+ <p>Create or update a snapshot repository.</p>
334
+ <p>IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.
335
335
  To register a snapshot repository, the cluster's global metadata must be writeable.
336
336
  Ensure there are no cluster blocks (for example, <code>cluster.blocks.read_only</code> and <code>clsuter.blocks.read_only_allow_delete</code> settings) that prevent write access.</p>
337
337
  <p>Several options for this API can be specified using a query parameter or a request body parameter.
@@ -470,8 +470,8 @@ class SnapshotClient(NamespacedClient):
470
470
  """
471
471
  .. raw:: html
472
472
 
473
- <p>Delete snapshot repositories.
474
- When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.
473
+ <p>Delete snapshot repositories.</p>
474
+ <p>When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.
475
475
  The snapshots themselves are left untouched and in place.</p>
476
476
 
477
477
 
@@ -950,7 +950,7 @@ class SnapshotClient(NamespacedClient):
950
950
  )
951
951
 
952
952
  @_rewrite_parameters()
953
- @_stability_warning(Stability.EXPERIMENTAL)
953
+ @_availability_warning(Stability.EXPERIMENTAL)
954
954
  async def repository_verify_integrity(
955
955
  self,
956
956
  *,
@@ -971,8 +971,8 @@ class SnapshotClient(NamespacedClient):
971
971
  """
972
972
  .. raw:: html
973
973
 
974
- <p>Verify the repository integrity.
975
- Verify the integrity of the contents of a snapshot repository.</p>
974
+ <p>Verify the repository integrity.</p>
975
+ <p>Verify the integrity of the contents of a snapshot repository.</p>
976
976
  <p>This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.</p>
977
977
  <p>If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its <code>read_only</code> option to <code>true</code>, and use this API to verify its integrity.
978
978
  Until you do so:</p>
@@ -1110,8 +1110,8 @@ class SnapshotClient(NamespacedClient):
1110
1110
  """
1111
1111
  .. raw:: html
1112
1112
 
1113
- <p>Restore a snapshot.
1114
- Restore a snapshot of a cluster or data streams and indices.</p>
1113
+ <p>Restore a snapshot.</p>
1114
+ <p>Restore a snapshot of a cluster or data streams and indices.</p>
1115
1115
  <p>You can restore a snapshot only to a running cluster with an elected master node.
1116
1116
  The snapshot repository must be registered and available to the cluster.
1117
1117
  The snapshot and cluster versions must be compatible.</p>
@@ -1259,8 +1259,8 @@ class SnapshotClient(NamespacedClient):
1259
1259
  """
1260
1260
  .. raw:: html
1261
1261
 
1262
- <p>Get the snapshot status.
1263
- Get a detailed description of the current state for each shard participating in the snapshot.</p>
1262
+ <p>Get the snapshot status.</p>
1263
+ <p>Get a detailed description of the current state for each shard participating in the snapshot.</p>
1264
1264
  <p>Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots.
1265
1265
  If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.</p>
1266
1266
  <p>If you omit the <code>&lt;snapshot&gt;</code> request path parameter, the request retrieves information only for currently running snapshots.
@@ -1337,8 +1337,8 @@ class SnapshotClient(NamespacedClient):
1337
1337
  """
1338
1338
  .. raw:: html
1339
1339
 
1340
- <p>Verify a snapshot repository.
1341
- Check for common misconfigurations in a snapshot repository.</p>
1340
+ <p>Verify a snapshot repository.</p>
1341
+ <p>Check for common misconfigurations in a snapshot repository.</p>
1342
1342
 
1343
1343
 
1344
1344
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository>`_
@@ -89,8 +89,8 @@ class SqlClient(NamespacedClient):
89
89
  """
90
90
  .. raw:: html
91
91
 
92
- <p>Delete an async SQL search.
93
- Delete an async SQL search or a stored synchronous SQL search.
92
+ <p>Delete an async SQL search.</p>
93
+ <p>Delete an async SQL search or a stored synchronous SQL search.
94
94
  If the search is still running, the API cancels it.</p>
95
95
  <p>If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:</p>
96
96
  <ul>
@@ -145,8 +145,8 @@ class SqlClient(NamespacedClient):
145
145
  """
146
146
  .. raw:: html
147
147
 
148
- <p>Get async SQL search results.
149
- Get the current status and available results for an async SQL search or stored synchronous SQL search.</p>
148
+ <p>Get async SQL search results.</p>
149
+ <p>Get the current status and available results for an async SQL search or stored synchronous SQL search.</p>
150
150
  <p>If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.</p>
151
151
 
152
152
 
@@ -208,8 +208,8 @@ class SqlClient(NamespacedClient):
208
208
  """
209
209
  .. raw:: html
210
210
 
211
- <p>Get the async SQL search status.
212
- Get the current status of an async SQL search or a stored synchronous SQL search.</p>
211
+ <p>Get the async SQL search status.</p>
212
+ <p>Get the current status of an async SQL search or a stored synchronous SQL search.</p>
213
213
 
214
214
 
215
215
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status>`_
@@ -297,8 +297,8 @@ class SqlClient(NamespacedClient):
297
297
  """
298
298
  .. raw:: html
299
299
 
300
- <p>Get SQL search results.
301
- Run an SQL request.</p>
300
+ <p>Get SQL search results.</p>
301
+ <p>Run an SQL request.</p>
302
302
 
303
303
 
304
304
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query>`_
@@ -422,8 +422,8 @@ class SqlClient(NamespacedClient):
422
422
  """
423
423
  .. raw:: html
424
424
 
425
- <p>Translate SQL into Elasticsearch queries.
426
- Translate an SQL search into a search API request containing Query DSL.
425
+ <p>Translate SQL into Elasticsearch queries.</p>
426
+ <p>Translate an SQL search into a search API request containing Query DSL.
427
427
  It accepts the same request body parameters as the SQL search API, excluding <code>cursor</code>.</p>
428
428
 
429
429
 
@@ -22,15 +22,15 @@ from elastic_transport import ObjectApiResponse, TextApiResponse
22
22
  from ._base import NamespacedClient
23
23
  from .utils import (
24
24
  Stability,
25
+ _availability_warning,
25
26
  _rewrite_parameters,
26
- _stability_warning,
27
27
  )
28
28
 
29
29
 
30
30
  class StreamsClient(NamespacedClient):
31
31
 
32
32
  @_rewrite_parameters()
33
- @_stability_warning(Stability.EXPERIMENTAL)
33
+ @_availability_warning(Stability.EXPERIMENTAL)
34
34
  async def logs_disable(
35
35
  self,
36
36
  *,
@@ -71,7 +71,7 @@ class StreamsClient(NamespacedClient):
71
71
  __query["pretty"] = pretty
72
72
  if timeout is not None:
73
73
  __query["timeout"] = timeout
74
- __headers = {"accept": "application/json,text/plain"}
74
+ __headers = {"accept": "text/plain,application/json"}
75
75
  return await self.perform_request( # type: ignore[return-value]
76
76
  "POST",
77
77
  __path,
@@ -82,7 +82,7 @@ class StreamsClient(NamespacedClient):
82
82
  )
83
83
 
84
84
  @_rewrite_parameters()
85
- @_stability_warning(Stability.EXPERIMENTAL)
85
+ @_availability_warning(Stability.EXPERIMENTAL)
86
86
  async def logs_enable(
87
87
  self,
88
88
  *,
@@ -126,7 +126,7 @@ class StreamsClient(NamespacedClient):
126
126
  __query["pretty"] = pretty
127
127
  if timeout is not None:
128
128
  __query["timeout"] = timeout
129
- __headers = {"accept": "application/json,text/plain"}
129
+ __headers = {"accept": "text/plain,application/json"}
130
130
  return await self.perform_request( # type: ignore[return-value]
131
131
  "POST",
132
132
  __path,
@@ -137,7 +137,7 @@ class StreamsClient(NamespacedClient):
137
137
  )
138
138
 
139
139
  @_rewrite_parameters()
140
- @_stability_warning(Stability.EXPERIMENTAL)
140
+ @_availability_warning(Stability.EXPERIMENTAL)
141
141
  async def status(
142
142
  self,
143
143
  *,
@@ -95,8 +95,8 @@ class SynonymsClient(NamespacedClient):
95
95
  """
96
96
  .. raw:: html
97
97
 
98
- <p>Delete a synonym rule.
99
- Delete a synonym rule from a synonym set.</p>
98
+ <p>Delete a synonym rule.</p>
99
+ <p>Delete a synonym rule from a synonym set.</p>
100
100
 
101
101
 
102
102
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule>`_
@@ -204,8 +204,8 @@ class SynonymsClient(NamespacedClient):
204
204
  """
205
205
  .. raw:: html
206
206
 
207
- <p>Get a synonym rule.
208
- Get a synonym rule from a synonym set.</p>
207
+ <p>Get a synonym rule.</p>
208
+ <p>Get a synonym rule from a synonym set.</p>
209
209
 
210
210
 
211
211
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule>`_
@@ -257,8 +257,8 @@ class SynonymsClient(NamespacedClient):
257
257
  """
258
258
  .. raw:: html
259
259
 
260
- <p>Get all synonym sets.
261
- Get a summary of all defined synonym sets.</p>
260
+ <p>Get all synonym sets.</p>
261
+ <p>Get a summary of all defined synonym sets.</p>
262
262
 
263
263
 
264
264
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym>`_
@@ -311,8 +311,8 @@ class SynonymsClient(NamespacedClient):
311
311
  """
312
312
  .. raw:: html
313
313
 
314
- <p>Create or update a synonym set.
315
- Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
314
+ <p>Create or update a synonym set.</p>
315
+ <p>Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
316
316
  If you need to manage more synonym rules, you can create multiple synonym sets.</p>
317
317
  <p>When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.
318
318
  This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.</p>
@@ -378,8 +378,8 @@ class SynonymsClient(NamespacedClient):
378
378
  """
379
379
  .. raw:: html
380
380
 
381
- <p>Create or update a synonym rule.
382
- Create or update a synonym rule in a synonym set.</p>
381
+ <p>Create or update a synonym rule.</p>
382
+ <p>Create or update a synonym rule in a synonym set.</p>
383
383
  <p>If any of the synonym rules included is invalid, the API returns an error.</p>
384
384
  <p>When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.</p>
385
385
 
@@ -23,16 +23,16 @@ from ._base import NamespacedClient
23
23
  from .utils import (
24
24
  SKIP_IN_PATH,
25
25
  Stability,
26
+ _availability_warning,
26
27
  _quote,
27
28
  _rewrite_parameters,
28
- _stability_warning,
29
29
  )
30
30
 
31
31
 
32
32
  class TasksClient(NamespacedClient):
33
33
 
34
34
  @_rewrite_parameters()
35
- @_stability_warning(Stability.EXPERIMENTAL)
35
+ @_availability_warning(Stability.EXPERIMENTAL)
36
36
  async def cancel(
37
37
  self,
38
38
  *,
@@ -106,7 +106,7 @@ class TasksClient(NamespacedClient):
106
106
  )
107
107
 
108
108
  @_rewrite_parameters()
109
- @_stability_warning(Stability.EXPERIMENTAL)
109
+ @_availability_warning(Stability.EXPERIMENTAL)
110
110
  async def get(
111
111
  self,
112
112
  *,
@@ -121,8 +121,8 @@ class TasksClient(NamespacedClient):
121
121
  """
122
122
  .. raw:: html
123
123
 
124
- <p>Get task information.
125
- Get information about a task currently running in the cluster.</p>
124
+ <p>Get task information.</p>
125
+ <p>Get information about a task currently running in the cluster.</p>
126
126
  <p>WARNING: The task management API is new and should still be considered a beta feature.
127
127
  The API may change in ways that are not backwards compatible.</p>
128
128
  <p>If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.</p>
@@ -164,7 +164,7 @@ class TasksClient(NamespacedClient):
164
164
  )
165
165
 
166
166
  @_rewrite_parameters()
167
- @_stability_warning(Stability.EXPERIMENTAL)
167
+ @_availability_warning(Stability.EXPERIMENTAL)
168
168
  async def list(
169
169
  self,
170
170
  *,
@@ -185,8 +185,8 @@ class TasksClient(NamespacedClient):
185
185
  """
186
186
  .. raw:: html
187
187
 
188
- <p>Get all tasks.
189
- Get information about the tasks currently running on one or more nodes in the cluster.</p>
188
+ <p>Get all tasks.</p>
189
+ <p>Get information about the tasks currently running on one or more nodes in the cluster.</p>
190
190
  <p>WARNING: The task management API is new and should still be considered a beta feature.
191
191
  The API may change in ways that are not backwards compatible.</p>
192
192
  <p><strong>Identifying running tasks</strong></p>
@@ -55,8 +55,8 @@ class TextStructureClient(NamespacedClient):
55
55
  """
56
56
  .. raw:: html
57
57
 
58
- <p>Find the structure of a text field.
59
- Find the structure of a text field in an Elasticsearch index.</p>
58
+ <p>Find the structure of a text field.</p>
59
+ <p>Find the structure of a text field in an Elasticsearch index.</p>
60
60
  <p>This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.
61
61
  For example, if you have ingested data into a very simple index that has just <code>@timestamp</code> and message fields, you can use this API to see what common structure exists in the message field.</p>
62
62
  <p>The response from the API contains:</p>
@@ -241,8 +241,8 @@ class TextStructureClient(NamespacedClient):
241
241
  """
242
242
  .. raw:: html
243
243
 
244
- <p>Find the structure of text messages.
245
- Find the structure of a list of text messages.
244
+ <p>Find the structure of text messages.</p>
245
+ <p>Find the structure of a list of text messages.
246
246
  The messages must contain data that is suitable to be ingested into Elasticsearch.</p>
247
247
  <p>This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
248
248
  Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.</p>
@@ -402,7 +402,11 @@ class TextStructureClient(NamespacedClient):
402
402
  delimiter: t.Optional[str] = None,
403
403
  ecs_compatibility: t.Optional[str] = None,
404
404
  explain: t.Optional[bool] = None,
405
- format: t.Optional[str] = None,
405
+ format: t.Optional[
406
+ t.Union[
407
+ str, t.Literal["delimited", "ndjson", "semi_structured_text", "xml"]
408
+ ]
409
+ ] = None,
406
410
  grok_pattern: t.Optional[str] = None,
407
411
  has_header_row: t.Optional[bool] = None,
408
412
  line_merge_size_limit: t.Optional[int] = None,
@@ -416,8 +420,8 @@ class TextStructureClient(NamespacedClient):
416
420
  """
417
421
  .. raw:: html
418
422
 
419
- <p>Find the structure of a text file.
420
- The text file must contain data that is suitable to be ingested into Elasticsearch.</p>
423
+ <p>Find the structure of a text file.</p>
424
+ <p>The text file must contain data that is suitable to be ingested into Elasticsearch.</p>
421
425
  <p>This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
422
426
  Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.
423
427
  It must, however, be text; binary text formats are not currently supported.
@@ -615,8 +619,8 @@ class TextStructureClient(NamespacedClient):
615
619
  """
616
620
  .. raw:: html
617
621
 
618
- <p>Test a Grok pattern.
619
- Test a Grok pattern on one or more lines of text.
622
+ <p>Test a Grok pattern.</p>
623
+ <p>Test a Grok pattern on one or more lines of text.
620
624
  The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.</p>
621
625
 
622
626
 
@@ -85,6 +85,45 @@ class TransformClient(NamespacedClient):
85
85
  path_parts=__path_parts,
86
86
  )
87
87
 
88
+ @_rewrite_parameters()
89
+ async def get_node_stats(
90
+ self,
91
+ *,
92
+ error_trace: t.Optional[bool] = None,
93
+ filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
94
+ human: t.Optional[bool] = None,
95
+ pretty: t.Optional[bool] = None,
96
+ ) -> ObjectApiResponse[t.Any]:
97
+ """
98
+ .. raw:: html
99
+
100
+ <p>Get node stats.</p>
101
+ <p>Get per-node information about transform usage.</p>
102
+
103
+
104
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-node-stats>`_
105
+ """
106
+ __path_parts: t.Dict[str, str] = {}
107
+ __path = "/_transform/_node_stats"
108
+ __query: t.Dict[str, t.Any] = {}
109
+ if error_trace is not None:
110
+ __query["error_trace"] = error_trace
111
+ if filter_path is not None:
112
+ __query["filter_path"] = filter_path
113
+ if human is not None:
114
+ __query["human"] = human
115
+ if pretty is not None:
116
+ __query["pretty"] = pretty
117
+ __headers = {"accept": "application/json"}
118
+ return await self.perform_request( # type: ignore[return-value]
119
+ "GET",
120
+ __path,
121
+ params=__query,
122
+ headers=__headers,
123
+ endpoint_id="transform.get_node_stats",
124
+ path_parts=__path_parts,
125
+ )
126
+
88
127
  @_rewrite_parameters(
89
128
  parameter_aliases={"from": "from_"},
90
129
  )
@@ -104,8 +143,8 @@ class TransformClient(NamespacedClient):
104
143
  """
105
144
  .. raw:: html
106
145
 
107
- <p>Get transforms.
108
- Get configuration information for transforms.</p>
146
+ <p>Get transforms.</p>
147
+ <p>Get configuration information for transforms.</p>
109
148
 
110
149
 
111
150
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform>`_
@@ -262,8 +301,8 @@ class TransformClient(NamespacedClient):
262
301
  """
263
302
  .. raw:: html
264
303
 
265
- <p>Preview a transform.
266
- Generates a preview of the results that you will get when you create a transform with the same configuration.</p>
304
+ <p>Preview a transform.</p>
305
+ <p>Generates a preview of the results that you will get when you create a transform with the same configuration.</p>
267
306
  <p>It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also
268
307
  generates a list of mappings and settings for the destination index. These values are determined based on the field
269
308
  types of the source index and the transform aggregations.</p>
@@ -386,8 +425,8 @@ class TransformClient(NamespacedClient):
386
425
  """
387
426
  .. raw:: html
388
427
 
389
- <p>Create a transform.
390
- Creates a transform.</p>
428
+ <p>Create a transform.</p>
429
+ <p>Creates a transform.</p>
391
430
  <p>A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as
392
431
  a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a
393
432
  unique row per entity.</p>
@@ -616,8 +655,8 @@ class TransformClient(NamespacedClient):
616
655
  """
617
656
  .. raw:: html
618
657
 
619
- <p>Set upgrade_mode for transform indices.
620
- Sets a cluster wide upgrade_mode setting that prepares transform
658
+ <p>Set upgrade_mode for transform indices.</p>
659
+ <p>Sets a cluster wide upgrade_mode setting that prepares transform
621
660
  indices for an upgrade.
622
661
  When upgrading your cluster, in some circumstances you must restart your
623
662
  nodes and reindex your transform indices. In those circumstances,
@@ -749,8 +788,8 @@ class TransformClient(NamespacedClient):
749
788
  """
750
789
  .. raw:: html
751
790
 
752
- <p>Stop transforms.
753
- Stops one or more transforms.</p>
791
+ <p>Stop transforms.</p>
792
+ <p>Stops one or more transforms.</p>
754
793
 
755
794
 
756
795
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform>`_
@@ -846,8 +885,8 @@ class TransformClient(NamespacedClient):
846
885
  """
847
886
  .. raw:: html
848
887
 
849
- <p>Update a transform.
850
- Updates certain properties of a transform.</p>
888
+ <p>Update a transform.</p>
889
+ <p>Updates certain properties of a transform.</p>
851
890
  <p>All updated properties except <code>description</code> do not take effect until after the transform starts the next checkpoint,
852
891
  thus there is data consistency in each checkpoint. To use this API, you must have <code>read</code> and <code>view_index_metadata</code>
853
892
  privileges for the source indices. You must also have <code>index</code> and <code>read</code> privileges for the destination index. When
@@ -21,11 +21,12 @@ from ..._sync.client.utils import (
21
21
  CLIENT_META_SERVICE,
22
22
  SKIP_IN_PATH,
23
23
  Stability,
24
+ Visibility,
25
+ _availability_warning,
24
26
  _base64_auth_header,
25
27
  _quote,
26
28
  _quote_query,
27
29
  _rewrite_parameters,
28
- _stability_warning,
29
30
  client_node_configs,
30
31
  is_requests_http_auth,
31
32
  is_requests_node_class,
@@ -40,9 +41,10 @@ __all__ = [
40
41
  "_TYPE_HOSTS",
41
42
  "SKIP_IN_PATH",
42
43
  "Stability",
44
+ "Visibility",
43
45
  "client_node_configs",
44
46
  "_rewrite_parameters",
45
- "_stability_warning",
47
+ "_availability_warning",
46
48
  "is_requests_http_auth",
47
49
  "is_requests_node_class",
48
50
  ]