elasticsearch 8.17.2__py3-none-any.whl → 9.0.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 (138) hide show
  1. elasticsearch/_async/client/__init__.py +192 -312
  2. elasticsearch/_async/client/_base.py +1 -2
  3. elasticsearch/_async/client/async_search.py +14 -14
  4. elasticsearch/_async/client/autoscaling.py +4 -4
  5. elasticsearch/_async/client/cat.py +26 -33
  6. elasticsearch/_async/client/ccr.py +186 -72
  7. elasticsearch/_async/client/cluster.py +42 -23
  8. elasticsearch/_async/client/connector.py +44 -30
  9. elasticsearch/_async/client/dangling_indices.py +3 -3
  10. elasticsearch/_async/client/enrich.py +26 -5
  11. elasticsearch/_async/client/eql.py +32 -4
  12. elasticsearch/_async/client/esql.py +64 -12
  13. elasticsearch/_async/client/features.py +12 -2
  14. elasticsearch/_async/client/fleet.py +23 -19
  15. elasticsearch/_async/client/graph.py +1 -1
  16. elasticsearch/_async/client/ilm.py +30 -22
  17. elasticsearch/_async/client/indices.py +435 -231
  18. elasticsearch/_async/client/inference.py +1906 -61
  19. elasticsearch/_async/client/ingest.py +32 -38
  20. elasticsearch/_async/client/license.py +51 -16
  21. elasticsearch/_async/client/logstash.py +3 -3
  22. elasticsearch/_async/client/migration.py +3 -3
  23. elasticsearch/_async/client/ml.py +145 -121
  24. elasticsearch/_async/client/monitoring.py +1 -1
  25. elasticsearch/_async/client/nodes.py +10 -28
  26. elasticsearch/_async/client/query_rules.py +8 -8
  27. elasticsearch/_async/client/rollup.py +8 -8
  28. elasticsearch/_async/client/search_application.py +13 -13
  29. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  30. elasticsearch/_async/client/security.py +78 -75
  31. elasticsearch/_async/client/shutdown.py +3 -10
  32. elasticsearch/_async/client/simulate.py +6 -6
  33. elasticsearch/_async/client/slm.py +9 -9
  34. elasticsearch/_async/client/snapshot.py +280 -134
  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 -9
  39. elasticsearch/_async/client/text_structure.py +4 -4
  40. elasticsearch/_async/client/transform.py +30 -28
  41. elasticsearch/_async/client/watcher.py +23 -15
  42. elasticsearch/_async/client/xpack.py +2 -2
  43. elasticsearch/_async/helpers.py +0 -1
  44. elasticsearch/_sync/client/__init__.py +192 -312
  45. elasticsearch/_sync/client/_base.py +1 -2
  46. elasticsearch/_sync/client/async_search.py +14 -14
  47. elasticsearch/_sync/client/autoscaling.py +4 -4
  48. elasticsearch/_sync/client/cat.py +26 -33
  49. elasticsearch/_sync/client/ccr.py +186 -72
  50. elasticsearch/_sync/client/cluster.py +42 -23
  51. elasticsearch/_sync/client/connector.py +44 -30
  52. elasticsearch/_sync/client/dangling_indices.py +3 -3
  53. elasticsearch/_sync/client/enrich.py +26 -5
  54. elasticsearch/_sync/client/eql.py +32 -4
  55. elasticsearch/_sync/client/esql.py +64 -12
  56. elasticsearch/_sync/client/features.py +12 -2
  57. elasticsearch/_sync/client/fleet.py +23 -19
  58. elasticsearch/_sync/client/graph.py +1 -1
  59. elasticsearch/_sync/client/ilm.py +30 -22
  60. elasticsearch/_sync/client/indices.py +435 -231
  61. elasticsearch/_sync/client/inference.py +1906 -61
  62. elasticsearch/_sync/client/ingest.py +32 -38
  63. elasticsearch/_sync/client/license.py +51 -16
  64. elasticsearch/_sync/client/logstash.py +3 -3
  65. elasticsearch/_sync/client/migration.py +3 -3
  66. elasticsearch/_sync/client/ml.py +145 -121
  67. elasticsearch/_sync/client/monitoring.py +1 -1
  68. elasticsearch/_sync/client/nodes.py +10 -28
  69. elasticsearch/_sync/client/query_rules.py +8 -8
  70. elasticsearch/_sync/client/rollup.py +8 -8
  71. elasticsearch/_sync/client/search_application.py +13 -13
  72. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  73. elasticsearch/_sync/client/security.py +78 -75
  74. elasticsearch/_sync/client/shutdown.py +3 -10
  75. elasticsearch/_sync/client/simulate.py +6 -6
  76. elasticsearch/_sync/client/slm.py +9 -9
  77. elasticsearch/_sync/client/snapshot.py +280 -134
  78. elasticsearch/_sync/client/sql.py +6 -6
  79. elasticsearch/_sync/client/ssl.py +1 -1
  80. elasticsearch/_sync/client/synonyms.py +7 -7
  81. elasticsearch/_sync/client/tasks.py +3 -9
  82. elasticsearch/_sync/client/text_structure.py +4 -4
  83. elasticsearch/_sync/client/transform.py +30 -28
  84. elasticsearch/_sync/client/utils.py +0 -40
  85. elasticsearch/_sync/client/watcher.py +23 -15
  86. elasticsearch/_sync/client/xpack.py +2 -2
  87. elasticsearch/_version.py +1 -1
  88. elasticsearch/dsl/__init__.py +203 -0
  89. elasticsearch/dsl/_async/__init__.py +16 -0
  90. elasticsearch/dsl/_async/document.py +522 -0
  91. elasticsearch/dsl/_async/faceted_search.py +50 -0
  92. elasticsearch/dsl/_async/index.py +639 -0
  93. elasticsearch/dsl/_async/mapping.py +49 -0
  94. elasticsearch/dsl/_async/search.py +237 -0
  95. elasticsearch/dsl/_async/update_by_query.py +47 -0
  96. elasticsearch/dsl/_sync/__init__.py +16 -0
  97. elasticsearch/dsl/_sync/document.py +514 -0
  98. elasticsearch/dsl/_sync/faceted_search.py +50 -0
  99. elasticsearch/dsl/_sync/index.py +597 -0
  100. elasticsearch/dsl/_sync/mapping.py +49 -0
  101. elasticsearch/dsl/_sync/search.py +230 -0
  102. elasticsearch/dsl/_sync/update_by_query.py +45 -0
  103. elasticsearch/dsl/aggs.py +3734 -0
  104. elasticsearch/dsl/analysis.py +341 -0
  105. elasticsearch/dsl/async_connections.py +37 -0
  106. elasticsearch/dsl/connections.py +142 -0
  107. elasticsearch/dsl/document.py +20 -0
  108. elasticsearch/dsl/document_base.py +444 -0
  109. elasticsearch/dsl/exceptions.py +32 -0
  110. elasticsearch/dsl/faceted_search.py +28 -0
  111. elasticsearch/dsl/faceted_search_base.py +489 -0
  112. elasticsearch/dsl/field.py +4392 -0
  113. elasticsearch/dsl/function.py +180 -0
  114. elasticsearch/dsl/index.py +23 -0
  115. elasticsearch/dsl/index_base.py +178 -0
  116. elasticsearch/dsl/mapping.py +19 -0
  117. elasticsearch/dsl/mapping_base.py +219 -0
  118. elasticsearch/dsl/query.py +2822 -0
  119. elasticsearch/dsl/response/__init__.py +388 -0
  120. elasticsearch/dsl/response/aggs.py +100 -0
  121. elasticsearch/dsl/response/hit.py +53 -0
  122. elasticsearch/dsl/search.py +20 -0
  123. elasticsearch/dsl/search_base.py +1053 -0
  124. elasticsearch/dsl/serializer.py +34 -0
  125. elasticsearch/dsl/types.py +6453 -0
  126. elasticsearch/dsl/update_by_query.py +19 -0
  127. elasticsearch/dsl/update_by_query_base.py +149 -0
  128. elasticsearch/dsl/utils.py +687 -0
  129. elasticsearch/dsl/wrappers.py +144 -0
  130. elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
  131. elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
  132. {elasticsearch-8.17.2.dist-info → elasticsearch-9.0.0.dist-info}/METADATA +12 -15
  133. elasticsearch-9.0.0.dist-info/RECORD +160 -0
  134. elasticsearch/transport.py +0 -57
  135. elasticsearch-8.17.2.dist-info/RECORD +0 -119
  136. {elasticsearch-8.17.2.dist-info → elasticsearch-9.0.0.dist-info}/WHEEL +0 -0
  137. {elasticsearch-8.17.2.dist-info → elasticsearch-9.0.0.dist-info}/licenses/LICENSE +0 -0
  138. {elasticsearch-8.17.2.dist-info → elasticsearch-9.0.0.dist-info}/licenses/NOTICE +0 -0
@@ -44,7 +44,7 @@ class SqlClient(NamespacedClient):
44
44
  <p>Clear an SQL search cursor.</p>
45
45
 
46
46
 
47
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-sql-cursor-api.html>`_
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-clear-cursor>`_
48
48
 
49
49
  :param cursor: Cursor to clear.
50
50
  """
@@ -99,7 +99,7 @@ class SqlClient(NamespacedClient):
99
99
  </ul>
100
100
 
101
101
 
102
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-async-sql-search-api.html>`_
102
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-delete-async>`_
103
103
 
104
104
  :param id: The identifier for the search.
105
105
  """
@@ -150,7 +150,7 @@ class SqlClient(NamespacedClient):
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
 
153
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-sql-search-api.html>`_
153
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async>`_
154
154
 
155
155
  :param id: The identifier for the search.
156
156
  :param delimiter: The separator for CSV results. The API supports this parameter
@@ -212,7 +212,7 @@ class SqlClient(NamespacedClient):
212
212
  Get the current status of an async SQL search or a stored synchronous SQL search.</p>
213
213
 
214
214
 
215
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-sql-search-status-api.html>`_
215
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async-status>`_
216
216
 
217
217
  :param id: The identifier for the search.
218
218
  """
@@ -301,7 +301,7 @@ class SqlClient(NamespacedClient):
301
301
  Run an SQL request.</p>
302
302
 
303
303
 
304
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/sql-search-api.html>`_
304
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-query>`_
305
305
 
306
306
  :param allow_partial_search_results: If `true`, the response has partial results
307
307
  when there are shard request timeouts or shard failures. If `false`, the
@@ -427,7 +427,7 @@ class SqlClient(NamespacedClient):
427
427
  It accepts the same request body parameters as the SQL search API, excluding <code>cursor</code>.</p>
428
428
 
429
429
 
430
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/sql-translate-api.html>`_
430
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-translate>`_
431
431
 
432
432
  :param query: The SQL query to run.
433
433
  :param fetch_size: The maximum number of rows (or entries) to return in one response.
@@ -52,7 +52,7 @@ class SslClient(NamespacedClient):
52
52
  <p>If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.</p>
53
53
 
54
54
 
55
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-ssl.html>`_
55
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ssl-certificates>`_
56
56
  """
57
57
  __path_parts: t.Dict[str, str] = {}
58
58
  __path = "/_ssl/certificates"
@@ -53,7 +53,7 @@ class SynonymsClient(NamespacedClient):
53
53
  When the synonyms set is not used in analyzers, you will be able to delete it.</p>
54
54
 
55
55
 
56
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-synonyms-set.html>`_
56
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym>`_
57
57
 
58
58
  :param id: The synonyms set identifier to delete.
59
59
  """
@@ -98,7 +98,7 @@ class SynonymsClient(NamespacedClient):
98
98
  Delete a synonym rule from a synonym set.</p>
99
99
 
100
100
 
101
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-synonym-rule.html>`_
101
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym-rule>`_
102
102
 
103
103
  :param set_id: The ID of the synonym set to update.
104
104
  :param rule_id: The ID of the synonym rule to delete.
@@ -151,7 +151,7 @@ class SynonymsClient(NamespacedClient):
151
151
  <p>Get a synonym set.</p>
152
152
 
153
153
 
154
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonyms-set.html>`_
154
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym>`_
155
155
 
156
156
  :param id: The synonyms set identifier to retrieve.
157
157
  :param from_: The starting offset for query rules to retrieve.
@@ -202,7 +202,7 @@ class SynonymsClient(NamespacedClient):
202
202
  Get a synonym rule from a synonym set.</p>
203
203
 
204
204
 
205
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonym-rule.html>`_
205
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym-rule>`_
206
206
 
207
207
  :param set_id: The ID of the synonym set to retrieve the synonym rule from.
208
208
  :param rule_id: The ID of the synonym rule to retrieve.
@@ -255,7 +255,7 @@ class SynonymsClient(NamespacedClient):
255
255
  Get a summary of all defined synonym sets.</p>
256
256
 
257
257
 
258
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonyms-set.html>`_
258
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym>`_
259
259
 
260
260
  :param from_: The starting offset for synonyms sets to retrieve.
261
261
  :param size: The maximum number of synonyms sets to retrieve.
@@ -311,7 +311,7 @@ class SynonymsClient(NamespacedClient):
311
311
  This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.</p>
312
312
 
313
313
 
314
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-synonyms-set.html>`_
314
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym>`_
315
315
 
316
316
  :param id: The ID of the synonyms set to be created or updated.
317
317
  :param synonyms_set: The synonym rules definitions for the synonyms set.
@@ -370,7 +370,7 @@ class SynonymsClient(NamespacedClient):
370
370
  <p>When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.</p>
371
371
 
372
372
 
373
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-synonym-rule.html>`_
373
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym-rule>`_
374
374
 
375
375
  :param set_id: The ID of the synonym set.
376
376
  :param rule_id: The ID of the synonym rule to be updated or created.
@@ -60,7 +60,7 @@ class TasksClient(NamespacedClient):
60
60
  You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.</p>
61
61
 
62
62
 
63
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
63
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks>`_
64
64
 
65
65
  :param task_id: The task identifier.
66
66
  :param actions: A comma-separated list or wildcard expression of actions that
@@ -128,7 +128,7 @@ class TasksClient(NamespacedClient):
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>
129
129
 
130
130
 
131
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
131
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks>`_
132
132
 
133
133
  :param task_id: The task identifier.
134
134
  :param timeout: The period to wait for a response. If no response is received
@@ -176,7 +176,6 @@ class TasksClient(NamespacedClient):
176
176
  t.Union[str, t.Literal["nodes", "none", "parents"]]
177
177
  ] = None,
178
178
  human: t.Optional[bool] = None,
179
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
180
179
  nodes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
181
180
  parent_task_id: t.Optional[str] = None,
182
181
  pretty: t.Optional[bool] = None,
@@ -239,7 +238,7 @@ class TasksClient(NamespacedClient):
239
238
  The <code>X-Opaque-Id</code> in the children <code>headers</code> is the child task of the task that was initiated by the REST request.</p>
240
239
 
241
240
 
242
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
241
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks>`_
243
242
 
244
243
  :param actions: A comma-separated list or wildcard expression of actions used
245
244
  to limit the request. For example, you can use `cluser:*` to retrieve all
@@ -249,9 +248,6 @@ class TasksClient(NamespacedClient):
249
248
  other but is more costly to run.
250
249
  :param group_by: A key that is used to group tasks in the response. The task
251
250
  lists can be grouped either by nodes or by parent tasks.
252
- :param master_timeout: The period to wait for a connection to the master node.
253
- If no response is received before the timeout expires, the request fails
254
- and returns an error.
255
251
  :param nodes: A comma-separated list of node IDs or names that is used to limit
256
252
  the returned information.
257
253
  :param parent_task_id: A parent task identifier that is used to limit returned
@@ -278,8 +274,6 @@ class TasksClient(NamespacedClient):
278
274
  __query["group_by"] = group_by
279
275
  if human is not None:
280
276
  __query["human"] = human
281
- if master_timeout is not None:
282
- __query["master_timeout"] = master_timeout
283
277
  if nodes is not None:
284
278
  __query["nodes"] = nodes
285
279
  if parent_task_id is not None:
@@ -72,7 +72,7 @@ class TextStructureClient(NamespacedClient):
72
72
  It helps determine why the returned structure was chosen.</p>
73
73
 
74
74
 
75
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-field-structure.html>`_
75
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-text_structure>`_
76
76
 
77
77
  :param field: The field that should be analyzed.
78
78
  :param index: The name of the index that contains the analyzed field.
@@ -259,7 +259,7 @@ class TextStructureClient(NamespacedClient):
259
259
  It helps determine why the returned structure was chosen.</p>
260
260
 
261
261
 
262
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-message-structure.html>`_
262
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-find-message-structure>`_
263
263
 
264
264
  :param messages: The list of messages you want to analyze.
265
265
  :param column_names: If the format is `delimited`, you can specify the column
@@ -433,7 +433,7 @@ class TextStructureClient(NamespacedClient):
433
433
  However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.</p>
434
434
 
435
435
 
436
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-structure.html>`_
436
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-find-structure>`_
437
437
 
438
438
  :param text_files:
439
439
  :param charset: The text's character set. It must be a character set that is
@@ -620,7 +620,7 @@ class TextStructureClient(NamespacedClient):
620
620
  The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.</p>
621
621
 
622
622
 
623
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/test-grok-pattern.html>`_
623
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-test-grok-pattern>`_
624
624
 
625
625
  :param grok_pattern: The Grok pattern to run on the text.
626
626
  :param text: The lines of text to run the Grok pattern on.
@@ -41,11 +41,10 @@ class TransformClient(NamespacedClient):
41
41
  """
42
42
  .. raw:: html
43
43
 
44
- <p>Delete a transform.
45
- Deletes a transform.</p>
44
+ <p>Delete a transform.</p>
46
45
 
47
46
 
48
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-transform.html>`_
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-delete-transform>`_
49
48
 
50
49
  :param transform_id: Identifier for the transform.
51
50
  :param delete_dest_index: If this value is true, the destination index is deleted
@@ -106,10 +105,10 @@ class TransformClient(NamespacedClient):
106
105
  .. raw:: html
107
106
 
108
107
  <p>Get transforms.
109
- Retrieves configuration information for transforms.</p>
108
+ Get configuration information for transforms.</p>
110
109
 
111
110
 
112
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform.html>`_
111
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform>`_
113
112
 
114
113
  :param transform_id: Identifier for the transform. It can be a transform identifier
115
114
  or a wildcard expression. You can get information for all transforms by using
@@ -178,11 +177,11 @@ class TransformClient(NamespacedClient):
178
177
  """
179
178
  .. raw:: html
180
179
 
181
- <p>Get transform stats.
182
- Retrieves usage information for transforms.</p>
180
+ <p>Get transform stats.</p>
181
+ <p>Get usage information for transforms.</p>
183
182
 
184
183
 
185
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform-stats.html>`_
184
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform-stats>`_
186
185
 
187
186
  :param transform_id: Identifier for the transform. It can be a transform identifier
188
187
  or a wildcard expression. You can get information for all transforms by using
@@ -270,7 +269,7 @@ class TransformClient(NamespacedClient):
270
269
  types of the source index and the transform aggregations.</p>
271
270
 
272
271
 
273
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/preview-transform.html>`_
272
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-preview-transform>`_
274
273
 
275
274
  :param transform_id: Identifier for the transform to preview. If you specify
276
275
  this path parameter, you cannot provide transform configuration details in
@@ -407,7 +406,7 @@ class TransformClient(NamespacedClient):
407
406
  give users any privileges on <code>.data-frame-internal*</code> indices.</p>
408
407
 
409
408
 
410
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-transform.html>`_
409
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-put-transform>`_
411
410
 
412
411
  :param transform_id: Identifier for the transform. This identifier can contain
413
412
  lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
@@ -503,17 +502,17 @@ class TransformClient(NamespacedClient):
503
502
  force: t.Optional[bool] = None,
504
503
  human: t.Optional[bool] = None,
505
504
  pretty: t.Optional[bool] = None,
505
+ timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
506
506
  ) -> ObjectApiResponse[t.Any]:
507
507
  """
508
508
  .. raw:: html
509
509
 
510
- <p>Reset a transform.
511
- Resets a transform.
512
- Before you can reset it, you must stop it; alternatively, use the <code>force</code> query parameter.
510
+ <p>Reset a transform.</p>
511
+ <p>Before you can reset it, you must stop it; alternatively, use the <code>force</code> query parameter.
513
512
  If the destination index was created by the transform, it is deleted.</p>
514
513
 
515
514
 
516
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/reset-transform.html>`_
515
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-reset-transform>`_
517
516
 
518
517
  :param transform_id: Identifier for the transform. This identifier can contain
519
518
  lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
@@ -521,6 +520,8 @@ class TransformClient(NamespacedClient):
521
520
  :param force: If this value is `true`, the transform is reset regardless of its
522
521
  current state. If it's `false`, the transform must be stopped before it can
523
522
  be reset.
523
+ :param timeout: Period to wait for a response. If no response is received before
524
+ the timeout expires, the request fails and returns an error.
524
525
  """
525
526
  if transform_id in SKIP_IN_PATH:
526
527
  raise ValueError("Empty value passed for parameter 'transform_id'")
@@ -537,6 +538,8 @@ class TransformClient(NamespacedClient):
537
538
  __query["human"] = human
538
539
  if pretty is not None:
539
540
  __query["pretty"] = pretty
541
+ if timeout is not None:
542
+ __query["timeout"] = timeout
540
543
  __headers = {"accept": "application/json"}
541
544
  return await self.perform_request( # type: ignore[return-value]
542
545
  "POST",
@@ -561,15 +564,15 @@ class TransformClient(NamespacedClient):
561
564
  """
562
565
  .. raw:: html
563
566
 
564
- <p>Schedule a transform to start now.
565
- Instantly runs a transform to process data.</p>
566
- <p>If you _schedule_now a transform, it will process the new data instantly,
567
- without waiting for the configured frequency interval. After _schedule_now API is called,
568
- the transform will be processed again at now + frequency unless _schedule_now API
567
+ <p>Schedule a transform to start now.</p>
568
+ <p>Instantly run a transform to process data.
569
+ If you run this API, the transform will process the new data instantly,
570
+ without waiting for the configured frequency interval. After the API is called,
571
+ the transform will be processed again at <code>now + frequency</code> unless the API
569
572
  is called again in the meantime.</p>
570
573
 
571
574
 
572
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/schedule-now-transform.html>`_
575
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-schedule-now-transform>`_
573
576
 
574
577
  :param transform_id: Identifier for the transform.
575
578
  :param timeout: Controls the time to wait for the scheduling to take place
@@ -616,8 +619,7 @@ class TransformClient(NamespacedClient):
616
619
  """
617
620
  .. raw:: html
618
621
 
619
- <p>Start a transform.
620
- Starts a transform.</p>
622
+ <p>Start a transform.</p>
621
623
  <p>When you start a transform, it creates the destination index if it does not already exist. The <code>number_of_shards</code> is
622
624
  set to <code>1</code> and the <code>auto_expand_replicas</code> is set to <code>0-1</code>. If it is a pivot transform, it deduces the mapping
623
625
  definitions for the destination index from the source indices and the transform aggregations. If fields in the
@@ -633,7 +635,7 @@ class TransformClient(NamespacedClient):
633
635
  destination indices, the transform fails when it attempts unauthorized operations.</p>
634
636
 
635
637
 
636
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-transform.html>`_
638
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-start-transform>`_
637
639
 
638
640
  :param transform_id: Identifier for the transform.
639
641
  :param from_: Restricts the set of transformed entities to those changed after
@@ -691,7 +693,7 @@ class TransformClient(NamespacedClient):
691
693
  Stops one or more transforms.</p>
692
694
 
693
695
 
694
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/stop-transform.html>`_
696
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-stop-transform>`_
695
697
 
696
698
  :param transform_id: Identifier for the transform. To stop multiple transforms,
697
699
  use a comma-separated list or a wildcard expression. To stop all transforms,
@@ -793,7 +795,7 @@ class TransformClient(NamespacedClient):
793
795
  time of update and runs with those privileges.</p>
794
796
 
795
797
 
796
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-transform.html>`_
798
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-update-transform>`_
797
799
 
798
800
  :param transform_id: Identifier for the transform.
799
801
  :param defer_validation: When true, deferrable validations are not run. This
@@ -874,8 +876,8 @@ class TransformClient(NamespacedClient):
874
876
  """
875
877
  .. raw:: html
876
878
 
877
- <p>Upgrade all transforms.
878
- Transforms are compatible across minor versions and between supported major versions.
879
+ <p>Upgrade all transforms.</p>
880
+ <p>Transforms are compatible across minor versions and between supported major versions.
879
881
  However, over time, the format of transform configuration information may change.
880
882
  This API identifies transforms that have a legacy configuration format and upgrades them to the latest version.
881
883
  It also cleans up the internal data structures that store the transform state and checkpoints.
@@ -888,7 +890,7 @@ class TransformClient(NamespacedClient):
888
890
  You may want to perform a recent cluster backup prior to the upgrade.</p>
889
891
 
890
892
 
891
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/upgrade-transforms.html>`_
893
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-upgrade-transforms>`_
892
894
 
893
895
  :param dry_run: When true, the request checks for updates but does not run them.
894
896
  :param timeout: Period to wait for a response. If no response is received before
@@ -48,7 +48,7 @@ class WatcherClient(NamespacedClient):
48
48
  This happens when the condition of the watch is not met (the condition evaluates to false).</p>
49
49
 
50
50
 
51
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-ack-watch.html>`_
51
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-ack-watch>`_
52
52
 
53
53
  :param watch_id: The watch identifier.
54
54
  :param action_id: A comma-separated list of the action identifiers to acknowledge.
@@ -104,7 +104,7 @@ class WatcherClient(NamespacedClient):
104
104
  A watch can be either active or inactive.</p>
105
105
 
106
106
 
107
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-activate-watch.html>`_
107
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-activate-watch>`_
108
108
 
109
109
  :param watch_id: The watch identifier.
110
110
  """
@@ -148,7 +148,7 @@ class WatcherClient(NamespacedClient):
148
148
  A watch can be either active or inactive.</p>
149
149
 
150
150
 
151
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-deactivate-watch.html>`_
151
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-deactivate-watch>`_
152
152
 
153
153
  :param watch_id: The watch identifier.
154
154
  """
@@ -196,7 +196,7 @@ class WatcherClient(NamespacedClient):
196
196
  When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the <code>.watches</code> index.</p>
197
197
 
198
198
 
199
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-delete-watch.html>`_
199
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-delete-watch>`_
200
200
 
201
201
  :param id: The watch identifier.
202
202
  """
@@ -277,7 +277,7 @@ class WatcherClient(NamespacedClient):
277
277
  <p>When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.</p>
278
278
 
279
279
 
280
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-execute-watch.html>`_
280
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-execute-watch>`_
281
281
 
282
282
  :param id: The watch identifier.
283
283
  :param action_modes: Determines how to handle the watch actions as part of the
@@ -365,7 +365,7 @@ class WatcherClient(NamespacedClient):
365
365
  Only a subset of settings are shown, for example <code>index.auto_expand_replicas</code> and <code>index.number_of_replicas</code>.</p>
366
366
 
367
367
 
368
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-settings.html>`_
368
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-settings>`_
369
369
 
370
370
  :param master_timeout: The period to wait for a connection to the master node.
371
371
  If no response is received before the timeout expires, the request fails
@@ -410,7 +410,7 @@ class WatcherClient(NamespacedClient):
410
410
  <p>Get a watch.</p>
411
411
 
412
412
 
413
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-watch.html>`_
413
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-watch>`_
414
414
 
415
415
  :param id: The watch identifier.
416
416
  """
@@ -485,7 +485,7 @@ class WatcherClient(NamespacedClient):
485
485
  If the user is able to read index <code>a</code>, but not index <code>b</code>, the same will apply when the watch runs.</p>
486
486
 
487
487
 
488
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-put-watch.html>`_
488
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-put-watch>`_
489
489
 
490
490
  :param id: The identifier for the watch.
491
491
  :param actions: The list of actions that will be run if the condition matches.
@@ -579,7 +579,7 @@ class WatcherClient(NamespacedClient):
579
579
  pretty: t.Optional[bool] = None,
580
580
  query: t.Optional[t.Mapping[str, t.Any]] = None,
581
581
  search_after: t.Optional[
582
- t.Sequence[t.Union[None, bool, float, int, str, t.Any]]
582
+ t.Sequence[t.Union[None, bool, float, int, str]]
583
583
  ] = None,
584
584
  size: t.Optional[int] = None,
585
585
  sort: t.Optional[
@@ -598,7 +598,7 @@ class WatcherClient(NamespacedClient):
598
598
  <p>Note that only the <code>_id</code> and <code>metadata.*</code> fields are queryable or sortable.</p>
599
599
 
600
600
 
601
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-query-watches.html>`_
601
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-query-watches>`_
602
602
 
603
603
  :param from_: The offset from the first result to fetch. It must be non-negative.
604
604
  :param query: A query that filters the watches to be returned.
@@ -663,6 +663,7 @@ class WatcherClient(NamespacedClient):
663
663
  error_trace: t.Optional[bool] = None,
664
664
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
665
665
  human: t.Optional[bool] = None,
666
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
666
667
  pretty: t.Optional[bool] = None,
667
668
  ) -> ObjectApiResponse[t.Any]:
668
669
  """
@@ -672,7 +673,9 @@ class WatcherClient(NamespacedClient):
672
673
  Start the Watcher service if it is not already running.</p>
673
674
 
674
675
 
675
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-start.html>`_
676
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-start>`_
677
+
678
+ :param master_timeout: Period to wait for a connection to the master node.
676
679
  """
677
680
  __path_parts: t.Dict[str, str] = {}
678
681
  __path = "/_watcher/_start"
@@ -683,6 +686,8 @@ class WatcherClient(NamespacedClient):
683
686
  __query["filter_path"] = filter_path
684
687
  if human is not None:
685
688
  __query["human"] = human
689
+ if master_timeout is not None:
690
+ __query["master_timeout"] = master_timeout
686
691
  if pretty is not None:
687
692
  __query["pretty"] = pretty
688
693
  __headers = {"accept": "application/json"}
@@ -734,7 +739,7 @@ class WatcherClient(NamespacedClient):
734
739
  You retrieve more metrics by using the metric parameter.</p>
735
740
 
736
741
 
737
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stats.html>`_
742
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-stats>`_
738
743
 
739
744
  :param metric: Defines which additional metrics are included in the response.
740
745
  :param emit_stacktraces: Defines whether stack traces are generated for each
@@ -785,7 +790,7 @@ class WatcherClient(NamespacedClient):
785
790
  Stop the Watcher service if it is running.</p>
786
791
 
787
792
 
788
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stop.html>`_
793
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-stop>`_
789
794
 
790
795
  :param master_timeout: The period to wait for the master node. If the master
791
796
  node is not available before the timeout expires, the request fails and returns
@@ -840,10 +845,13 @@ class WatcherClient(NamespacedClient):
840
845
  <p>Update Watcher index settings.
841
846
  Update settings for the Watcher internal index (<code>.watches</code>).
842
847
  Only a subset of settings can be modified.
843
- This includes <code>index.auto_expand_replicas</code> and <code>index.number_of_replicas</code>.</p>
848
+ This includes <code>index.auto_expand_replicas</code>, <code>index.number_of_replicas</code>, <code>index.routing.allocation.exclude.*</code>,
849
+ <code>index.routing.allocation.include.*</code> and <code>index.routing.allocation.require.*</code>.
850
+ Modification of <code>index.routing.allocation.include._tier_preference</code> is an exception and is not allowed as the
851
+ Watcher shards must always be in the <code>data_content</code> tier.</p>
844
852
 
845
853
 
846
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-update-settings.html>`_
854
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-update-settings>`_
847
855
 
848
856
  :param index_auto_expand_replicas:
849
857
  :param index_number_of_replicas:
@@ -54,7 +54,7 @@ class XPackClient(NamespacedClient):
54
54
  </ul>
55
55
 
56
56
 
57
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/info-api.html>`_
57
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-info>`_
58
58
 
59
59
  :param accept_enterprise: If this param is used it must be set to true
60
60
  :param categories: A comma-separated list of the information categories to include
@@ -103,7 +103,7 @@ class XPackClient(NamespacedClient):
103
103
  The API also provides some usage statistics.</p>
104
104
 
105
105
 
106
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/usage-api.html>`_
106
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack>`_
107
107
 
108
108
  :param master_timeout: The period to wait for a connection to the master node.
109
109
  If no response is received before the timeout expires, the request fails
@@ -136,7 +136,6 @@ def aiter(x: Union[Iterable[T], AsyncIterable[T]]) -> AsyncIterator[T]:
136
136
  return x.__aiter__()
137
137
 
138
138
  async def f() -> AsyncIterable[T]:
139
- nonlocal x
140
139
  ix: Iterable[T] = x
141
140
  for item in ix:
142
141
  yield item