elasticsearch 8.17.1__py3-none-any.whl → 8.17.2__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 (95) hide show
  1. elasticsearch/__init__.py +2 -2
  2. elasticsearch/_async/client/__init__.py +1971 -779
  3. elasticsearch/_async/client/async_search.py +33 -22
  4. elasticsearch/_async/client/autoscaling.py +27 -21
  5. elasticsearch/_async/client/cat.py +216 -141
  6. elasticsearch/_async/client/ccr.py +96 -70
  7. elasticsearch/_async/client/cluster.py +150 -142
  8. elasticsearch/_async/client/connector.py +182 -86
  9. elasticsearch/_async/client/dangling_indices.py +19 -13
  10. elasticsearch/_async/client/enrich.py +25 -6
  11. elasticsearch/_async/client/eql.py +22 -9
  12. elasticsearch/_async/client/esql.py +295 -3
  13. elasticsearch/_async/client/features.py +25 -25
  14. elasticsearch/_async/client/fleet.py +15 -9
  15. elasticsearch/_async/client/graph.py +9 -8
  16. elasticsearch/_async/client/ilm.py +85 -55
  17. elasticsearch/_async/client/indices.py +692 -549
  18. elasticsearch/_async/client/inference.py +32 -28
  19. elasticsearch/_async/client/ingest.py +61 -22
  20. elasticsearch/_async/client/license.py +48 -31
  21. elasticsearch/_async/client/logstash.py +17 -6
  22. elasticsearch/_async/client/migration.py +23 -14
  23. elasticsearch/_async/client/ml.py +532 -284
  24. elasticsearch/_async/client/monitoring.py +5 -2
  25. elasticsearch/_async/client/nodes.py +43 -27
  26. elasticsearch/_async/client/query_rules.py +51 -25
  27. elasticsearch/_async/client/rollup.py +111 -73
  28. elasticsearch/_async/client/search_application.py +49 -21
  29. elasticsearch/_async/client/searchable_snapshots.py +21 -8
  30. elasticsearch/_async/client/security.py +810 -472
  31. elasticsearch/_async/client/shutdown.py +31 -26
  32. elasticsearch/_async/client/simulate.py +16 -22
  33. elasticsearch/_async/client/slm.py +55 -30
  34. elasticsearch/_async/client/snapshot.py +173 -192
  35. elasticsearch/_async/client/sql.py +37 -16
  36. elasticsearch/_async/client/ssl.py +16 -17
  37. elasticsearch/_async/client/synonyms.py +50 -29
  38. elasticsearch/_async/client/tasks.py +74 -39
  39. elasticsearch/_async/client/text_structure.py +61 -52
  40. elasticsearch/_async/client/transform.py +108 -79
  41. elasticsearch/_async/client/watcher.py +93 -57
  42. elasticsearch/_async/client/xpack.py +16 -7
  43. elasticsearch/_async/helpers.py +1 -1
  44. elasticsearch/_sync/client/__init__.py +1971 -779
  45. elasticsearch/_sync/client/async_search.py +33 -22
  46. elasticsearch/_sync/client/autoscaling.py +27 -21
  47. elasticsearch/_sync/client/cat.py +216 -141
  48. elasticsearch/_sync/client/ccr.py +96 -70
  49. elasticsearch/_sync/client/cluster.py +150 -142
  50. elasticsearch/_sync/client/connector.py +182 -86
  51. elasticsearch/_sync/client/dangling_indices.py +19 -13
  52. elasticsearch/_sync/client/enrich.py +25 -6
  53. elasticsearch/_sync/client/eql.py +22 -9
  54. elasticsearch/_sync/client/esql.py +295 -3
  55. elasticsearch/_sync/client/features.py +25 -25
  56. elasticsearch/_sync/client/fleet.py +15 -9
  57. elasticsearch/_sync/client/graph.py +9 -8
  58. elasticsearch/_sync/client/ilm.py +85 -55
  59. elasticsearch/_sync/client/indices.py +692 -549
  60. elasticsearch/_sync/client/inference.py +32 -28
  61. elasticsearch/_sync/client/ingest.py +61 -22
  62. elasticsearch/_sync/client/license.py +48 -31
  63. elasticsearch/_sync/client/logstash.py +17 -6
  64. elasticsearch/_sync/client/migration.py +23 -14
  65. elasticsearch/_sync/client/ml.py +532 -284
  66. elasticsearch/_sync/client/monitoring.py +5 -2
  67. elasticsearch/_sync/client/nodes.py +43 -27
  68. elasticsearch/_sync/client/query_rules.py +51 -25
  69. elasticsearch/_sync/client/rollup.py +111 -73
  70. elasticsearch/_sync/client/search_application.py +49 -21
  71. elasticsearch/_sync/client/searchable_snapshots.py +21 -8
  72. elasticsearch/_sync/client/security.py +810 -472
  73. elasticsearch/_sync/client/shutdown.py +31 -26
  74. elasticsearch/_sync/client/simulate.py +16 -22
  75. elasticsearch/_sync/client/slm.py +55 -30
  76. elasticsearch/_sync/client/snapshot.py +173 -192
  77. elasticsearch/_sync/client/sql.py +37 -16
  78. elasticsearch/_sync/client/ssl.py +16 -17
  79. elasticsearch/_sync/client/synonyms.py +50 -29
  80. elasticsearch/_sync/client/tasks.py +74 -39
  81. elasticsearch/_sync/client/text_structure.py +61 -52
  82. elasticsearch/_sync/client/transform.py +108 -79
  83. elasticsearch/_sync/client/utils.py +1 -1
  84. elasticsearch/_sync/client/watcher.py +93 -57
  85. elasticsearch/_sync/client/xpack.py +16 -7
  86. elasticsearch/_version.py +1 -1
  87. elasticsearch/client.py +2 -0
  88. elasticsearch/helpers/actions.py +1 -1
  89. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
  90. {elasticsearch-8.17.1.dist-info → elasticsearch-8.17.2.dist-info}/METADATA +1 -1
  91. elasticsearch-8.17.2.dist-info/RECORD +119 -0
  92. elasticsearch-8.17.1.dist-info/RECORD +0 -119
  93. {elasticsearch-8.17.1.dist-info → elasticsearch-8.17.2.dist-info}/WHEEL +0 -0
  94. {elasticsearch-8.17.1.dist-info → elasticsearch-8.17.2.dist-info}/licenses/LICENSE +0 -0
  95. {elasticsearch-8.17.1.dist-info → elasticsearch-8.17.2.dist-info}/licenses/NOTICE +0 -0
@@ -43,8 +43,11 @@ class ConnectorClient(NamespacedClient):
43
43
  pretty: t.Optional[bool] = None,
44
44
  ) -> ObjectApiResponse[t.Any]:
45
45
  """
46
- Check in a connector. Update the `last_seen` field in the connector and set it
47
- to the current timestamp.
46
+ .. raw:: html
47
+
48
+ <p>Check in a connector.</p>
49
+ <p>Update the <code>last_seen</code> field in the connector and set it to the current timestamp.</p>
50
+
48
51
 
49
52
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-api.html>`_
50
53
 
@@ -86,10 +89,14 @@ class ConnectorClient(NamespacedClient):
86
89
  pretty: t.Optional[bool] = None,
87
90
  ) -> ObjectApiResponse[t.Any]:
88
91
  """
89
- Delete a connector. Removes a connector and associated sync jobs. This is a destructive
90
- action that is not recoverable. NOTE: This action doesn’t delete any API keys,
91
- ingest pipelines, or data indices associated with the connector. These need to
92
- be removed manually.
92
+ .. raw:: html
93
+
94
+ <p>Delete a connector.</p>
95
+ <p>Removes a connector and associated sync jobs.
96
+ This is a destructive action that is not recoverable.
97
+ NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.
98
+ These need to be removed manually.</p>
99
+
93
100
 
94
101
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-api.html>`_
95
102
 
@@ -134,7 +141,11 @@ class ConnectorClient(NamespacedClient):
134
141
  pretty: t.Optional[bool] = None,
135
142
  ) -> ObjectApiResponse[t.Any]:
136
143
  """
137
- Get a connector. Get the details about a connector.
144
+ .. raw:: html
145
+
146
+ <p>Get a connector.</p>
147
+ <p>Get the details about a connector.</p>
148
+
138
149
 
139
150
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html>`_
140
151
 
@@ -229,8 +240,12 @@ class ConnectorClient(NamespacedClient):
229
240
  body: t.Optional[t.Dict[str, t.Any]] = None,
230
241
  ) -> ObjectApiResponse[t.Any]:
231
242
  """
232
- Update the connector last sync stats. Update the fields related to the last sync
233
- of a connector. This action is used for analytics and monitoring.
243
+ .. raw:: html
244
+
245
+ <p>Update the connector last sync stats.</p>
246
+ <p>Update the fields related to the last sync of a connector.
247
+ This action is used for analytics and monitoring.</p>
248
+
234
249
 
235
250
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-last-sync-api.html>`_
236
251
 
@@ -325,7 +340,11 @@ class ConnectorClient(NamespacedClient):
325
340
  size: t.Optional[int] = None,
326
341
  ) -> ObjectApiResponse[t.Any]:
327
342
  """
328
- Get all connectors. Get information about all connectors.
343
+ .. raw:: html
344
+
345
+ <p>Get all connectors.</p>
346
+ <p>Get information about all connectors.</p>
347
+
329
348
 
330
349
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html>`_
331
350
 
@@ -400,11 +419,13 @@ class ConnectorClient(NamespacedClient):
400
419
  body: t.Optional[t.Dict[str, t.Any]] = None,
401
420
  ) -> ObjectApiResponse[t.Any]:
402
421
  """
403
- Create a connector. Connectors are Elasticsearch integrations that bring content
404
- from third-party data sources, which can be deployed on Elastic Cloud or hosted
405
- on your own infrastructure. Elastic managed connectors (Native connectors) are
406
- a managed service on Elastic Cloud. Self-managed connectors (Connector clients)
407
- are self-managed on your infrastructure.
422
+ .. raw:: html
423
+
424
+ <p>Create a connector.</p>
425
+ <p>Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.
426
+ Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud.
427
+ Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
428
+
408
429
 
409
430
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
410
431
 
@@ -483,7 +504,10 @@ class ConnectorClient(NamespacedClient):
483
504
  body: t.Optional[t.Dict[str, t.Any]] = None,
484
505
  ) -> ObjectApiResponse[t.Any]:
485
506
  """
486
- Create or update a connector.
507
+ .. raw:: html
508
+
509
+ <p>Create or update a connector.</p>
510
+
487
511
 
488
512
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
489
513
 
@@ -553,10 +577,12 @@ class ConnectorClient(NamespacedClient):
553
577
  pretty: t.Optional[bool] = None,
554
578
  ) -> ObjectApiResponse[t.Any]:
555
579
  """
556
- Cancel a connector sync job. Cancel a connector sync job, which sets the status
557
- to cancelling and updates `cancellation_requested_at` to the current time. The
558
- connector service is then responsible for setting the status of connector sync
559
- jobs to cancelled.
580
+ .. raw:: html
581
+
582
+ <p>Cancel a connector sync job.</p>
583
+ <p>Cancel a connector sync job, which sets the status to cancelling and updates <code>cancellation_requested_at</code> to the current time.
584
+ The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
585
+
560
586
 
561
587
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html>`_
562
588
 
@@ -601,11 +627,13 @@ class ConnectorClient(NamespacedClient):
601
627
  pretty: t.Optional[bool] = None,
602
628
  ) -> ObjectApiResponse[t.Any]:
603
629
  """
604
- Check in a connector sync job. Check in a connector sync job and set the `last_seen`
605
- field to the current time before updating it in the internal index. To sync data
606
- using self-managed connectors, you need to deploy the Elastic connector service
607
- on your own infrastructure. This service runs automatically on Elastic Cloud
608
- for Elastic managed connectors.
630
+ .. raw:: html
631
+
632
+ <p>Check in a connector sync job.
633
+ 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>
634
+ <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
635
+ This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
636
+
609
637
 
610
638
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-sync-job-api.html>`_
611
639
 
@@ -656,14 +684,16 @@ class ConnectorClient(NamespacedClient):
656
684
  body: t.Optional[t.Dict[str, t.Any]] = None,
657
685
  ) -> ObjectApiResponse[t.Any]:
658
686
  """
659
- Claim a connector sync job. This action updates the job status to `in_progress`
660
- and sets the `last_seen` and `started_at` timestamps to the current time. Additionally,
661
- it can set the `sync_cursor` property for the sync job. This API is not intended
662
- for direct connector management by users. It supports the implementation of services
663
- that utilize the connector protocol to communicate with Elasticsearch. To sync
664
- data using self-managed connectors, you need to deploy the Elastic connector
665
- service on your own infrastructure. This service runs automatically on Elastic
666
- Cloud for Elastic managed connectors.
687
+ .. raw:: html
688
+
689
+ <p>Claim a connector sync job.
690
+ 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.
691
+ Additionally, it can set the <code>sync_cursor</code> property for the sync job.</p>
692
+ <p>This API is not intended for direct connector management by users.
693
+ It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.</p>
694
+ <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
695
+ This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
696
+
667
697
 
668
698
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/claim-connector-sync-job-api.html>`_
669
699
 
@@ -720,8 +750,12 @@ class ConnectorClient(NamespacedClient):
720
750
  pretty: t.Optional[bool] = None,
721
751
  ) -> ObjectApiResponse[t.Any]:
722
752
  """
723
- Delete a connector sync job. Remove a connector sync job and its associated data.
724
- This is a destructive action that is not recoverable.
753
+ .. raw:: html
754
+
755
+ <p>Delete a connector sync job.</p>
756
+ <p>Remove a connector sync job and its associated data.
757
+ This is a destructive action that is not recoverable.</p>
758
+
725
759
 
726
760
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-sync-job-api.html>`_
727
761
 
@@ -769,10 +803,13 @@ class ConnectorClient(NamespacedClient):
769
803
  body: t.Optional[t.Dict[str, t.Any]] = None,
770
804
  ) -> ObjectApiResponse[t.Any]:
771
805
  """
772
- Set a connector sync job error. Set the `error` field for a connector sync job
773
- and set its `status` to `error`. To sync data using self-managed connectors,
774
- you need to deploy the Elastic connector service on your own infrastructure.
775
- This service runs automatically on Elastic Cloud for Elastic managed connectors.
806
+ .. raw:: html
807
+
808
+ <p>Set a connector sync job error.
809
+ Set the <code>error</code> field for a connector sync job and set its <code>status</code> to <code>error</code>.</p>
810
+ <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
811
+ This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
812
+
776
813
 
777
814
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/set-connector-sync-job-error-api.html>`_
778
815
 
@@ -823,7 +860,10 @@ class ConnectorClient(NamespacedClient):
823
860
  pretty: t.Optional[bool] = None,
824
861
  ) -> ObjectApiResponse[t.Any]:
825
862
  """
826
- Get a connector sync job.
863
+ .. raw:: html
864
+
865
+ <p>Get a connector sync job.</p>
866
+
827
867
 
828
868
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-sync-job-api.html>`_
829
869
 
@@ -892,8 +932,11 @@ class ConnectorClient(NamespacedClient):
892
932
  ] = None,
893
933
  ) -> ObjectApiResponse[t.Any]:
894
934
  """
895
- Get all connector sync jobs. Get information about all stored connector sync
896
- jobs listed by their creation date in ascending order.
935
+ .. raw:: html
936
+
937
+ <p>Get all connector sync jobs.</p>
938
+ <p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
939
+
897
940
 
898
941
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html>`_
899
942
 
@@ -955,8 +998,11 @@ class ConnectorClient(NamespacedClient):
955
998
  body: t.Optional[t.Dict[str, t.Any]] = None,
956
999
  ) -> ObjectApiResponse[t.Any]:
957
1000
  """
958
- Create a connector sync job. Create a connector sync job document in the internal
959
- index and initialize its counters and timestamps with default values.
1001
+ .. raw:: html
1002
+
1003
+ <p>Create a connector sync job.</p>
1004
+ <p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
1005
+
960
1006
 
961
1007
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-sync-job-api.html>`_
962
1008
 
@@ -1024,12 +1070,15 @@ class ConnectorClient(NamespacedClient):
1024
1070
  body: t.Optional[t.Dict[str, t.Any]] = None,
1025
1071
  ) -> ObjectApiResponse[t.Any]:
1026
1072
  """
1027
- Set the connector sync job stats. Stats include: `deleted_document_count`, `indexed_document_count`,
1028
- `indexed_document_volume`, and `total_document_count`. You can also update `last_seen`.
1029
- This API is mainly used by the connector service for updating sync job information.
1030
- To sync data using self-managed connectors, you need to deploy the Elastic connector
1031
- service on your own infrastructure. This service runs automatically on Elastic
1032
- Cloud for Elastic managed connectors.
1073
+ .. raw:: html
1074
+
1075
+ <p>Set the connector sync job stats.
1076
+ Stats include: <code>deleted_document_count</code>, <code>indexed_document_count</code>, <code>indexed_document_volume</code>, and <code>total_document_count</code>.
1077
+ You can also update <code>last_seen</code>.
1078
+ This API is mainly used by the connector service for updating sync job information.</p>
1079
+ <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
1080
+ This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1081
+
1033
1082
 
1034
1083
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/set-connector-sync-job-stats-api.html>`_
1035
1084
 
@@ -1108,8 +1157,11 @@ class ConnectorClient(NamespacedClient):
1108
1157
  pretty: t.Optional[bool] = None,
1109
1158
  ) -> ObjectApiResponse[t.Any]:
1110
1159
  """
1111
- Activate the connector draft filter. Activates the valid draft filtering for
1112
- a connector.
1160
+ .. raw:: html
1161
+
1162
+ <p>Activate the connector draft filter.</p>
1163
+ <p>Activates the valid draft filtering for a connector.</p>
1164
+
1113
1165
 
1114
1166
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html>`_
1115
1167
 
@@ -1155,11 +1207,14 @@ class ConnectorClient(NamespacedClient):
1155
1207
  body: t.Optional[t.Dict[str, t.Any]] = None,
1156
1208
  ) -> ObjectApiResponse[t.Any]:
1157
1209
  """
1158
- Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id`
1159
- fields of a connector. You can specify the ID of the API key used for authorization
1160
- and the ID of the connector secret where the API key is stored. The connector
1161
- secret ID is required only for Elastic managed (native) connectors. Self-managed
1162
- connectors (connector clients) do not use this field.
1210
+ .. raw:: html
1211
+
1212
+ <p>Update the connector API key ID.</p>
1213
+ <p>Update the <code>api_key_id</code> and <code>api_key_secret_id</code> fields of a connector.
1214
+ You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.
1215
+ The connector secret ID is required only for Elastic managed (native) connectors.
1216
+ Self-managed connectors (connector clients) do not use this field.</p>
1217
+
1163
1218
 
1164
1219
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html>`_
1165
1220
 
@@ -1214,8 +1269,11 @@ class ConnectorClient(NamespacedClient):
1214
1269
  body: t.Optional[t.Dict[str, t.Any]] = None,
1215
1270
  ) -> ObjectApiResponse[t.Any]:
1216
1271
  """
1217
- Update the connector configuration. Update the configuration field in the connector
1218
- document.
1272
+ .. raw:: html
1273
+
1274
+ <p>Update the connector configuration.</p>
1275
+ <p>Update the configuration field in the connector document.</p>
1276
+
1219
1277
 
1220
1278
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-configuration-api.html>`_
1221
1279
 
@@ -1269,10 +1327,13 @@ class ConnectorClient(NamespacedClient):
1269
1327
  body: t.Optional[t.Dict[str, t.Any]] = None,
1270
1328
  ) -> ObjectApiResponse[t.Any]:
1271
1329
  """
1272
- Update the connector error field. Set the error field for the connector. If the
1273
- error provided in the request body is non-null, the connector’s status is updated
1274
- to error. Otherwise, if the error is reset to null, the connector status is updated
1275
- to connected.
1330
+ .. raw:: html
1331
+
1332
+ <p>Update the connector error field.</p>
1333
+ <p>Set the error field for the connector.
1334
+ If the error provided in the request body is non-null, the connector’s status is updated to error.
1335
+ Otherwise, if the error is reset to null, the connector status is updated to connected.</p>
1336
+
1276
1337
 
1277
1338
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-error-api.html>`_
1278
1339
 
@@ -1325,14 +1386,22 @@ class ConnectorClient(NamespacedClient):
1325
1386
  body: t.Optional[t.Dict[str, t.Any]] = None,
1326
1387
  ) -> ObjectApiResponse[t.Any]:
1327
1388
  """
1328
- Update the connector features. Update the connector features in the connector
1329
- document. This API can be used to control the following aspects of a connector:
1330
- * document-level security * incremental syncs * advanced sync rules * basic sync
1331
- rules Normally, the running connector service automatically manages these features.
1332
- However, you can use this API to override the default behavior. To sync data
1333
- using self-managed connectors, you need to deploy the Elastic connector service
1334
- on your own infrastructure. This service runs automatically on Elastic Cloud
1335
- for Elastic managed connectors.
1389
+ .. raw:: html
1390
+
1391
+ <p>Update the connector features.
1392
+ Update the connector features in the connector document.
1393
+ This API can be used to control the following aspects of a connector:</p>
1394
+ <ul>
1395
+ <li>document-level security</li>
1396
+ <li>incremental syncs</li>
1397
+ <li>advanced sync rules</li>
1398
+ <li>basic sync rules</li>
1399
+ </ul>
1400
+ <p>Normally, the running connector service automatically manages these features.
1401
+ However, you can use this API to override the default behavior.</p>
1402
+ <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
1403
+ This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1404
+
1336
1405
 
1337
1406
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-features-api.html>`_
1338
1407
 
@@ -1387,10 +1456,13 @@ class ConnectorClient(NamespacedClient):
1387
1456
  body: t.Optional[t.Dict[str, t.Any]] = None,
1388
1457
  ) -> ObjectApiResponse[t.Any]:
1389
1458
  """
1390
- Update the connector filtering. Update the draft filtering configuration of a
1391
- connector and marks the draft validation state as edited. The filtering draft
1392
- is activated once validated by the running Elastic connector service. The filtering
1393
- property is used to configure sync rules (both basic and advanced) for a connector.
1459
+ .. raw:: html
1460
+
1461
+ <p>Update the connector filtering.</p>
1462
+ <p>Update the draft filtering configuration of a connector and marks the draft validation state as edited.
1463
+ The filtering draft is activated once validated by the running Elastic connector service.
1464
+ The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
1465
+
1394
1466
 
1395
1467
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html>`_
1396
1468
 
@@ -1447,8 +1519,11 @@ class ConnectorClient(NamespacedClient):
1447
1519
  body: t.Optional[t.Dict[str, t.Any]] = None,
1448
1520
  ) -> ObjectApiResponse[t.Any]:
1449
1521
  """
1450
- Update the connector draft filtering validation. Update the draft filtering validation
1451
- info for a connector.
1522
+ .. raw:: html
1523
+
1524
+ <p>Update the connector draft filtering validation.</p>
1525
+ <p>Update the draft filtering validation info for a connector.</p>
1526
+
1452
1527
 
1453
1528
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-validation-api.html>`_
1454
1529
 
@@ -1501,8 +1576,11 @@ class ConnectorClient(NamespacedClient):
1501
1576
  body: t.Optional[t.Dict[str, t.Any]] = None,
1502
1577
  ) -> ObjectApiResponse[t.Any]:
1503
1578
  """
1504
- Update the connector index name. Update the `index_name` field of a connector,
1505
- specifying the index where the data ingested by the connector is stored.
1579
+ .. raw:: html
1580
+
1581
+ <p>Update the connector index name.</p>
1582
+ <p>Update the <code>index_name</code> field of a connector, specifying the index where the data ingested by the connector is stored.</p>
1583
+
1506
1584
 
1507
1585
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-index-name-api.html>`_
1508
1586
 
@@ -1556,7 +1634,10 @@ class ConnectorClient(NamespacedClient):
1556
1634
  body: t.Optional[t.Dict[str, t.Any]] = None,
1557
1635
  ) -> ObjectApiResponse[t.Any]:
1558
1636
  """
1559
- Update the connector name and description.
1637
+ .. raw:: html
1638
+
1639
+ <p>Update the connector name and description.</p>
1640
+
1560
1641
 
1561
1642
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-name-description-api.html>`_
1562
1643
 
@@ -1610,7 +1691,10 @@ class ConnectorClient(NamespacedClient):
1610
1691
  body: t.Optional[t.Dict[str, t.Any]] = None,
1611
1692
  ) -> ObjectApiResponse[t.Any]:
1612
1693
  """
1613
- Update the connector is_native flag.
1694
+ .. raw:: html
1695
+
1696
+ <p>Update the connector is_native flag.</p>
1697
+
1614
1698
 
1615
1699
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-native-api.html>`_
1616
1700
 
@@ -1663,8 +1747,11 @@ class ConnectorClient(NamespacedClient):
1663
1747
  body: t.Optional[t.Dict[str, t.Any]] = None,
1664
1748
  ) -> ObjectApiResponse[t.Any]:
1665
1749
  """
1666
- Update the connector pipeline. When you create a new connector, the configuration
1667
- of an ingest pipeline is populated with default settings.
1750
+ .. raw:: html
1751
+
1752
+ <p>Update the connector pipeline.</p>
1753
+ <p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
1754
+
1668
1755
 
1669
1756
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-pipeline-api.html>`_
1670
1757
 
@@ -1717,7 +1804,10 @@ class ConnectorClient(NamespacedClient):
1717
1804
  body: t.Optional[t.Dict[str, t.Any]] = None,
1718
1805
  ) -> ObjectApiResponse[t.Any]:
1719
1806
  """
1720
- Update the connector scheduling.
1807
+ .. raw:: html
1808
+
1809
+ <p>Update the connector scheduling.</p>
1810
+
1721
1811
 
1722
1812
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-scheduling-api.html>`_
1723
1813
 
@@ -1770,7 +1860,10 @@ class ConnectorClient(NamespacedClient):
1770
1860
  body: t.Optional[t.Dict[str, t.Any]] = None,
1771
1861
  ) -> ObjectApiResponse[t.Any]:
1772
1862
  """
1773
- Update the connector service type.
1863
+ .. raw:: html
1864
+
1865
+ <p>Update the connector service type.</p>
1866
+
1774
1867
 
1775
1868
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-service-type-api.html>`_
1776
1869
 
@@ -1830,7 +1923,10 @@ class ConnectorClient(NamespacedClient):
1830
1923
  body: t.Optional[t.Dict[str, t.Any]] = None,
1831
1924
  ) -> ObjectApiResponse[t.Any]:
1832
1925
  """
1833
- Update the connector status.
1926
+ .. raw:: html
1927
+
1928
+ <p>Update the connector status.</p>
1929
+
1834
1930
 
1835
1931
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-status-api.html>`_
1836
1932
 
@@ -39,10 +39,12 @@ class DanglingIndicesClient(NamespacedClient):
39
39
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
40
40
  ) -> ObjectApiResponse[t.Any]:
41
41
  """
42
- Delete a dangling index. If Elasticsearch encounters index data that is absent
43
- from the current cluster state, those indices are considered to be dangling.
44
- For example, this can happen if you delete more than `cluster.indices.tombstones.size`
45
- indices while an Elasticsearch node is offline.
42
+ .. raw:: html
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.
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
+
46
48
 
47
49
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-index-delete.html>`_
48
50
 
@@ -98,10 +100,12 @@ class DanglingIndicesClient(NamespacedClient):
98
100
  timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
99
101
  ) -> ObjectApiResponse[t.Any]:
100
102
  """
101
- Import a dangling index. If Elasticsearch encounters index data that is absent
102
- from the current cluster state, those indices are considered to be dangling.
103
- For example, this can happen if you delete more than `cluster.indices.tombstones.size`
104
- indices while an Elasticsearch node is offline.
103
+ .. raw:: html
104
+
105
+ <p>Import a dangling index.</p>
106
+ <p>If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
107
+ For example, this can happen if you delete more than <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch node is offline.</p>
108
+
105
109
 
106
110
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-index-import.html>`_
107
111
 
@@ -156,11 +160,13 @@ class DanglingIndicesClient(NamespacedClient):
156
160
  pretty: t.Optional[bool] = None,
157
161
  ) -> ObjectApiResponse[t.Any]:
158
162
  """
159
- Get the dangling indices. If Elasticsearch encounters index data that is absent
160
- from the current cluster state, those indices are considered to be dangling.
161
- For example, this can happen if you delete more than `cluster.indices.tombstones.size`
162
- indices while an Elasticsearch node is offline. Use this API to list dangling
163
- indices, which you can then import or delete.
163
+ .. raw:: html
164
+
165
+ <p>Get the dangling indices.</p>
166
+ <p>If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.
167
+ For example, this can happen if you delete more than <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch node is offline.</p>
168
+ <p>Use this API to list dangling indices, which you can then import or delete.</p>
169
+
164
170
 
165
171
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-indices-list.html>`_
166
172
  """
@@ -36,7 +36,11 @@ class EnrichClient(NamespacedClient):
36
36
  pretty: t.Optional[bool] = None,
37
37
  ) -> ObjectApiResponse[t.Any]:
38
38
  """
39
- Delete an enrich policy. Deletes an existing enrich policy and its enrich index.
39
+ .. raw:: html
40
+
41
+ <p>Delete an enrich policy.
42
+ Deletes an existing enrich policy and its enrich index.</p>
43
+
40
44
 
41
45
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-enrich-policy-api.html>`_
42
46
 
@@ -77,7 +81,11 @@ class EnrichClient(NamespacedClient):
77
81
  wait_for_completion: t.Optional[bool] = None,
78
82
  ) -> ObjectApiResponse[t.Any]:
79
83
  """
80
- Run an enrich policy. Create the enrich index for an existing enrich policy.
84
+ .. raw:: html
85
+
86
+ <p>Run an enrich policy.
87
+ Create the enrich index for an existing enrich policy.</p>
88
+
81
89
 
82
90
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/execute-enrich-policy-api.html>`_
83
91
 
@@ -121,7 +129,11 @@ class EnrichClient(NamespacedClient):
121
129
  pretty: t.Optional[bool] = None,
122
130
  ) -> ObjectApiResponse[t.Any]:
123
131
  """
124
- Get an enrich policy. Returns information about an enrich policy.
132
+ .. raw:: html
133
+
134
+ <p>Get an enrich policy.
135
+ Returns information about an enrich policy.</p>
136
+
125
137
 
126
138
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-enrich-policy-api.html>`_
127
139
 
@@ -171,7 +183,11 @@ class EnrichClient(NamespacedClient):
171
183
  body: t.Optional[t.Dict[str, t.Any]] = None,
172
184
  ) -> ObjectApiResponse[t.Any]:
173
185
  """
174
- Create an enrich policy. Creates an enrich policy.
186
+ .. raw:: html
187
+
188
+ <p>Create an enrich policy.
189
+ Creates an enrich policy.</p>
190
+
175
191
 
176
192
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-enrich-policy-api.html>`_
177
193
 
@@ -224,8 +240,11 @@ class EnrichClient(NamespacedClient):
224
240
  pretty: t.Optional[bool] = None,
225
241
  ) -> ObjectApiResponse[t.Any]:
226
242
  """
227
- Get enrich stats. Returns enrich coordinator statistics and information about
228
- enrich policies that are currently executing.
243
+ .. raw:: html
244
+
245
+ <p>Get enrich stats.
246
+ Returns enrich coordinator statistics and information about enrich policies that are currently executing.</p>
247
+
229
248
 
230
249
  `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/enrich-stats-api.html>`_
231
250
  """