elasticsearch 8.17.1__py3-none-any.whl → 8.18.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 (139) hide show
  1. elasticsearch/__init__.py +2 -2
  2. elasticsearch/_async/client/__init__.py +2146 -859
  3. elasticsearch/_async/client/_base.py +0 -1
  4. elasticsearch/_async/client/async_search.py +44 -29
  5. elasticsearch/_async/client/autoscaling.py +32 -26
  6. elasticsearch/_async/client/cat.py +244 -169
  7. elasticsearch/_async/client/ccr.py +268 -128
  8. elasticsearch/_async/client/cluster.py +191 -164
  9. elasticsearch/_async/client/connector.py +212 -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 +352 -4
  14. elasticsearch/_async/client/features.py +37 -27
  15. elasticsearch/_async/client/fleet.py +22 -10
  16. elasticsearch/_async/client/graph.py +10 -9
  17. elasticsearch/_async/client/ilm.py +108 -77
  18. elasticsearch/_async/client/indices.py +1112 -677
  19. elasticsearch/_async/client/inference.py +1875 -133
  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 +642 -365
  25. elasticsearch/_async/client/monitoring.py +6 -3
  26. elasticsearch/_async/client/nodes.py +51 -53
  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 +896 -558
  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 +190 -213
  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 +116 -72
  43. elasticsearch/_async/client/xpack.py +18 -9
  44. elasticsearch/_async/helpers.py +1 -2
  45. elasticsearch/_sync/client/__init__.py +2146 -859
  46. elasticsearch/_sync/client/_base.py +0 -1
  47. elasticsearch/_sync/client/async_search.py +44 -29
  48. elasticsearch/_sync/client/autoscaling.py +32 -26
  49. elasticsearch/_sync/client/cat.py +244 -169
  50. elasticsearch/_sync/client/ccr.py +268 -128
  51. elasticsearch/_sync/client/cluster.py +191 -164
  52. elasticsearch/_sync/client/connector.py +212 -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 +352 -4
  57. elasticsearch/_sync/client/features.py +37 -27
  58. elasticsearch/_sync/client/fleet.py +22 -10
  59. elasticsearch/_sync/client/graph.py +10 -9
  60. elasticsearch/_sync/client/ilm.py +108 -77
  61. elasticsearch/_sync/client/indices.py +1112 -677
  62. elasticsearch/_sync/client/inference.py +1875 -133
  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 +642 -365
  68. elasticsearch/_sync/client/monitoring.py +6 -3
  69. elasticsearch/_sync/client/nodes.py +51 -53
  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 +896 -558
  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 +190 -213
  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 -4
  86. elasticsearch/_sync/client/watcher.py +116 -72
  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 +233 -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 +226 -0
  104. elasticsearch/dsl/_sync/update_by_query.py +45 -0
  105. elasticsearch/dsl/aggs.py +3730 -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 +4254 -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 +2816 -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 +1040 -0
  126. elasticsearch/dsl/serializer.py +34 -0
  127. elasticsearch/dsl/types.py +6471 -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 +119 -0
  132. elasticsearch/helpers/actions.py +1 -1
  133. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
  134. {elasticsearch-8.17.1.dist-info → elasticsearch-8.18.0.dist-info}/METADATA +12 -2
  135. elasticsearch-8.18.0.dist-info/RECORD +161 -0
  136. elasticsearch-8.17.1.dist-info/RECORD +0 -119
  137. {elasticsearch-8.17.1.dist-info → elasticsearch-8.18.0.dist-info}/WHEEL +0 -0
  138. {elasticsearch-8.17.1.dist-info → elasticsearch-8.18.0.dist-info}/licenses/LICENSE +0 -0
  139. {elasticsearch-8.17.1.dist-info → elasticsearch-8.18.0.dist-info}/licenses/NOTICE +0 -0
@@ -43,10 +43,13 @@ 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
48
47
 
49
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-api.html>`_
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
+
51
+
52
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/check-in-connector-api.html>`_
50
53
 
51
54
  :param connector_id: The unique identifier of the connector to be checked in
52
55
  """
@@ -86,12 +89,16 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-api.html>`_
101
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-connector-api.html>`_
95
102
 
96
103
  :param connector_id: The unique identifier of the connector to be deleted
97
104
  :param delete_sync_jobs: A flag indicating if associated sync jobs should be
@@ -134,9 +141,13 @@ 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
138
145
 
139
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-api.html>`_
146
+ <p>Get a connector.</p>
147
+ <p>Get the details about a connector.</p>
148
+
149
+
150
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-connector-api.html>`_
140
151
 
141
152
  :param connector_id: The unique identifier of the connector
142
153
  """
@@ -229,10 +240,14 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-last-sync-api.html>`_
250
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-last-sync-api.html>`_
236
251
 
237
252
  :param connector_id: The unique identifier of the connector to be updated
238
253
  :param last_access_control_sync_error:
@@ -325,9 +340,13 @@ 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
329
344
 
330
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-api.html>`_
345
+ <p>Get all connectors.</p>
346
+ <p>Get information about all connectors.</p>
347
+
348
+
349
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-connector-api.html>`_
331
350
 
332
351
  :param connector_name: A comma-separated list of connector names to fetch connector
333
352
  documents for
@@ -400,13 +419,15 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
430
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-api.html>`_
410
431
 
411
432
  :param description:
412
433
  :param index_name:
@@ -483,9 +504,12 @@ 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
487
508
 
488
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-api.html>`_
509
+ <p>Create or update a connector.</p>
510
+
511
+
512
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-api.html>`_
489
513
 
490
514
  :param connector_id: The unique identifier of the connector to be created or
491
515
  updated. ID is auto-generated if not provided.
@@ -553,12 +577,14 @@ 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>
560
585
 
561
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html>`_
586
+
587
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cancel-connector-sync-job-api.html>`_
562
588
 
563
589
  :param connector_sync_job_id: The unique identifier of the connector sync job
564
590
  """
@@ -601,13 +627,15 @@ 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>
609
636
 
610
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-sync-job-api.html>`_
637
+
638
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/check-in-connector-sync-job-api.html>`_
611
639
 
612
640
  :param connector_sync_job_id: The unique identifier of the connector sync job
613
641
  to be checked in.
@@ -656,16 +684,18 @@ 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>
667
696
 
668
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/claim-connector-sync-job-api.html>`_
697
+
698
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/claim-connector-sync-job-api.html>`_
669
699
 
670
700
  :param connector_sync_job_id: The unique identifier of the connector sync job.
671
701
  :param worker_hostname: The host name of the current system that will run the
@@ -720,10 +750,14 @@ 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>
725
758
 
726
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-connector-sync-job-api.html>`_
759
+
760
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-connector-sync-job-api.html>`_
727
761
 
728
762
  :param connector_sync_job_id: The unique identifier of the connector sync job
729
763
  to be deleted
@@ -769,12 +803,15 @@ 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>
776
812
 
777
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/set-connector-sync-job-error-api.html>`_
813
+
814
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/set-connector-sync-job-error-api.html>`_
778
815
 
779
816
  :param connector_sync_job_id: The unique identifier for the connector sync job.
780
817
  :param error: The error for the connector sync job error field.
@@ -823,9 +860,12 @@ 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>
827
866
 
828
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-connector-sync-job-api.html>`_
867
+
868
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-connector-sync-job-api.html>`_
829
869
 
830
870
  :param connector_sync_job_id: The unique identifier of the connector sync job
831
871
  """
@@ -892,10 +932,13 @@ 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>
897
939
 
898
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html>`_
940
+
941
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-connector-sync-jobs-api.html>`_
899
942
 
900
943
  :param connector_id: A connector id to fetch connector sync jobs for
901
944
  :param from_: Starting offset (default: 0)
@@ -955,10 +998,13 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/create-connector-sync-job-api.html>`_
1007
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-sync-job-api.html>`_
962
1008
 
963
1009
  :param id: The id of the associated connector
964
1010
  :param job_type:
@@ -1024,14 +1070,17 @@ 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
1033
1074
 
1034
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/set-connector-sync-job-stats-api.html>`_
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
+
1082
+
1083
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/set-connector-sync-job-stats-api.html>`_
1035
1084
 
1036
1085
  :param connector_sync_job_id: The unique identifier of the connector sync job.
1037
1086
  :param deleted_document_count: The number of documents the sync job deleted.
@@ -1108,10 +1157,13 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html>`_
1166
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-api.html>`_
1115
1167
 
1116
1168
  :param connector_id: The unique identifier of the connector to be updated
1117
1169
  """
@@ -1155,13 +1207,16 @@ 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
1163
1211
 
1164
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html>`_
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
+
1218
+
1219
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-api-key-id-api.html>`_
1165
1220
 
1166
1221
  :param connector_id: The unique identifier of the connector to be updated
1167
1222
  :param api_key_id:
@@ -1214,10 +1269,13 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-configuration-api.html>`_
1278
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-configuration-api.html>`_
1221
1279
 
1222
1280
  :param connector_id: The unique identifier of the connector to be updated
1223
1281
  :param configuration:
@@ -1269,12 +1327,15 @@ 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
1276
1331
 
1277
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-error-api.html>`_
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
+
1337
+
1338
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-error-api.html>`_
1278
1339
 
1279
1340
  :param connector_id: The unique identifier of the connector to be updated
1280
1341
  :param error:
@@ -1325,16 +1386,24 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-features-api.html>`_
1406
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-features-api.html>`_
1338
1407
 
1339
1408
  :param connector_id: The unique identifier of the connector to be updated.
1340
1409
  :param features:
@@ -1387,12 +1456,15 @@ 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
1394
1460
 
1395
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-api.html>`_
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
+
1466
+
1467
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-api.html>`_
1396
1468
 
1397
1469
  :param connector_id: The unique identifier of the connector to be updated
1398
1470
  :param advanced_snippet:
@@ -1447,10 +1519,13 @@ 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>
1452
1526
 
1453
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-filtering-validation-api.html>`_
1527
+
1528
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-validation-api.html>`_
1454
1529
 
1455
1530
  :param connector_id: The unique identifier of the connector to be updated
1456
1531
  :param validation:
@@ -1501,10 +1576,13 @@ 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>
1506
1583
 
1507
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-index-name-api.html>`_
1584
+
1585
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-index-name-api.html>`_
1508
1586
 
1509
1587
  :param connector_id: The unique identifier of the connector to be updated
1510
1588
  :param index_name:
@@ -1556,9 +1634,12 @@ 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>
1560
1640
 
1561
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-name-description-api.html>`_
1641
+
1642
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-name-description-api.html>`_
1562
1643
 
1563
1644
  :param connector_id: The unique identifier of the connector to be updated
1564
1645
  :param description:
@@ -1610,9 +1691,12 @@ 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>
1614
1697
 
1615
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-native-api.html>`_
1698
+
1699
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-native-api.html>`_
1616
1700
 
1617
1701
  :param connector_id: The unique identifier of the connector to be updated
1618
1702
  :param is_native:
@@ -1663,10 +1747,13 @@ 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>
1668
1754
 
1669
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-pipeline-api.html>`_
1755
+
1756
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-pipeline-api.html>`_
1670
1757
 
1671
1758
  :param connector_id: The unique identifier of the connector to be updated
1672
1759
  :param pipeline:
@@ -1717,9 +1804,12 @@ 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>
1721
1810
 
1722
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-scheduling-api.html>`_
1811
+
1812
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-scheduling-api.html>`_
1723
1813
 
1724
1814
  :param connector_id: The unique identifier of the connector to be updated
1725
1815
  :param scheduling:
@@ -1770,9 +1860,12 @@ 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>
1774
1866
 
1775
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-service-type-api.html>`_
1867
+
1868
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-service-type-api.html>`_
1776
1869
 
1777
1870
  :param connector_id: The unique identifier of the connector to be updated
1778
1871
  :param service_type:
@@ -1830,9 +1923,12 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-status-api.html>`_
1931
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-status-api.html>`_
1836
1932
 
1837
1933
  :param connector_id: The unique identifier of the connector to be updated
1838
1934
  :param status:
@@ -39,12 +39,14 @@ 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
46
43
 
47
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-index-delete.html>`_
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
+
48
+
49
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/dangling-index-delete.html>`_
48
50
 
49
51
  :param index_uuid: The UUID of the index to delete. Use the get dangling indices
50
52
  API to find the UUID.
@@ -98,12 +100,14 @@ 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>
105
108
 
106
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-index-import.html>`_
109
+
110
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/dangling-index-import.html>`_
107
111
 
108
112
  :param index_uuid: The UUID of the index to import. Use the get dangling indices
109
113
  API to locate the UUID.
@@ -156,13 +160,15 @@ 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
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-indices-list.html>`_
171
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/dangling-indices-list.html>`_
166
172
  """
167
173
  __path_parts: t.Dict[str, str] = {}
168
174
  __path = "/_dangling"