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
@@ -23,16 +23,17 @@ from ._base import NamespacedClient
23
23
  from .utils import (
24
24
  SKIP_IN_PATH,
25
25
  Stability,
26
+ Visibility,
27
+ _availability_warning,
26
28
  _quote,
27
29
  _rewrite_parameters,
28
- _stability_warning,
29
30
  )
30
31
 
31
32
 
32
33
  class ConnectorClient(NamespacedClient):
33
34
 
34
35
  @_rewrite_parameters()
35
- @_stability_warning(Stability.EXPERIMENTAL)
36
+ @_availability_warning(Stability.EXPERIMENTAL)
36
37
  def check_in(
37
38
  self,
38
39
  *,
@@ -77,7 +78,7 @@ class ConnectorClient(NamespacedClient):
77
78
  )
78
79
 
79
80
  @_rewrite_parameters()
80
- @_stability_warning(Stability.BETA)
81
+ @_availability_warning(Stability.BETA)
81
82
  def delete(
82
83
  self,
83
84
  *,
@@ -134,7 +135,7 @@ class ConnectorClient(NamespacedClient):
134
135
  )
135
136
 
136
137
  @_rewrite_parameters()
137
- @_stability_warning(Stability.BETA)
138
+ @_availability_warning(Stability.BETA)
138
139
  def get(
139
140
  self,
140
141
  *,
@@ -199,7 +200,7 @@ class ConnectorClient(NamespacedClient):
199
200
  "sync_cursor",
200
201
  ),
201
202
  )
202
- @_stability_warning(Stability.EXPERIMENTAL)
203
+ @_availability_warning(Stability.EXPERIMENTAL, Visibility.PRIVATE)
203
204
  def last_sync(
204
205
  self,
205
206
  *,
@@ -333,7 +334,7 @@ class ConnectorClient(NamespacedClient):
333
334
  @_rewrite_parameters(
334
335
  parameter_aliases={"from": "from_"},
335
336
  )
336
- @_stability_warning(Stability.BETA)
337
+ @_availability_warning(Stability.BETA)
337
338
  def list(
338
339
  self,
339
340
  *,
@@ -416,7 +417,7 @@ class ConnectorClient(NamespacedClient):
416
417
  "service_type",
417
418
  ),
418
419
  )
419
- @_stability_warning(Stability.BETA)
420
+ @_availability_warning(Stability.BETA)
420
421
  def post(
421
422
  self,
422
423
  *,
@@ -500,7 +501,7 @@ class ConnectorClient(NamespacedClient):
500
501
  "service_type",
501
502
  ),
502
503
  )
503
- @_stability_warning(Stability.BETA)
504
+ @_availability_warning(Stability.BETA)
504
505
  def put(
505
506
  self,
506
507
  *,
@@ -580,7 +581,7 @@ class ConnectorClient(NamespacedClient):
580
581
  )
581
582
 
582
583
  @_rewrite_parameters()
583
- @_stability_warning(Stability.BETA)
584
+ @_availability_warning(Stability.BETA)
584
585
  def sync_job_cancel(
585
586
  self,
586
587
  *,
@@ -630,7 +631,7 @@ class ConnectorClient(NamespacedClient):
630
631
  )
631
632
 
632
633
  @_rewrite_parameters()
633
- @_stability_warning(Stability.EXPERIMENTAL)
634
+ @_availability_warning(Stability.EXPERIMENTAL)
634
635
  def sync_job_check_in(
635
636
  self,
636
637
  *,
@@ -643,8 +644,8 @@ class ConnectorClient(NamespacedClient):
643
644
  """
644
645
  .. raw:: html
645
646
 
646
- <p>Check in a connector sync job.
647
- Check in a connector sync job and set the <code>last_seen</code> field to the current time before updating it in the internal index.</p>
647
+ <p>Check in a connector sync job.</p>
648
+ <p>Check in a connector sync job and set the <code>last_seen</code> field to the current time before updating it in the internal index.</p>
648
649
  <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
649
650
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
650
651
 
@@ -684,7 +685,7 @@ class ConnectorClient(NamespacedClient):
684
685
  @_rewrite_parameters(
685
686
  body_fields=("worker_hostname", "sync_cursor"),
686
687
  )
687
- @_stability_warning(Stability.EXPERIMENTAL)
688
+ @_availability_warning(Stability.EXPERIMENTAL)
688
689
  def sync_job_claim(
689
690
  self,
690
691
  *,
@@ -700,8 +701,8 @@ class ConnectorClient(NamespacedClient):
700
701
  """
701
702
  .. raw:: html
702
703
 
703
- <p>Claim a connector sync job.
704
- This action updates the job status to <code>in_progress</code> and sets the <code>last_seen</code> and <code>started_at</code> timestamps to the current time.
704
+ <p>Claim a connector sync job.</p>
705
+ <p>This action updates the job status to <code>in_progress</code> and sets the <code>last_seen</code> and <code>started_at</code> timestamps to the current time.
705
706
  Additionally, it can set the <code>sync_cursor</code> property for the sync job.</p>
706
707
  <p>This API is not intended for direct connector management by users.
707
708
  It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.</p>
@@ -753,7 +754,7 @@ class ConnectorClient(NamespacedClient):
753
754
  )
754
755
 
755
756
  @_rewrite_parameters()
756
- @_stability_warning(Stability.BETA)
757
+ @_availability_warning(Stability.BETA)
757
758
  def sync_job_delete(
758
759
  self,
759
760
  *,
@@ -804,7 +805,7 @@ class ConnectorClient(NamespacedClient):
804
805
  @_rewrite_parameters(
805
806
  body_fields=("error",),
806
807
  )
807
- @_stability_warning(Stability.EXPERIMENTAL)
808
+ @_availability_warning(Stability.EXPERIMENTAL)
808
809
  def sync_job_error(
809
810
  self,
810
811
  *,
@@ -819,8 +820,8 @@ class ConnectorClient(NamespacedClient):
819
820
  """
820
821
  .. raw:: html
821
822
 
822
- <p>Set a connector sync job error.
823
- Set the <code>error</code> field for a connector sync job and set its <code>status</code> to <code>error</code>.</p>
823
+ <p>Set a connector sync job error.</p>
824
+ <p>Set the <code>error</code> field for a connector sync job and set its <code>status</code> to <code>error</code>.</p>
824
825
  <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
825
826
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
826
827
 
@@ -863,7 +864,7 @@ class ConnectorClient(NamespacedClient):
863
864
  )
864
865
 
865
866
  @_rewrite_parameters()
866
- @_stability_warning(Stability.BETA)
867
+ @_availability_warning(Stability.BETA)
867
868
  def sync_job_get(
868
869
  self,
869
870
  *,
@@ -911,7 +912,7 @@ class ConnectorClient(NamespacedClient):
911
912
  @_rewrite_parameters(
912
913
  parameter_aliases={"from": "from_"},
913
914
  )
914
- @_stability_warning(Stability.BETA)
915
+ @_availability_warning(Stability.BETA)
915
916
  def sync_job_list(
916
917
  self,
917
918
  *,
@@ -994,7 +995,7 @@ class ConnectorClient(NamespacedClient):
994
995
  @_rewrite_parameters(
995
996
  body_fields=("id", "job_type", "trigger_method"),
996
997
  )
997
- @_stability_warning(Stability.BETA)
998
+ @_availability_warning(Stability.BETA)
998
999
  def sync_job_post(
999
1000
  self,
1000
1001
  *,
@@ -1066,7 +1067,7 @@ class ConnectorClient(NamespacedClient):
1066
1067
  "total_document_count",
1067
1068
  ),
1068
1069
  )
1069
- @_stability_warning(Stability.EXPERIMENTAL)
1070
+ @_availability_warning(Stability.EXPERIMENTAL)
1070
1071
  def sync_job_update_stats(
1071
1072
  self,
1072
1073
  *,
@@ -1086,8 +1087,8 @@ class ConnectorClient(NamespacedClient):
1086
1087
  """
1087
1088
  .. raw:: html
1088
1089
 
1089
- <p>Set the connector sync job stats.
1090
- Stats include: <code>deleted_document_count</code>, <code>indexed_document_count</code>, <code>indexed_document_volume</code>, and <code>total_document_count</code>.
1090
+ <p>Set the connector sync job stats.</p>
1091
+ <p>Stats include: <code>deleted_document_count</code>, <code>indexed_document_count</code>, <code>indexed_document_volume</code>, and <code>total_document_count</code>.
1091
1092
  You can also update <code>last_seen</code>.
1092
1093
  This API is mainly used by the connector service for updating sync job information.</p>
1093
1094
  <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
@@ -1160,7 +1161,7 @@ class ConnectorClient(NamespacedClient):
1160
1161
  )
1161
1162
 
1162
1163
  @_rewrite_parameters()
1163
- @_stability_warning(Stability.EXPERIMENTAL)
1164
+ @_availability_warning(Stability.EXPERIMENTAL)
1164
1165
  def update_active_filtering(
1165
1166
  self,
1166
1167
  *,
@@ -1207,7 +1208,7 @@ class ConnectorClient(NamespacedClient):
1207
1208
  @_rewrite_parameters(
1208
1209
  body_fields=("api_key_id", "api_key_secret_id"),
1209
1210
  )
1210
- @_stability_warning(Stability.BETA)
1211
+ @_availability_warning(Stability.BETA)
1211
1212
  def update_api_key_id(
1212
1213
  self,
1213
1214
  *,
@@ -1269,7 +1270,7 @@ class ConnectorClient(NamespacedClient):
1269
1270
  @_rewrite_parameters(
1270
1271
  body_fields=("configuration", "values"),
1271
1272
  )
1272
- @_stability_warning(Stability.BETA)
1273
+ @_availability_warning(Stability.BETA)
1273
1274
  def update_configuration(
1274
1275
  self,
1275
1276
  *,
@@ -1328,7 +1329,7 @@ class ConnectorClient(NamespacedClient):
1328
1329
  @_rewrite_parameters(
1329
1330
  body_fields=("error",),
1330
1331
  )
1331
- @_stability_warning(Stability.EXPERIMENTAL)
1332
+ @_availability_warning(Stability.EXPERIMENTAL)
1332
1333
  def update_error(
1333
1334
  self,
1334
1335
  *,
@@ -1387,7 +1388,7 @@ class ConnectorClient(NamespacedClient):
1387
1388
  @_rewrite_parameters(
1388
1389
  body_fields=("features",),
1389
1390
  )
1390
- @_stability_warning(Stability.EXPERIMENTAL)
1391
+ @_availability_warning(Stability.EXPERIMENTAL)
1391
1392
  def update_features(
1392
1393
  self,
1393
1394
  *,
@@ -1402,8 +1403,8 @@ class ConnectorClient(NamespacedClient):
1402
1403
  """
1403
1404
  .. raw:: html
1404
1405
 
1405
- <p>Update the connector features.
1406
- Update the connector features in the connector document.
1406
+ <p>Update the connector features.</p>
1407
+ <p>Update the connector features in the connector document.
1407
1408
  This API can be used to control the following aspects of a connector:</p>
1408
1409
  <ul>
1409
1410
  <li>document-level security</li>
@@ -1455,7 +1456,7 @@ class ConnectorClient(NamespacedClient):
1455
1456
  @_rewrite_parameters(
1456
1457
  body_fields=("advanced_snippet", "filtering", "rules"),
1457
1458
  )
1458
- @_stability_warning(Stability.BETA)
1459
+ @_availability_warning(Stability.BETA)
1459
1460
  def update_filtering(
1460
1461
  self,
1461
1462
  *,
@@ -1520,7 +1521,7 @@ class ConnectorClient(NamespacedClient):
1520
1521
  @_rewrite_parameters(
1521
1522
  body_fields=("validation",),
1522
1523
  )
1523
- @_stability_warning(Stability.EXPERIMENTAL)
1524
+ @_availability_warning(Stability.EXPERIMENTAL)
1524
1525
  def update_filtering_validation(
1525
1526
  self,
1526
1527
  *,
@@ -1577,7 +1578,7 @@ class ConnectorClient(NamespacedClient):
1577
1578
  @_rewrite_parameters(
1578
1579
  body_fields=("index_name",),
1579
1580
  )
1580
- @_stability_warning(Stability.BETA)
1581
+ @_availability_warning(Stability.BETA)
1581
1582
  def update_index_name(
1582
1583
  self,
1583
1584
  *,
@@ -1634,7 +1635,7 @@ class ConnectorClient(NamespacedClient):
1634
1635
  @_rewrite_parameters(
1635
1636
  body_fields=("description", "name"),
1636
1637
  )
1637
- @_stability_warning(Stability.BETA)
1638
+ @_availability_warning(Stability.BETA)
1638
1639
  def update_name(
1639
1640
  self,
1640
1641
  *,
@@ -1692,7 +1693,7 @@ class ConnectorClient(NamespacedClient):
1692
1693
  @_rewrite_parameters(
1693
1694
  body_fields=("is_native",),
1694
1695
  )
1695
- @_stability_warning(Stability.BETA)
1696
+ @_availability_warning(Stability.BETA)
1696
1697
  def update_native(
1697
1698
  self,
1698
1699
  *,
@@ -1748,7 +1749,7 @@ class ConnectorClient(NamespacedClient):
1748
1749
  @_rewrite_parameters(
1749
1750
  body_fields=("pipeline",),
1750
1751
  )
1751
- @_stability_warning(Stability.BETA)
1752
+ @_availability_warning(Stability.BETA)
1752
1753
  def update_pipeline(
1753
1754
  self,
1754
1755
  *,
@@ -1805,7 +1806,7 @@ class ConnectorClient(NamespacedClient):
1805
1806
  @_rewrite_parameters(
1806
1807
  body_fields=("scheduling",),
1807
1808
  )
1808
- @_stability_warning(Stability.BETA)
1809
+ @_availability_warning(Stability.BETA)
1809
1810
  def update_scheduling(
1810
1811
  self,
1811
1812
  *,
@@ -1861,7 +1862,7 @@ class ConnectorClient(NamespacedClient):
1861
1862
  @_rewrite_parameters(
1862
1863
  body_fields=("service_type",),
1863
1864
  )
1864
- @_stability_warning(Stability.BETA)
1865
+ @_availability_warning(Stability.BETA)
1865
1866
  def update_service_type(
1866
1867
  self,
1867
1868
  *,
@@ -1917,7 +1918,7 @@ class ConnectorClient(NamespacedClient):
1917
1918
  @_rewrite_parameters(
1918
1919
  body_fields=("status",),
1919
1920
  )
1920
- @_stability_warning(Stability.EXPERIMENTAL)
1921
+ @_availability_warning(Stability.EXPERIMENTAL)
1921
1922
  def update_status(
1922
1923
  self,
1923
1924
  *,
@@ -30,7 +30,7 @@ class DanglingIndicesClient(NamespacedClient):
30
30
  self,
31
31
  *,
32
32
  index_uuid: str,
33
- accept_data_loss: bool,
33
+ accept_data_loss: t.Optional[bool] = None,
34
34
  error_trace: t.Optional[bool] = None,
35
35
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
36
36
  human: t.Optional[bool] = None,
@@ -41,8 +41,8 @@ class DanglingIndicesClient(NamespacedClient):
41
41
  """
42
42
  .. raw:: html
43
43
 
44
- <p>Delete a dangling index.
45
- If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
44
+ <p>Delete a dangling index.</p>
45
+ <p>If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
46
46
  For example, this can happen if you delete more than <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch node is offline.</p>
47
47
 
48
48
 
@@ -52,13 +52,11 @@ class DanglingIndicesClient(NamespacedClient):
52
52
  API to find the UUID.
53
53
  :param accept_data_loss: This parameter must be set to true to acknowledge that
54
54
  it will no longer be possible to recove data from the dangling index.
55
- :param master_timeout: Specify timeout for connection to master
56
- :param timeout: Explicit operation timeout
55
+ :param master_timeout: The period to wait for a connection to the master node.
56
+ :param timeout: The period to wait for a response.
57
57
  """
58
58
  if index_uuid in SKIP_IN_PATH:
59
59
  raise ValueError("Empty value passed for parameter 'index_uuid'")
60
- if accept_data_loss is None:
61
- raise ValueError("Empty value passed for parameter 'accept_data_loss'")
62
60
  __path_parts: t.Dict[str, str] = {"index_uuid": _quote(index_uuid)}
63
61
  __path = f'/_dangling/{__path_parts["index_uuid"]}'
64
62
  __query: t.Dict[str, t.Any] = {}
@@ -91,7 +89,7 @@ class DanglingIndicesClient(NamespacedClient):
91
89
  self,
92
90
  *,
93
91
  index_uuid: str,
94
- accept_data_loss: bool,
92
+ accept_data_loss: t.Optional[bool] = None,
95
93
  error_trace: t.Optional[bool] = None,
96
94
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
97
95
  human: t.Optional[bool] = None,
@@ -116,13 +114,11 @@ class DanglingIndicesClient(NamespacedClient):
116
114
  from or determine which shard copies are fresh and which are stale, it cannot
117
115
  guarantee that the imported data represents the latest state of the index
118
116
  when it was last in the cluster.
119
- :param master_timeout: Specify timeout for connection to master
120
- :param timeout: Explicit operation timeout
117
+ :param master_timeout: The period to wait for a connection to the master node.
118
+ :param timeout: The period to wait for a response.
121
119
  """
122
120
  if index_uuid in SKIP_IN_PATH:
123
121
  raise ValueError("Empty value passed for parameter 'index_uuid'")
124
- if accept_data_loss is None:
125
- raise ValueError("Empty value passed for parameter 'accept_data_loss'")
126
122
  __path_parts: t.Dict[str, str] = {"index_uuid": _quote(index_uuid)}
127
123
  __path = f'/_dangling/{__path_parts["index_uuid"]}'
128
124
  __query: t.Dict[str, t.Any] = {}
@@ -39,8 +39,8 @@ class EnrichClient(NamespacedClient):
39
39
  """
40
40
  .. raw:: html
41
41
 
42
- <p>Delete an enrich policy.
43
- Deletes an existing enrich policy and its enrich index.</p>
42
+ <p>Delete an enrich policy.</p>
43
+ <p>Deletes an existing enrich policy and its enrich index.</p>
44
44
 
45
45
 
46
46
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy>`_
@@ -88,8 +88,8 @@ class EnrichClient(NamespacedClient):
88
88
  """
89
89
  .. raw:: html
90
90
 
91
- <p>Run an enrich policy.
92
- Create the enrich index for an existing enrich policy.</p>
91
+ <p>Run an enrich policy.</p>
92
+ <p>Create the enrich index for an existing enrich policy.</p>
93
93
 
94
94
 
95
95
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy>`_
@@ -140,8 +140,8 @@ class EnrichClient(NamespacedClient):
140
140
  """
141
141
  .. raw:: html
142
142
 
143
- <p>Get an enrich policy.
144
- Returns information about an enrich policy.</p>
143
+ <p>Get an enrich policy.</p>
144
+ <p>Returns information about an enrich policy.</p>
145
145
 
146
146
 
147
147
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy>`_
@@ -198,8 +198,8 @@ class EnrichClient(NamespacedClient):
198
198
  """
199
199
  .. raw:: html
200
200
 
201
- <p>Create an enrich policy.
202
- Creates an enrich policy.</p>
201
+ <p>Create an enrich policy.</p>
202
+ <p>Creates an enrich policy.</p>
203
203
 
204
204
 
205
205
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy>`_
@@ -259,8 +259,8 @@ class EnrichClient(NamespacedClient):
259
259
  """
260
260
  .. raw:: html
261
261
 
262
- <p>Get enrich stats.
263
- Returns enrich coordinator statistics and information about enrich policies that are currently executing.</p>
262
+ <p>Get enrich stats.</p>
263
+ <p>Returns enrich coordinator statistics and information about enrich policies that are currently executing.</p>
264
264
 
265
265
 
266
266
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats>`_
@@ -38,8 +38,8 @@ class EqlClient(NamespacedClient):
38
38
  """
39
39
  .. raw:: html
40
40
 
41
- <p>Delete an async EQL search.
42
- Delete an async EQL search or a stored synchronous EQL search.
41
+ <p>Delete an async EQL search.</p>
42
+ <p>Delete an async EQL search or a stored synchronous EQL search.
43
43
  The API also deletes results for the search.</p>
44
44
 
45
45
 
@@ -89,8 +89,8 @@ class EqlClient(NamespacedClient):
89
89
  """
90
90
  .. raw:: html
91
91
 
92
- <p>Get async EQL search results.
93
- Get the current status and available results for an async EQL search or a stored synchronous EQL search.</p>
92
+ <p>Get async EQL search results.</p>
93
+ <p>Get the current status and available results for an async EQL search or a stored synchronous EQL search.</p>
94
94
 
95
95
 
96
96
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get>`_
@@ -143,8 +143,8 @@ class EqlClient(NamespacedClient):
143
143
  """
144
144
  .. raw:: html
145
145
 
146
- <p>Get the async EQL status.
147
- Get the current status for an async EQL search or a stored synchronous EQL search without returning results.</p>
146
+ <p>Get the async EQL status.</p>
147
+ <p>Get the current status for an async EQL search or a stored synchronous EQL search without returning results.</p>
148
148
 
149
149
 
150
150
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status>`_
@@ -242,14 +242,14 @@ class EqlClient(NamespacedClient):
242
242
  """
243
243
  .. raw:: html
244
244
 
245
- <p>Get EQL search results.
246
- Returns search results for an Event Query Language (EQL) query.
245
+ <p>Get EQL search results.</p>
246
+ <p>Returns search results for an Event Query Language (EQL) query.
247
247
  EQL assumes each document in a data stream or index corresponds to an event.</p>
248
248
 
249
249
 
250
250
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search>`_
251
251
 
252
- :param index: The name of the index to scope the operation
252
+ :param index: Comma-separated list of index names to scope the operation
253
253
  :param query: EQL query you wish to run.
254
254
  :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
255
255
  into no concrete indices. (This includes `_all` string or when no indices
@@ -291,7 +291,7 @@ class EqlClient(NamespacedClient):
291
291
  Defaults to 10
292
292
  :param tiebreaker_field: Field used to sort hits with the same timestamp in ascending
293
293
  order
294
- :param timestamp_field: Field containing event timestamp. Default "@timestamp"
294
+ :param timestamp_field: Field containing event timestamp.
295
295
  :param wait_for_completion_timeout:
296
296
  """
297
297
  if index in SKIP_IN_PATH:
@@ -23,13 +23,13 @@ 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
  if t.TYPE_CHECKING:
32
- from elasticsearch.esql import ESQLBase
32
+ from ...esql import ESQLBase
33
33
 
34
34
 
35
35
  class EsqlClient(NamespacedClient):
@@ -88,8 +88,8 @@ class EsqlClient(NamespacedClient):
88
88
  """
89
89
  .. raw:: html
90
90
 
91
- <p>Run an async ES|QL query.
92
- Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.</p>
91
+ <p>Run an async ES|QL query.</p>
92
+ <p>Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.</p>
93
93
  <p>The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.</p>
94
94
 
95
95
 
@@ -218,8 +218,8 @@ class EsqlClient(NamespacedClient):
218
218
  """
219
219
  .. raw:: html
220
220
 
221
- <p>Delete an async ES|QL query.
222
- If the query is still running, it is cancelled.
221
+ <p>Delete an async ES|QL query.</p>
222
+ <p>If the query is still running, it is cancelled.
223
223
  Otherwise, the stored results are deleted.</p>
224
224
  <p>If the Elasticsearch security features are enabled, only the following users can use this API to delete a query:</p>
225
225
  <ul>
@@ -284,8 +284,8 @@ class EsqlClient(NamespacedClient):
284
284
  """
285
285
  .. raw:: html
286
286
 
287
- <p>Get async ES|QL query results.
288
- Get the current status and available results or stored results for an ES|QL asynchronous query.
287
+ <p>Get async ES|QL query results.</p>
288
+ <p>Get the current status and available results or stored results for an ES|QL asynchronous query.
289
289
  If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.</p>
290
290
 
291
291
 
@@ -396,7 +396,7 @@ class EsqlClient(NamespacedClient):
396
396
  )
397
397
 
398
398
  @_rewrite_parameters()
399
- @_stability_warning(Stability.EXPERIMENTAL)
399
+ @_availability_warning(Stability.EXPERIMENTAL)
400
400
  def get_query(
401
401
  self,
402
402
  *,
@@ -409,8 +409,8 @@ class EsqlClient(NamespacedClient):
409
409
  """
410
410
  .. raw:: html
411
411
 
412
- <p>Get a specific running ES|QL query information.
413
- Returns an object extended information about a running ES|QL query.</p>
412
+ <p>Get a specific running ES|QL query information.</p>
413
+ <p>Returns an object extended information about a running ES|QL query.</p>
414
414
 
415
415
 
416
416
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-get-query>`_
@@ -441,7 +441,7 @@ class EsqlClient(NamespacedClient):
441
441
  )
442
442
 
443
443
  @_rewrite_parameters()
444
- @_stability_warning(Stability.EXPERIMENTAL)
444
+ @_availability_warning(Stability.EXPERIMENTAL)
445
445
  def list_queries(
446
446
  self,
447
447
  *,
@@ -453,8 +453,8 @@ class EsqlClient(NamespacedClient):
453
453
  """
454
454
  .. raw:: html
455
455
 
456
- <p>Get running ES|QL queries information.
457
- Returns an object containing IDs and other information about the running ES|QL queries.</p>
456
+ <p>Get running ES|QL queries information.</p>
457
+ <p>Returns an object containing IDs and other information about the running ES|QL queries.</p>
458
458
 
459
459
 
460
460
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-list-queries>`_
@@ -526,8 +526,8 @@ class EsqlClient(NamespacedClient):
526
526
  """
527
527
  .. raw:: html
528
528
 
529
- <p>Run an ES|QL query.
530
- Get search results for an ES|QL (Elasticsearch query language) query.</p>
529
+ <p>Run an ES|QL query.</p>
530
+ <p>Get search results for an ES|QL (Elasticsearch query language) query.</p>
531
531
 
532
532
 
533
533
  `<https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest>`_
@@ -20,7 +20,7 @@ import typing as t
20
20
  from elastic_transport import ObjectApiResponse
21
21
 
22
22
  from ._base import NamespacedClient
23
- from .utils import Stability, _rewrite_parameters, _stability_warning
23
+ from .utils import Stability, _availability_warning, _rewrite_parameters
24
24
 
25
25
 
26
26
  class FeaturesClient(NamespacedClient):
@@ -38,8 +38,8 @@ class FeaturesClient(NamespacedClient):
38
38
  """
39
39
  .. raw:: html
40
40
 
41
- <p>Get the features.
42
- Get a list of features that can be included in snapshots using the <code>feature_states</code> field when creating a snapshot.
41
+ <p>Get the features.</p>
42
+ <p>Get a list of features that can be included in snapshots using the <code>feature_states</code> field when creating a snapshot.
43
43
  You can use this API to determine which feature states to include when taking a snapshot.
44
44
  By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.</p>
45
45
  <p>A feature state includes one or more system indices necessary for a given feature to function.
@@ -76,7 +76,7 @@ class FeaturesClient(NamespacedClient):
76
76
  )
77
77
 
78
78
  @_rewrite_parameters()
79
- @_stability_warning(Stability.EXPERIMENTAL)
79
+ @_availability_warning(Stability.EXPERIMENTAL)
80
80
  def reset_features(
81
81
  self,
82
82
  *,
@@ -89,8 +89,8 @@ class FeaturesClient(NamespacedClient):
89
89
  """
90
90
  .. raw:: html
91
91
 
92
- <p>Reset the features.
93
- Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.</p>
92
+ <p>Reset the features.</p>
93
+ <p>Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.</p>
94
94
  <p>WARNING: Intended for development and testing use only. Do not reset features on a production cluster.</p>
95
95
  <p>Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.
96
96
  This deletes all state information stored in system indices.</p>