elasticsearch 8.17.1__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 (142) hide show
  1. elasticsearch/__init__.py +2 -2
  2. elasticsearch/_async/client/__init__.py +2125 -1053
  3. elasticsearch/_async/client/_base.py +1 -2
  4. elasticsearch/_async/client/async_search.py +46 -35
  5. elasticsearch/_async/client/autoscaling.py +32 -26
  6. elasticsearch/_async/client/cat.py +244 -176
  7. elasticsearch/_async/client/ccr.py +268 -128
  8. elasticsearch/_async/client/cluster.py +191 -164
  9. elasticsearch/_async/client/connector.py +226 -116
  10. elasticsearch/_async/client/dangling_indices.py +22 -16
  11. elasticsearch/_async/client/enrich.py +51 -11
  12. elasticsearch/_async/client/eql.py +54 -13
  13. elasticsearch/_async/client/esql.py +351 -7
  14. elasticsearch/_async/client/features.py +37 -27
  15. elasticsearch/_async/client/fleet.py +32 -22
  16. elasticsearch/_async/client/graph.py +10 -9
  17. elasticsearch/_async/client/ilm.py +115 -77
  18. elasticsearch/_async/client/indices.py +1119 -772
  19. elasticsearch/_async/client/inference.py +1933 -84
  20. elasticsearch/_async/client/ingest.py +83 -50
  21. elasticsearch/_async/client/license.py +90 -38
  22. elasticsearch/_async/client/logstash.py +20 -9
  23. elasticsearch/_async/client/migration.py +26 -17
  24. elasticsearch/_async/client/ml.py +646 -374
  25. elasticsearch/_async/client/monitoring.py +6 -3
  26. elasticsearch/_async/client/nodes.py +52 -54
  27. elasticsearch/_async/client/query_rules.py +59 -33
  28. elasticsearch/_async/client/rollup.py +124 -86
  29. elasticsearch/_async/client/search_application.py +60 -32
  30. elasticsearch/_async/client/searchable_snapshots.py +25 -12
  31. elasticsearch/_async/client/security.py +903 -562
  32. elasticsearch/_async/client/shutdown.py +34 -36
  33. elasticsearch/_async/client/simulate.py +22 -28
  34. elasticsearch/_async/client/slm.py +65 -40
  35. elasticsearch/_async/client/snapshot.py +454 -327
  36. elasticsearch/_async/client/sql.py +43 -22
  37. elasticsearch/_async/client/ssl.py +17 -18
  38. elasticsearch/_async/client/synonyms.py +58 -37
  39. elasticsearch/_async/client/tasks.py +77 -48
  40. elasticsearch/_async/client/text_structure.py +65 -56
  41. elasticsearch/_async/client/transform.py +124 -93
  42. elasticsearch/_async/client/watcher.py +117 -73
  43. elasticsearch/_async/client/xpack.py +18 -9
  44. elasticsearch/_async/helpers.py +1 -2
  45. elasticsearch/_sync/client/__init__.py +2125 -1053
  46. elasticsearch/_sync/client/_base.py +1 -2
  47. elasticsearch/_sync/client/async_search.py +46 -35
  48. elasticsearch/_sync/client/autoscaling.py +32 -26
  49. elasticsearch/_sync/client/cat.py +244 -176
  50. elasticsearch/_sync/client/ccr.py +268 -128
  51. elasticsearch/_sync/client/cluster.py +191 -164
  52. elasticsearch/_sync/client/connector.py +226 -116
  53. elasticsearch/_sync/client/dangling_indices.py +22 -16
  54. elasticsearch/_sync/client/enrich.py +51 -11
  55. elasticsearch/_sync/client/eql.py +54 -13
  56. elasticsearch/_sync/client/esql.py +351 -7
  57. elasticsearch/_sync/client/features.py +37 -27
  58. elasticsearch/_sync/client/fleet.py +32 -22
  59. elasticsearch/_sync/client/graph.py +10 -9
  60. elasticsearch/_sync/client/ilm.py +115 -77
  61. elasticsearch/_sync/client/indices.py +1119 -772
  62. elasticsearch/_sync/client/inference.py +1933 -84
  63. elasticsearch/_sync/client/ingest.py +83 -50
  64. elasticsearch/_sync/client/license.py +90 -38
  65. elasticsearch/_sync/client/logstash.py +20 -9
  66. elasticsearch/_sync/client/migration.py +26 -17
  67. elasticsearch/_sync/client/ml.py +646 -374
  68. elasticsearch/_sync/client/monitoring.py +6 -3
  69. elasticsearch/_sync/client/nodes.py +52 -54
  70. elasticsearch/_sync/client/query_rules.py +59 -33
  71. elasticsearch/_sync/client/rollup.py +124 -86
  72. elasticsearch/_sync/client/search_application.py +60 -32
  73. elasticsearch/_sync/client/searchable_snapshots.py +25 -12
  74. elasticsearch/_sync/client/security.py +903 -562
  75. elasticsearch/_sync/client/shutdown.py +34 -36
  76. elasticsearch/_sync/client/simulate.py +22 -28
  77. elasticsearch/_sync/client/slm.py +65 -40
  78. elasticsearch/_sync/client/snapshot.py +454 -327
  79. elasticsearch/_sync/client/sql.py +43 -22
  80. elasticsearch/_sync/client/ssl.py +17 -18
  81. elasticsearch/_sync/client/synonyms.py +58 -37
  82. elasticsearch/_sync/client/tasks.py +77 -48
  83. elasticsearch/_sync/client/text_structure.py +65 -56
  84. elasticsearch/_sync/client/transform.py +124 -93
  85. elasticsearch/_sync/client/utils.py +1 -41
  86. elasticsearch/_sync/client/watcher.py +117 -73
  87. elasticsearch/_sync/client/xpack.py +18 -9
  88. elasticsearch/_version.py +1 -1
  89. elasticsearch/client.py +2 -0
  90. elasticsearch/dsl/__init__.py +203 -0
  91. elasticsearch/dsl/_async/__init__.py +16 -0
  92. elasticsearch/dsl/_async/document.py +522 -0
  93. elasticsearch/dsl/_async/faceted_search.py +50 -0
  94. elasticsearch/dsl/_async/index.py +639 -0
  95. elasticsearch/dsl/_async/mapping.py +49 -0
  96. elasticsearch/dsl/_async/search.py +237 -0
  97. elasticsearch/dsl/_async/update_by_query.py +47 -0
  98. elasticsearch/dsl/_sync/__init__.py +16 -0
  99. elasticsearch/dsl/_sync/document.py +514 -0
  100. elasticsearch/dsl/_sync/faceted_search.py +50 -0
  101. elasticsearch/dsl/_sync/index.py +597 -0
  102. elasticsearch/dsl/_sync/mapping.py +49 -0
  103. elasticsearch/dsl/_sync/search.py +230 -0
  104. elasticsearch/dsl/_sync/update_by_query.py +45 -0
  105. elasticsearch/dsl/aggs.py +3734 -0
  106. elasticsearch/dsl/analysis.py +341 -0
  107. elasticsearch/dsl/async_connections.py +37 -0
  108. elasticsearch/dsl/connections.py +142 -0
  109. elasticsearch/dsl/document.py +20 -0
  110. elasticsearch/dsl/document_base.py +444 -0
  111. elasticsearch/dsl/exceptions.py +32 -0
  112. elasticsearch/dsl/faceted_search.py +28 -0
  113. elasticsearch/dsl/faceted_search_base.py +489 -0
  114. elasticsearch/dsl/field.py +4392 -0
  115. elasticsearch/dsl/function.py +180 -0
  116. elasticsearch/dsl/index.py +23 -0
  117. elasticsearch/dsl/index_base.py +178 -0
  118. elasticsearch/dsl/mapping.py +19 -0
  119. elasticsearch/dsl/mapping_base.py +219 -0
  120. elasticsearch/dsl/query.py +2822 -0
  121. elasticsearch/dsl/response/__init__.py +388 -0
  122. elasticsearch/dsl/response/aggs.py +100 -0
  123. elasticsearch/dsl/response/hit.py +53 -0
  124. elasticsearch/dsl/search.py +20 -0
  125. elasticsearch/dsl/search_base.py +1053 -0
  126. elasticsearch/dsl/serializer.py +34 -0
  127. elasticsearch/dsl/types.py +6453 -0
  128. elasticsearch/dsl/update_by_query.py +19 -0
  129. elasticsearch/dsl/update_by_query_base.py +149 -0
  130. elasticsearch/dsl/utils.py +687 -0
  131. elasticsearch/dsl/wrappers.py +144 -0
  132. elasticsearch/helpers/actions.py +1 -1
  133. elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
  134. elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
  135. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
  136. {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/METADATA +12 -15
  137. elasticsearch-9.0.0.dist-info/RECORD +160 -0
  138. elasticsearch/transport.py +0 -57
  139. elasticsearch-8.17.1.dist-info/RECORD +0 -119
  140. {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/WHEEL +0 -0
  141. {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/licenses/LICENSE +0 -0
  142. {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/licenses/NOTICE +0 -0
@@ -38,17 +38,20 @@ class IngestClient(NamespacedClient):
38
38
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
39
39
  ) -> ObjectApiResponse[t.Any]:
40
40
  """
41
- Delete GeoIP database configurations. Delete one or more IP geolocation database
42
- configurations.
41
+ .. raw:: html
43
42
 
44
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-geoip-database-api.html>`_
43
+ <p>Delete GeoIP database configurations.</p>
44
+ <p>Delete one or more IP geolocation database configurations.</p>
45
+
46
+
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-geoip-database>`_
45
48
 
46
49
  :param id: A comma-separated list of geoip database configurations to delete
47
- :param master_timeout: Period to wait for a connection to the master node. If
48
- no response is received before the timeout expires, the request fails and
49
- returns an error.
50
- :param timeout: Period to wait for a response. If no response is received before
51
- the timeout expires, the request fails and returns an error.
50
+ :param master_timeout: The period to wait for a connection to the master node.
51
+ If no response is received before the timeout expires, the request fails
52
+ and returns an error.
53
+ :param timeout: The period to wait for a response. If no response is received
54
+ before the timeout expires, the request fails and returns an error.
52
55
  """
53
56
  if id in SKIP_IN_PATH:
54
57
  raise ValueError("Empty value passed for parameter 'id'")
@@ -90,9 +93,12 @@ class IngestClient(NamespacedClient):
90
93
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
91
94
  ) -> ObjectApiResponse[t.Any]:
92
95
  """
93
- Delete IP geolocation database configurations.
96
+ .. raw:: html
97
+
98
+ <p>Delete IP geolocation database configurations.</p>
94
99
 
95
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-ip-location-database-api.html>`_
100
+
101
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-ip-location-database>`_
96
102
 
97
103
  :param id: A comma-separated list of IP location database configurations.
98
104
  :param master_timeout: The period to wait for a connection to the master node.
@@ -143,9 +149,13 @@ class IngestClient(NamespacedClient):
143
149
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
144
150
  ) -> ObjectApiResponse[t.Any]:
145
151
  """
146
- Delete pipelines. Delete one or more ingest pipelines.
152
+ .. raw:: html
153
+
154
+ <p>Delete pipelines.
155
+ Delete one or more ingest pipelines.</p>
156
+
147
157
 
148
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-pipeline-api.html>`_
158
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-pipeline>`_
149
159
 
150
160
  :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the
151
161
  request. To delete all ingest pipelines in a cluster, use a value of `*`.
@@ -192,10 +202,13 @@ class IngestClient(NamespacedClient):
192
202
  pretty: t.Optional[bool] = None,
193
203
  ) -> ObjectApiResponse[t.Any]:
194
204
  """
195
- Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used
196
- with the GeoIP processor.
205
+ .. raw:: html
206
+
207
+ <p>Get GeoIP statistics.
208
+ Get download statistics for GeoIP2 databases that are used with the GeoIP processor.</p>
209
+
197
210
 
198
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/geoip-processor.html>`_
211
+ `<https://www.elastic.co/docs/reference/enrich-processor/geoip-processor>`_
199
212
  """
200
213
  __path_parts: t.Dict[str, str] = {}
201
214
  __path = "/_ingest/geoip/stats"
@@ -226,21 +239,20 @@ class IngestClient(NamespacedClient):
226
239
  error_trace: t.Optional[bool] = None,
227
240
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
228
241
  human: t.Optional[bool] = None,
229
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
230
242
  pretty: t.Optional[bool] = None,
231
243
  ) -> ObjectApiResponse[t.Any]:
232
244
  """
233
- Get GeoIP database configurations. Get information about one or more IP geolocation
234
- database configurations.
245
+ .. raw:: html
235
246
 
236
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-geoip-database-api.html>`_
247
+ <p>Get GeoIP database configurations.</p>
248
+ <p>Get information about one or more IP geolocation database configurations.</p>
237
249
 
238
- :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard
239
- (`*`) expressions are supported. To get all database configurations, omit
240
- this parameter or use `*`.
241
- :param master_timeout: Period to wait for a connection to the master node. If
242
- no response is received before the timeout expires, the request fails and
243
- returns an error.
250
+
251
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-geoip-database>`_
252
+
253
+ :param id: A comma-separated list of database configuration IDs to retrieve.
254
+ Wildcard (`*`) expressions are supported. To get all database configurations,
255
+ omit this parameter or use `*`.
244
256
  """
245
257
  __path_parts: t.Dict[str, str]
246
258
  if id not in SKIP_IN_PATH:
@@ -256,8 +268,6 @@ class IngestClient(NamespacedClient):
256
268
  __query["filter_path"] = filter_path
257
269
  if human is not None:
258
270
  __query["human"] = human
259
- if master_timeout is not None:
260
- __query["master_timeout"] = master_timeout
261
271
  if pretty is not None:
262
272
  __query["pretty"] = pretty
263
273
  __headers = {"accept": "application/json"}
@@ -282,9 +292,12 @@ class IngestClient(NamespacedClient):
282
292
  pretty: t.Optional[bool] = None,
283
293
  ) -> ObjectApiResponse[t.Any]:
284
294
  """
285
- Get IP geolocation database configurations.
295
+ .. raw:: html
296
+
297
+ <p>Get IP geolocation database configurations.</p>
298
+
286
299
 
287
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-ip-location-database-api.html>`_
300
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-ip-location-database>`_
288
301
 
289
302
  :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard
290
303
  (`*`) expressions are supported. To get all database configurations, omit
@@ -335,10 +348,14 @@ class IngestClient(NamespacedClient):
335
348
  summary: t.Optional[bool] = None,
336
349
  ) -> ObjectApiResponse[t.Any]:
337
350
  """
338
- Get pipelines. Get information about one or more ingest pipelines. This API returns
339
- a local reference of the pipeline.
351
+ .. raw:: html
352
+
353
+ <p>Get pipelines.</p>
354
+ <p>Get information about one or more ingest pipelines.
355
+ This API returns a local reference of the pipeline.</p>
356
+
340
357
 
341
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-pipeline-api.html>`_
358
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-pipeline>`_
342
359
 
343
360
  :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions
344
361
  are supported. To get all ingest pipelines, omit this parameter or use `*`.
@@ -387,12 +404,15 @@ class IngestClient(NamespacedClient):
387
404
  pretty: t.Optional[bool] = None,
388
405
  ) -> ObjectApiResponse[t.Any]:
389
406
  """
390
- Run a grok processor. Extract structured fields out of a single text field within
391
- a document. You must choose which field to extract matched fields from, as well
392
- as the grok pattern you expect will match. A grok pattern is like a regular expression
393
- that supports aliased expressions that can be reused.
407
+ .. raw:: html
394
408
 
395
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/grok-processor.html>`_
409
+ <p>Run a grok processor.
410
+ Extract structured fields out of a single text field within a document.
411
+ You must choose which field to extract matched fields from, as well as the grok pattern you expect will match.
412
+ A grok pattern is like a regular expression that supports aliased expressions that can be reused.</p>
413
+
414
+
415
+ `<https://www.elastic.co/docs/reference/enrich-processor/grok-processor>`_
396
416
  """
397
417
  __path_parts: t.Dict[str, str] = {}
398
418
  __path = "/_ingest/processor/grok"
@@ -433,10 +453,13 @@ class IngestClient(NamespacedClient):
433
453
  body: t.Optional[t.Dict[str, t.Any]] = None,
434
454
  ) -> ObjectApiResponse[t.Any]:
435
455
  """
436
- Create or update a GeoIP database configuration. Refer to the create or update
437
- IP geolocation database configuration API.
456
+ .. raw:: html
457
+
458
+ <p>Create or update a GeoIP database configuration.</p>
459
+ <p>Refer to the create or update IP geolocation database configuration API.</p>
438
460
 
439
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-geoip-database-api.html>`_
461
+
462
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-geoip-database>`_
440
463
 
441
464
  :param id: ID of the database configuration to create or update.
442
465
  :param maxmind: The configuration necessary to identify which IP geolocation
@@ -506,9 +529,12 @@ class IngestClient(NamespacedClient):
506
529
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
507
530
  ) -> ObjectApiResponse[t.Any]:
508
531
  """
509
- Create or update an IP geolocation database configuration.
532
+ .. raw:: html
533
+
534
+ <p>Create or update an IP geolocation database configuration.</p>
510
535
 
511
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-ip-location-database-api.html>`_
536
+
537
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-ip-location-database>`_
512
538
 
513
539
  :param id: The database configuration identifier.
514
540
  :param configuration:
@@ -588,9 +614,13 @@ class IngestClient(NamespacedClient):
588
614
  body: t.Optional[t.Dict[str, t.Any]] = None,
589
615
  ) -> ObjectApiResponse[t.Any]:
590
616
  """
591
- Create or update a pipeline. Changes made using this API take effect immediately.
617
+ .. raw:: html
618
+
619
+ <p>Create or update a pipeline.
620
+ Changes made using this API take effect immediately.</p>
621
+
592
622
 
593
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ingest.html>`_
623
+ `<https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines>`_
594
624
 
595
625
  :param id: ID of the ingest pipeline to create or update.
596
626
  :param deprecated: Marks this ingest pipeline as deprecated. When a deprecated
@@ -680,16 +710,19 @@ class IngestClient(NamespacedClient):
680
710
  body: t.Optional[t.Dict[str, t.Any]] = None,
681
711
  ) -> ObjectApiResponse[t.Any]:
682
712
  """
683
- Simulate a pipeline. Run an ingest pipeline against a set of provided documents.
684
- You can either specify an existing pipeline to use with the provided documents
685
- or supply a pipeline definition in the body of the request.
713
+ .. raw:: html
714
+
715
+ <p>Simulate a pipeline.</p>
716
+ <p>Run an ingest pipeline against a set of provided documents.
717
+ You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.</p>
718
+
686
719
 
687
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/simulate-pipeline-api.html>`_
720
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-simulate>`_
688
721
 
689
722
  :param docs: Sample documents to test in the pipeline.
690
- :param id: Pipeline to test. If you dont specify a `pipeline` in the request
723
+ :param id: The pipeline to test. If you don't specify a `pipeline` in the request
691
724
  body, this parameter is required.
692
- :param pipeline: Pipeline to test. If you dont specify the `pipeline` request
725
+ :param pipeline: The pipeline to test. If you don't specify the `pipeline` request
693
726
  path parameter, this parameter is required. If you specify both this and
694
727
  the request path parameter, the API only uses the request path parameter.
695
728
  :param verbose: If `true`, the response includes output data for each processor
@@ -32,14 +32,23 @@ class LicenseClient(NamespacedClient):
32
32
  error_trace: t.Optional[bool] = None,
33
33
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
34
34
  human: t.Optional[bool] = None,
35
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
35
36
  pretty: t.Optional[bool] = None,
37
+ timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
36
38
  ) -> ObjectApiResponse[t.Any]:
37
39
  """
38
- Delete the license. When the license expires, your subscription level reverts
39
- to Basic. If the operator privileges feature is enabled, only operator users
40
- can use this API.
40
+ .. raw:: html
41
41
 
42
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-license.html>`_
42
+ <p>Delete the license.</p>
43
+ <p>When the license expires, your subscription level reverts to Basic.</p>
44
+ <p>If the operator privileges feature is enabled, only operator users can use this API.</p>
45
+
46
+
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-delete>`_
48
+
49
+ :param master_timeout: The period to wait for a connection to the master node.
50
+ :param timeout: The period to wait for a response. If no response is received
51
+ before the timeout expires, the request fails and returns an error.
43
52
  """
44
53
  __path_parts: t.Dict[str, str] = {}
45
54
  __path = "/_license"
@@ -50,8 +59,12 @@ class LicenseClient(NamespacedClient):
50
59
  __query["filter_path"] = filter_path
51
60
  if human is not None:
52
61
  __query["human"] = human
62
+ if master_timeout is not None:
63
+ __query["master_timeout"] = master_timeout
53
64
  if pretty is not None:
54
65
  __query["pretty"] = pretty
66
+ if timeout is not None:
67
+ __query["timeout"] = timeout
55
68
  __headers = {"accept": "application/json"}
56
69
  return self.perform_request( # type: ignore[return-value]
57
70
  "DELETE",
@@ -74,13 +87,18 @@ class LicenseClient(NamespacedClient):
74
87
  pretty: t.Optional[bool] = None,
75
88
  ) -> ObjectApiResponse[t.Any]:
76
89
  """
77
- Get license information. Get information about your Elastic license including
78
- its type, its status, when it was issued, and when it expires. NOTE: If the master
79
- node is generating a new cluster state, the get license API may return a `404
80
- Not Found` response. If you receive an unexpected 404 response after cluster
81
- startup, wait a short period and retry the request.
90
+ .. raw:: html
91
+
92
+ <p>Get license information.</p>
93
+ <p>Get information about your Elastic license including its type, its status, when it was issued, and when it expires.</p>
94
+ <blockquote>
95
+ <p>info
96
+ If the master node is generating a new cluster state, the get license API may return a <code>404 Not Found</code> response.
97
+ If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.</p>
98
+ </blockquote>
82
99
 
83
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-license.html>`_
100
+
101
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get>`_
84
102
 
85
103
  :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise
86
104
  license types. If `false`, this parameter returns platinum for both platinum
@@ -124,9 +142,12 @@ class LicenseClient(NamespacedClient):
124
142
  pretty: t.Optional[bool] = None,
125
143
  ) -> ObjectApiResponse[t.Any]:
126
144
  """
127
- Get the basic license status.
145
+ .. raw:: html
146
+
147
+ <p>Get the basic license status.</p>
128
148
 
129
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-basic-status.html>`_
149
+
150
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-basic-status>`_
130
151
  """
131
152
  __path_parts: t.Dict[str, str] = {}
132
153
  __path = "/_license/basic_status"
@@ -159,9 +180,12 @@ class LicenseClient(NamespacedClient):
159
180
  pretty: t.Optional[bool] = None,
160
181
  ) -> ObjectApiResponse[t.Any]:
161
182
  """
162
- Get the trial status.
183
+ .. raw:: html
184
+
185
+ <p>Get the trial status.</p>
163
186
 
164
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-trial-status.html>`_
187
+
188
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-trial-status>`_
165
189
  """
166
190
  __path_parts: t.Dict[str, str] = {}
167
191
  __path = "/_license/trial_status"
@@ -196,25 +220,32 @@ class LicenseClient(NamespacedClient):
196
220
  human: t.Optional[bool] = None,
197
221
  license: t.Optional[t.Mapping[str, t.Any]] = None,
198
222
  licenses: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
223
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
199
224
  pretty: t.Optional[bool] = None,
225
+ timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
200
226
  body: t.Optional[t.Dict[str, t.Any]] = None,
201
227
  ) -> ObjectApiResponse[t.Any]:
202
228
  """
203
- Update the license. You can update your license at runtime without shutting down
204
- your nodes. License updates take effect immediately. If the license you are installing
205
- does not support all of the features that were available with your previous license,
206
- however, you are notified in the response. You must then re-submit the API request
207
- with the acknowledge parameter set to true. NOTE: If Elasticsearch security features
208
- are enabled and you are installing a gold or higher license, you must enable
209
- TLS on the transport networking layer before you install the license. If the
210
- operator privileges feature is enabled, only operator users can use this API.
229
+ .. raw:: html
230
+
231
+ <p>Update the license.</p>
232
+ <p>You can update your license at runtime without shutting down your nodes.
233
+ License updates take effect immediately.
234
+ If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.
235
+ You must then re-submit the API request with the acknowledge parameter set to true.</p>
236
+ <p>NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.
237
+ If the operator privileges feature is enabled, only operator users can use this API.</p>
211
238
 
212
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-license.html>`_
239
+
240
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post>`_
213
241
 
214
242
  :param acknowledge: Specifies whether you acknowledge the license changes.
215
243
  :param license:
216
244
  :param licenses: A sequence of one or more JSON documents containing the license
217
245
  information.
246
+ :param master_timeout: The period to wait for a connection to the master node.
247
+ :param timeout: The period to wait for a response. If no response is received
248
+ before the timeout expires, the request fails and returns an error.
218
249
  """
219
250
  __path_parts: t.Dict[str, str] = {}
220
251
  __path = "/_license"
@@ -228,8 +259,12 @@ class LicenseClient(NamespacedClient):
228
259
  __query["filter_path"] = filter_path
229
260
  if human is not None:
230
261
  __query["human"] = human
262
+ if master_timeout is not None:
263
+ __query["master_timeout"] = master_timeout
231
264
  if pretty is not None:
232
265
  __query["pretty"] = pretty
266
+ if timeout is not None:
267
+ __query["timeout"] = timeout
233
268
  if not __body:
234
269
  if license is not None:
235
270
  __body["license"] = license
@@ -258,21 +293,28 @@ class LicenseClient(NamespacedClient):
258
293
  error_trace: t.Optional[bool] = None,
259
294
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
260
295
  human: t.Optional[bool] = None,
296
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
261
297
  pretty: t.Optional[bool] = None,
298
+ timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
262
299
  ) -> ObjectApiResponse[t.Any]:
263
300
  """
264
- Start a basic license. Start an indefinite basic license, which gives access
265
- to all the basic features. NOTE: In order to start a basic license, you must
266
- not currently have a basic license. If the basic license does not support all
267
- of the features that are available with your current license, however, you are
268
- notified in the response. You must then re-submit the API request with the `acknowledge`
269
- parameter set to `true`. To check the status of your basic license, use the get
270
- basic license API.
301
+ .. raw:: html
302
+
303
+ <p>Start a basic license.</p>
304
+ <p>Start an indefinite basic license, which gives access to all the basic features.</p>
305
+ <p>NOTE: In order to start a basic license, you must not currently have a basic license.</p>
306
+ <p>If the basic license does not support all of the features that are available with your current license, however, you are notified in the response.
307
+ You must then re-submit the API request with the <code>acknowledge</code> parameter set to <code>true</code>.</p>
308
+ <p>To check the status of your basic license, use the get basic license API.</p>
271
309
 
272
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-basic.html>`_
310
+
311
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-basic>`_
273
312
 
274
313
  :param acknowledge: whether the user has acknowledged acknowledge messages (default:
275
314
  false)
315
+ :param master_timeout: Period to wait for a connection to the master node.
316
+ :param timeout: Period to wait for a response. If no response is received before
317
+ the timeout expires, the request fails and returns an error.
276
318
  """
277
319
  __path_parts: t.Dict[str, str] = {}
278
320
  __path = "/_license/start_basic"
@@ -285,8 +327,12 @@ class LicenseClient(NamespacedClient):
285
327
  __query["filter_path"] = filter_path
286
328
  if human is not None:
287
329
  __query["human"] = human
330
+ if master_timeout is not None:
331
+ __query["master_timeout"] = master_timeout
288
332
  if pretty is not None:
289
333
  __query["pretty"] = pretty
334
+ if timeout is not None:
335
+ __query["timeout"] = timeout
290
336
  __headers = {"accept": "application/json"}
291
337
  return self.perform_request( # type: ignore[return-value]
292
338
  "POST",
@@ -305,21 +351,25 @@ class LicenseClient(NamespacedClient):
305
351
  error_trace: t.Optional[bool] = None,
306
352
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
307
353
  human: t.Optional[bool] = None,
354
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
308
355
  pretty: t.Optional[bool] = None,
309
356
  type_query_string: t.Optional[str] = None,
310
357
  ) -> ObjectApiResponse[t.Any]:
311
358
  """
312
- Start a trial. Start a 30-day trial, which gives access to all subscription features.
313
- NOTE: You are allowed to start a trial only if your cluster has not already activated
314
- a trial for the current major product version. For example, if you have already
315
- activated a trial for v8.0, you cannot start a new trial until v9.0. You can,
316
- however, request an extended trial at https://www.elastic.co/trialextension.
317
- To check the status of your trial, use the get trial status API.
359
+ .. raw:: html
360
+
361
+ <p>Start a trial.
362
+ Start a 30-day trial, which gives access to all subscription features.</p>
363
+ <p>NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.
364
+ For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at <a href="https://www.elastic.co/trialextension">https://www.elastic.co/trialextension</a>.</p>
365
+ <p>To check the status of your trial, use the get trial status API.</p>
366
+
318
367
 
319
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-trial.html>`_
368
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-trial>`_
320
369
 
321
370
  :param acknowledge: whether the user has acknowledged acknowledge messages (default:
322
371
  false)
372
+ :param master_timeout: Period to wait for a connection to the master node.
323
373
  :param type_query_string:
324
374
  """
325
375
  __path_parts: t.Dict[str, str] = {}
@@ -333,6 +383,8 @@ class LicenseClient(NamespacedClient):
333
383
  __query["filter_path"] = filter_path
334
384
  if human is not None:
335
385
  __query["human"] = human
386
+ if master_timeout is not None:
387
+ __query["master_timeout"] = master_timeout
336
388
  if pretty is not None:
337
389
  __query["pretty"] = pretty
338
390
  if type_query_string is not None:
@@ -36,11 +36,14 @@ class LogstashClient(NamespacedClient):
36
36
  pretty: t.Optional[bool] = None,
37
37
  ) -> ObjectApiResponse[t.Any]:
38
38
  """
39
- Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central
40
- Management. If the request succeeds, you receive an empty response with an appropriate
41
- status code.
39
+ .. raw:: html
42
40
 
43
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-delete-pipeline.html>`_
41
+ <p>Delete a Logstash pipeline.
42
+ Delete a pipeline that is used for Logstash Central Management.
43
+ If the request succeeds, you receive an empty response with an appropriate status code.</p>
44
+
45
+
46
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-delete-pipeline>`_
44
47
 
45
48
  :param id: An identifier for the pipeline.
46
49
  """
@@ -78,9 +81,13 @@ class LogstashClient(NamespacedClient):
78
81
  pretty: t.Optional[bool] = None,
79
82
  ) -> ObjectApiResponse[t.Any]:
80
83
  """
81
- Get Logstash pipelines. Get pipelines that are used for Logstash Central Management.
84
+ .. raw:: html
85
+
86
+ <p>Get Logstash pipelines.
87
+ Get pipelines that are used for Logstash Central Management.</p>
82
88
 
83
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-get-pipeline.html>`_
89
+
90
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-get-pipeline>`_
84
91
 
85
92
  :param id: A comma-separated list of pipeline identifiers.
86
93
  """
@@ -125,10 +132,14 @@ class LogstashClient(NamespacedClient):
125
132
  pretty: t.Optional[bool] = None,
126
133
  ) -> ObjectApiResponse[t.Any]:
127
134
  """
128
- Create or update a Logstash pipeline. Create a pipeline that is used for Logstash
129
- Central Management. If the specified pipeline exists, it is replaced.
135
+ .. raw:: html
136
+
137
+ <p>Create or update a Logstash pipeline.</p>
138
+ <p>Create a pipeline that is used for Logstash Central Management.
139
+ If the specified pipeline exists, it is replaced.</p>
140
+
130
141
 
131
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-put-pipeline.html>`_
142
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-put-pipeline>`_
132
143
 
133
144
  :param id: An identifier for the pipeline.
134
145
  :param pipeline:
@@ -36,12 +36,15 @@ class MigrationClient(NamespacedClient):
36
36
  pretty: t.Optional[bool] = None,
37
37
  ) -> ObjectApiResponse[t.Any]:
38
38
  """
39
- Get deprecation information. Get information about different cluster, node, and
40
- index level settings that use deprecated features that will be removed or changed
41
- in the next major version. TIP: This APIs is designed for indirect use by the
42
- Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.
39
+ .. raw:: html
43
40
 
44
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/migration-api-deprecation.html>`_
41
+ <p>Get deprecation information.
42
+ Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.</p>
43
+ <p>TIP: This APIs is designed for indirect use by the Upgrade Assistant.
44
+ You are strongly recommended to use the Upgrade Assistant.</p>
45
+
46
+
47
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-deprecations>`_
45
48
 
46
49
  :param index: Comma-separate list of data streams or indices to check. Wildcard
47
50
  (*) expressions are supported.
@@ -82,13 +85,16 @@ class MigrationClient(NamespacedClient):
82
85
  pretty: t.Optional[bool] = None,
83
86
  ) -> ObjectApiResponse[t.Any]:
84
87
  """
85
- Get feature migration information. Version upgrades sometimes require changes
86
- to how features store configuration information and data in system indices. Check
87
- which features need to be migrated and the status of any migrations that are
88
- in progress. TIP: This API is designed for indirect use by the Upgrade Assistant.
89
- You are strongly recommended to use the Upgrade Assistant.
88
+ .. raw:: html
89
+
90
+ <p>Get feature migration information.
91
+ Version upgrades sometimes require changes to how features store configuration information and data in system indices.
92
+ Check which features need to be migrated and the status of any migrations that are in progress.</p>
93
+ <p>TIP: This API is designed for indirect use by the Upgrade Assistant.
94
+ You are strongly recommended to use the Upgrade Assistant.</p>
90
95
 
91
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/feature-migration-api.html>`_
96
+
97
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-get-feature-upgrade-status>`_
92
98
  """
93
99
  __path_parts: t.Dict[str, str] = {}
94
100
  __path = "/_migration/system_features"
@@ -121,13 +127,16 @@ class MigrationClient(NamespacedClient):
121
127
  pretty: t.Optional[bool] = None,
122
128
  ) -> ObjectApiResponse[t.Any]:
123
129
  """
124
- Start the feature migration. Version upgrades sometimes require changes to how
125
- features store configuration information and data in system indices. This API
126
- starts the automatic migration process. Some functionality might be temporarily
127
- unavailable during the migration process. TIP: The API is designed for indirect
128
- use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.
130
+ .. raw:: html
131
+
132
+ <p>Start the feature migration.
133
+ Version upgrades sometimes require changes to how features store configuration information and data in system indices.
134
+ This API starts the automatic migration process.</p>
135
+ <p>Some functionality might be temporarily unavailable during the migration process.</p>
136
+ <p>TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.</p>
137
+
129
138
 
130
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/feature-migration-api.html>`_
139
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-get-feature-upgrade-status>`_
131
140
  """
132
141
  __path_parts: t.Dict[str, str] = {}
133
142
  __path = "/_migration/system_features"