elasticsearch 8.17.1__py3-none-any.whl → 9.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/__init__.py +2 -2
- elasticsearch/_async/client/__init__.py +2125 -1053
- elasticsearch/_async/client/_base.py +1 -2
- elasticsearch/_async/client/async_search.py +46 -35
- elasticsearch/_async/client/autoscaling.py +32 -26
- elasticsearch/_async/client/cat.py +244 -176
- elasticsearch/_async/client/ccr.py +268 -128
- elasticsearch/_async/client/cluster.py +191 -164
- elasticsearch/_async/client/connector.py +226 -116
- elasticsearch/_async/client/dangling_indices.py +22 -16
- elasticsearch/_async/client/enrich.py +51 -11
- elasticsearch/_async/client/eql.py +54 -13
- elasticsearch/_async/client/esql.py +351 -7
- elasticsearch/_async/client/features.py +37 -27
- elasticsearch/_async/client/fleet.py +32 -22
- elasticsearch/_async/client/graph.py +10 -9
- elasticsearch/_async/client/ilm.py +115 -77
- elasticsearch/_async/client/indices.py +1119 -772
- elasticsearch/_async/client/inference.py +1933 -84
- elasticsearch/_async/client/ingest.py +83 -50
- elasticsearch/_async/client/license.py +90 -38
- elasticsearch/_async/client/logstash.py +20 -9
- elasticsearch/_async/client/migration.py +26 -17
- elasticsearch/_async/client/ml.py +646 -374
- elasticsearch/_async/client/monitoring.py +6 -3
- elasticsearch/_async/client/nodes.py +52 -54
- elasticsearch/_async/client/query_rules.py +59 -33
- elasticsearch/_async/client/rollup.py +124 -86
- elasticsearch/_async/client/search_application.py +60 -32
- elasticsearch/_async/client/searchable_snapshots.py +25 -12
- elasticsearch/_async/client/security.py +903 -562
- elasticsearch/_async/client/shutdown.py +34 -36
- elasticsearch/_async/client/simulate.py +22 -28
- elasticsearch/_async/client/slm.py +65 -40
- elasticsearch/_async/client/snapshot.py +454 -327
- elasticsearch/_async/client/sql.py +43 -22
- elasticsearch/_async/client/ssl.py +17 -18
- elasticsearch/_async/client/synonyms.py +58 -37
- elasticsearch/_async/client/tasks.py +77 -48
- elasticsearch/_async/client/text_structure.py +65 -56
- elasticsearch/_async/client/transform.py +124 -93
- elasticsearch/_async/client/watcher.py +117 -73
- elasticsearch/_async/client/xpack.py +18 -9
- elasticsearch/_async/helpers.py +1 -2
- elasticsearch/_sync/client/__init__.py +2125 -1053
- elasticsearch/_sync/client/_base.py +1 -2
- elasticsearch/_sync/client/async_search.py +46 -35
- elasticsearch/_sync/client/autoscaling.py +32 -26
- elasticsearch/_sync/client/cat.py +244 -176
- elasticsearch/_sync/client/ccr.py +268 -128
- elasticsearch/_sync/client/cluster.py +191 -164
- elasticsearch/_sync/client/connector.py +226 -116
- elasticsearch/_sync/client/dangling_indices.py +22 -16
- elasticsearch/_sync/client/enrich.py +51 -11
- elasticsearch/_sync/client/eql.py +54 -13
- elasticsearch/_sync/client/esql.py +351 -7
- elasticsearch/_sync/client/features.py +37 -27
- elasticsearch/_sync/client/fleet.py +32 -22
- elasticsearch/_sync/client/graph.py +10 -9
- elasticsearch/_sync/client/ilm.py +115 -77
- elasticsearch/_sync/client/indices.py +1119 -772
- elasticsearch/_sync/client/inference.py +1933 -84
- elasticsearch/_sync/client/ingest.py +83 -50
- elasticsearch/_sync/client/license.py +90 -38
- elasticsearch/_sync/client/logstash.py +20 -9
- elasticsearch/_sync/client/migration.py +26 -17
- elasticsearch/_sync/client/ml.py +646 -374
- elasticsearch/_sync/client/monitoring.py +6 -3
- elasticsearch/_sync/client/nodes.py +52 -54
- elasticsearch/_sync/client/query_rules.py +59 -33
- elasticsearch/_sync/client/rollup.py +124 -86
- elasticsearch/_sync/client/search_application.py +60 -32
- elasticsearch/_sync/client/searchable_snapshots.py +25 -12
- elasticsearch/_sync/client/security.py +903 -562
- elasticsearch/_sync/client/shutdown.py +34 -36
- elasticsearch/_sync/client/simulate.py +22 -28
- elasticsearch/_sync/client/slm.py +65 -40
- elasticsearch/_sync/client/snapshot.py +454 -327
- elasticsearch/_sync/client/sql.py +43 -22
- elasticsearch/_sync/client/ssl.py +17 -18
- elasticsearch/_sync/client/synonyms.py +58 -37
- elasticsearch/_sync/client/tasks.py +77 -48
- elasticsearch/_sync/client/text_structure.py +65 -56
- elasticsearch/_sync/client/transform.py +124 -93
- elasticsearch/_sync/client/utils.py +1 -41
- elasticsearch/_sync/client/watcher.py +117 -73
- elasticsearch/_sync/client/xpack.py +18 -9
- elasticsearch/_version.py +1 -1
- elasticsearch/client.py +2 -0
- elasticsearch/dsl/__init__.py +203 -0
- elasticsearch/dsl/_async/__init__.py +16 -0
- elasticsearch/dsl/_async/document.py +522 -0
- elasticsearch/dsl/_async/faceted_search.py +50 -0
- elasticsearch/dsl/_async/index.py +639 -0
- elasticsearch/dsl/_async/mapping.py +49 -0
- elasticsearch/dsl/_async/search.py +237 -0
- elasticsearch/dsl/_async/update_by_query.py +47 -0
- elasticsearch/dsl/_sync/__init__.py +16 -0
- elasticsearch/dsl/_sync/document.py +514 -0
- elasticsearch/dsl/_sync/faceted_search.py +50 -0
- elasticsearch/dsl/_sync/index.py +597 -0
- elasticsearch/dsl/_sync/mapping.py +49 -0
- elasticsearch/dsl/_sync/search.py +230 -0
- elasticsearch/dsl/_sync/update_by_query.py +45 -0
- elasticsearch/dsl/aggs.py +3734 -0
- elasticsearch/dsl/analysis.py +341 -0
- elasticsearch/dsl/async_connections.py +37 -0
- elasticsearch/dsl/connections.py +142 -0
- elasticsearch/dsl/document.py +20 -0
- elasticsearch/dsl/document_base.py +444 -0
- elasticsearch/dsl/exceptions.py +32 -0
- elasticsearch/dsl/faceted_search.py +28 -0
- elasticsearch/dsl/faceted_search_base.py +489 -0
- elasticsearch/dsl/field.py +4392 -0
- elasticsearch/dsl/function.py +180 -0
- elasticsearch/dsl/index.py +23 -0
- elasticsearch/dsl/index_base.py +178 -0
- elasticsearch/dsl/mapping.py +19 -0
- elasticsearch/dsl/mapping_base.py +219 -0
- elasticsearch/dsl/query.py +2822 -0
- elasticsearch/dsl/response/__init__.py +388 -0
- elasticsearch/dsl/response/aggs.py +100 -0
- elasticsearch/dsl/response/hit.py +53 -0
- elasticsearch/dsl/search.py +20 -0
- elasticsearch/dsl/search_base.py +1053 -0
- elasticsearch/dsl/serializer.py +34 -0
- elasticsearch/dsl/types.py +6453 -0
- elasticsearch/dsl/update_by_query.py +19 -0
- elasticsearch/dsl/update_by_query_base.py +149 -0
- elasticsearch/dsl/utils.py +687 -0
- elasticsearch/dsl/wrappers.py +144 -0
- elasticsearch/helpers/actions.py +1 -1
- elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
- elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
- elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/METADATA +12 -15
- elasticsearch-9.0.0.dist-info/RECORD +160 -0
- elasticsearch/transport.py +0 -57
- elasticsearch-8.17.1.dist-info/RECORD +0 -119
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.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
|
-
|
|
47
|
-
to the current timestamp.
|
|
46
|
+
.. raw:: html
|
|
48
47
|
|
|
49
|
-
|
|
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/docs/api/doc/elasticsearch/v9/operation/operation-connector-check-in>`_
|
|
50
53
|
|
|
51
54
|
:param connector_id: The unique identifier of the connector to be checked in
|
|
52
55
|
"""
|
|
@@ -82,20 +85,26 @@ class ConnectorClient(NamespacedClient):
|
|
|
82
85
|
delete_sync_jobs: t.Optional[bool] = None,
|
|
83
86
|
error_trace: t.Optional[bool] = None,
|
|
84
87
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
88
|
+
hard: t.Optional[bool] = None,
|
|
85
89
|
human: t.Optional[bool] = None,
|
|
86
90
|
pretty: t.Optional[bool] = None,
|
|
87
91
|
) -> ObjectApiResponse[t.Any]:
|
|
88
92
|
"""
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
+
.. raw:: html
|
|
94
|
+
|
|
95
|
+
<p>Delete a connector.</p>
|
|
96
|
+
<p>Removes a connector and associated sync jobs.
|
|
97
|
+
This is a destructive action that is not recoverable.
|
|
98
|
+
NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.
|
|
99
|
+
These need to be removed manually.</p>
|
|
100
|
+
|
|
93
101
|
|
|
94
|
-
`<https://www.elastic.co/
|
|
102
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-delete>`_
|
|
95
103
|
|
|
96
104
|
:param connector_id: The unique identifier of the connector to be deleted
|
|
97
105
|
:param delete_sync_jobs: A flag indicating if associated sync jobs should be
|
|
98
106
|
also removed. Defaults to false.
|
|
107
|
+
:param hard: A flag indicating if the connector should be hard deleted.
|
|
99
108
|
"""
|
|
100
109
|
if connector_id in SKIP_IN_PATH:
|
|
101
110
|
raise ValueError("Empty value passed for parameter 'connector_id'")
|
|
@@ -108,6 +117,8 @@ class ConnectorClient(NamespacedClient):
|
|
|
108
117
|
__query["error_trace"] = error_trace
|
|
109
118
|
if filter_path is not None:
|
|
110
119
|
__query["filter_path"] = filter_path
|
|
120
|
+
if hard is not None:
|
|
121
|
+
__query["hard"] = hard
|
|
111
122
|
if human is not None:
|
|
112
123
|
__query["human"] = human
|
|
113
124
|
if pretty is not None:
|
|
@@ -131,14 +142,21 @@ class ConnectorClient(NamespacedClient):
|
|
|
131
142
|
error_trace: t.Optional[bool] = None,
|
|
132
143
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
133
144
|
human: t.Optional[bool] = None,
|
|
145
|
+
include_deleted: t.Optional[bool] = None,
|
|
134
146
|
pretty: t.Optional[bool] = None,
|
|
135
147
|
) -> ObjectApiResponse[t.Any]:
|
|
136
148
|
"""
|
|
137
|
-
|
|
149
|
+
.. raw:: html
|
|
138
150
|
|
|
139
|
-
|
|
151
|
+
<p>Get a connector.</p>
|
|
152
|
+
<p>Get the details about a connector.</p>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-get>`_
|
|
140
156
|
|
|
141
157
|
:param connector_id: The unique identifier of the connector
|
|
158
|
+
:param include_deleted: A flag to indicate if the desired connector should be
|
|
159
|
+
fetched, even if it was soft-deleted.
|
|
142
160
|
"""
|
|
143
161
|
if connector_id in SKIP_IN_PATH:
|
|
144
162
|
raise ValueError("Empty value passed for parameter 'connector_id'")
|
|
@@ -151,6 +169,8 @@ class ConnectorClient(NamespacedClient):
|
|
|
151
169
|
__query["filter_path"] = filter_path
|
|
152
170
|
if human is not None:
|
|
153
171
|
__query["human"] = human
|
|
172
|
+
if include_deleted is not None:
|
|
173
|
+
__query["include_deleted"] = include_deleted
|
|
154
174
|
if pretty is not None:
|
|
155
175
|
__query["pretty"] = pretty
|
|
156
176
|
__headers = {"accept": "application/json"}
|
|
@@ -229,10 +249,14 @@ class ConnectorClient(NamespacedClient):
|
|
|
229
249
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
230
250
|
) -> ObjectApiResponse[t.Any]:
|
|
231
251
|
"""
|
|
232
|
-
|
|
233
|
-
|
|
252
|
+
.. raw:: html
|
|
253
|
+
|
|
254
|
+
<p>Update the connector last sync stats.</p>
|
|
255
|
+
<p>Update the fields related to the last sync of a connector.
|
|
256
|
+
This action is used for analytics and monitoring.</p>
|
|
257
|
+
|
|
234
258
|
|
|
235
|
-
`<https://www.elastic.co/
|
|
259
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-last-sync>`_
|
|
236
260
|
|
|
237
261
|
:param connector_id: The unique identifier of the connector to be updated
|
|
238
262
|
:param last_access_control_sync_error:
|
|
@@ -318,6 +342,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
318
342
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
319
343
|
from_: t.Optional[int] = None,
|
|
320
344
|
human: t.Optional[bool] = None,
|
|
345
|
+
include_deleted: t.Optional[bool] = None,
|
|
321
346
|
index_name: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
322
347
|
pretty: t.Optional[bool] = None,
|
|
323
348
|
query: t.Optional[str] = None,
|
|
@@ -325,13 +350,19 @@ class ConnectorClient(NamespacedClient):
|
|
|
325
350
|
size: t.Optional[int] = None,
|
|
326
351
|
) -> ObjectApiResponse[t.Any]:
|
|
327
352
|
"""
|
|
328
|
-
|
|
353
|
+
.. raw:: html
|
|
329
354
|
|
|
330
|
-
|
|
355
|
+
<p>Get all connectors.</p>
|
|
356
|
+
<p>Get information about all connectors.</p>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-list>`_
|
|
331
360
|
|
|
332
361
|
:param connector_name: A comma-separated list of connector names to fetch connector
|
|
333
362
|
documents for
|
|
334
363
|
:param from_: Starting offset (default: 0)
|
|
364
|
+
:param include_deleted: A flag to indicate if the desired connector should be
|
|
365
|
+
fetched, even if it was soft-deleted.
|
|
335
366
|
:param index_name: A comma-separated list of connector index names to fetch connector
|
|
336
367
|
documents for
|
|
337
368
|
:param query: A wildcard query string that filters connectors with matching name,
|
|
@@ -353,6 +384,8 @@ class ConnectorClient(NamespacedClient):
|
|
|
353
384
|
__query["from"] = from_
|
|
354
385
|
if human is not None:
|
|
355
386
|
__query["human"] = human
|
|
387
|
+
if include_deleted is not None:
|
|
388
|
+
__query["include_deleted"] = include_deleted
|
|
356
389
|
if index_name is not None:
|
|
357
390
|
__query["index_name"] = index_name
|
|
358
391
|
if pretty is not None:
|
|
@@ -400,13 +433,15 @@ class ConnectorClient(NamespacedClient):
|
|
|
400
433
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
401
434
|
) -> ObjectApiResponse[t.Any]:
|
|
402
435
|
"""
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
436
|
+
.. raw:: html
|
|
437
|
+
|
|
438
|
+
<p>Create a connector.</p>
|
|
439
|
+
<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.
|
|
440
|
+
Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud.
|
|
441
|
+
Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
|
|
442
|
+
|
|
408
443
|
|
|
409
|
-
`<https://www.elastic.co/
|
|
444
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put>`_
|
|
410
445
|
|
|
411
446
|
:param description:
|
|
412
447
|
:param index_name:
|
|
@@ -483,9 +518,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
483
518
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
484
519
|
) -> ObjectApiResponse[t.Any]:
|
|
485
520
|
"""
|
|
486
|
-
|
|
521
|
+
.. raw:: html
|
|
487
522
|
|
|
488
|
-
|
|
523
|
+
<p>Create or update a connector.</p>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put>`_
|
|
489
527
|
|
|
490
528
|
:param connector_id: The unique identifier of the connector to be created or
|
|
491
529
|
updated. ID is auto-generated if not provided.
|
|
@@ -553,12 +591,14 @@ class ConnectorClient(NamespacedClient):
|
|
|
553
591
|
pretty: t.Optional[bool] = None,
|
|
554
592
|
) -> ObjectApiResponse[t.Any]:
|
|
555
593
|
"""
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
594
|
+
.. raw:: html
|
|
595
|
+
|
|
596
|
+
<p>Cancel a connector sync job.</p>
|
|
597
|
+
<p>Cancel a connector sync job, which sets the status to cancelling and updates <code>cancellation_requested_at</code> to the current time.
|
|
598
|
+
The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
|
|
560
599
|
|
|
561
|
-
|
|
600
|
+
|
|
601
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-cancel>`_
|
|
562
602
|
|
|
563
603
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
564
604
|
"""
|
|
@@ -601,13 +641,15 @@ class ConnectorClient(NamespacedClient):
|
|
|
601
641
|
pretty: t.Optional[bool] = None,
|
|
602
642
|
) -> ObjectApiResponse[t.Any]:
|
|
603
643
|
"""
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
644
|
+
.. raw:: html
|
|
645
|
+
|
|
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>
|
|
648
|
+
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
649
|
+
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
609
650
|
|
|
610
|
-
|
|
651
|
+
|
|
652
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-check-in>`_
|
|
611
653
|
|
|
612
654
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
613
655
|
to be checked in.
|
|
@@ -656,16 +698,18 @@ class ConnectorClient(NamespacedClient):
|
|
|
656
698
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
657
699
|
) -> ObjectApiResponse[t.Any]:
|
|
658
700
|
"""
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
701
|
+
.. raw:: html
|
|
702
|
+
|
|
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.
|
|
705
|
+
Additionally, it can set the <code>sync_cursor</code> property for the sync job.</p>
|
|
706
|
+
<p>This API is not intended for direct connector management by users.
|
|
707
|
+
It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.</p>
|
|
708
|
+
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
709
|
+
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
667
710
|
|
|
668
|
-
|
|
711
|
+
|
|
712
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-claim>`_
|
|
669
713
|
|
|
670
714
|
:param connector_sync_job_id: The unique identifier of the connector sync job.
|
|
671
715
|
:param worker_hostname: The host name of the current system that will run the
|
|
@@ -720,10 +764,14 @@ class ConnectorClient(NamespacedClient):
|
|
|
720
764
|
pretty: t.Optional[bool] = None,
|
|
721
765
|
) -> ObjectApiResponse[t.Any]:
|
|
722
766
|
"""
|
|
723
|
-
|
|
724
|
-
|
|
767
|
+
.. raw:: html
|
|
768
|
+
|
|
769
|
+
<p>Delete a connector sync job.</p>
|
|
770
|
+
<p>Remove a connector sync job and its associated data.
|
|
771
|
+
This is a destructive action that is not recoverable.</p>
|
|
725
772
|
|
|
726
|
-
|
|
773
|
+
|
|
774
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-delete>`_
|
|
727
775
|
|
|
728
776
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
729
777
|
to be deleted
|
|
@@ -769,12 +817,15 @@ class ConnectorClient(NamespacedClient):
|
|
|
769
817
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
770
818
|
) -> ObjectApiResponse[t.Any]:
|
|
771
819
|
"""
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
820
|
+
.. raw:: html
|
|
821
|
+
|
|
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>
|
|
824
|
+
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
825
|
+
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
776
826
|
|
|
777
|
-
|
|
827
|
+
|
|
828
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-error>`_
|
|
778
829
|
|
|
779
830
|
:param connector_sync_job_id: The unique identifier for the connector sync job.
|
|
780
831
|
:param error: The error for the connector sync job error field.
|
|
@@ -823,9 +874,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
823
874
|
pretty: t.Optional[bool] = None,
|
|
824
875
|
) -> ObjectApiResponse[t.Any]:
|
|
825
876
|
"""
|
|
826
|
-
|
|
877
|
+
.. raw:: html
|
|
878
|
+
|
|
879
|
+
<p>Get a connector sync job.</p>
|
|
827
880
|
|
|
828
|
-
|
|
881
|
+
|
|
882
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-get>`_
|
|
829
883
|
|
|
830
884
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
831
885
|
"""
|
|
@@ -892,10 +946,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
892
946
|
] = None,
|
|
893
947
|
) -> ObjectApiResponse[t.Any]:
|
|
894
948
|
"""
|
|
895
|
-
|
|
896
|
-
|
|
949
|
+
.. raw:: html
|
|
950
|
+
|
|
951
|
+
<p>Get all connector sync jobs.</p>
|
|
952
|
+
<p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
|
|
897
953
|
|
|
898
|
-
|
|
954
|
+
|
|
955
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-list>`_
|
|
899
956
|
|
|
900
957
|
:param connector_id: A connector id to fetch connector sync jobs for
|
|
901
958
|
:param from_: Starting offset (default: 0)
|
|
@@ -955,10 +1012,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
955
1012
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
956
1013
|
) -> ObjectApiResponse[t.Any]:
|
|
957
1014
|
"""
|
|
958
|
-
|
|
959
|
-
|
|
1015
|
+
.. raw:: html
|
|
1016
|
+
|
|
1017
|
+
<p>Create a connector sync job.</p>
|
|
1018
|
+
<p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
|
|
1019
|
+
|
|
960
1020
|
|
|
961
|
-
`<https://www.elastic.co/
|
|
1021
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-post>`_
|
|
962
1022
|
|
|
963
1023
|
:param id: The id of the associated connector
|
|
964
1024
|
:param job_type:
|
|
@@ -1024,14 +1084,17 @@ class ConnectorClient(NamespacedClient):
|
|
|
1024
1084
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1025
1085
|
) -> ObjectApiResponse[t.Any]:
|
|
1026
1086
|
"""
|
|
1027
|
-
|
|
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.
|
|
1087
|
+
.. raw:: html
|
|
1033
1088
|
|
|
1034
|
-
|
|
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>.
|
|
1091
|
+
You can also update <code>last_seen</code>.
|
|
1092
|
+
This API is mainly used by the connector service for updating sync job information.</p>
|
|
1093
|
+
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
1094
|
+
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-update-stats>`_
|
|
1035
1098
|
|
|
1036
1099
|
:param connector_sync_job_id: The unique identifier of the connector sync job.
|
|
1037
1100
|
:param deleted_document_count: The number of documents the sync job deleted.
|
|
@@ -1108,10 +1171,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
1108
1171
|
pretty: t.Optional[bool] = None,
|
|
1109
1172
|
) -> ObjectApiResponse[t.Any]:
|
|
1110
1173
|
"""
|
|
1111
|
-
|
|
1112
|
-
|
|
1174
|
+
.. raw:: html
|
|
1175
|
+
|
|
1176
|
+
<p>Activate the connector draft filter.</p>
|
|
1177
|
+
<p>Activates the valid draft filtering for a connector.</p>
|
|
1178
|
+
|
|
1113
1179
|
|
|
1114
|
-
`<https://www.elastic.co/
|
|
1180
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering>`_
|
|
1115
1181
|
|
|
1116
1182
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1117
1183
|
"""
|
|
@@ -1155,13 +1221,16 @@ class ConnectorClient(NamespacedClient):
|
|
|
1155
1221
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1156
1222
|
) -> ObjectApiResponse[t.Any]:
|
|
1157
1223
|
"""
|
|
1158
|
-
|
|
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.
|
|
1224
|
+
.. raw:: html
|
|
1163
1225
|
|
|
1164
|
-
|
|
1226
|
+
<p>Update the connector API key ID.</p>
|
|
1227
|
+
<p>Update the <code>api_key_id</code> and <code>api_key_secret_id</code> fields of a connector.
|
|
1228
|
+
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.
|
|
1229
|
+
The connector secret ID is required only for Elastic managed (native) connectors.
|
|
1230
|
+
Self-managed connectors (connector clients) do not use this field.</p>
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-api-key-id>`_
|
|
1165
1234
|
|
|
1166
1235
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1167
1236
|
:param api_key_id:
|
|
@@ -1214,10 +1283,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
1214
1283
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1215
1284
|
) -> ObjectApiResponse[t.Any]:
|
|
1216
1285
|
"""
|
|
1217
|
-
|
|
1218
|
-
|
|
1286
|
+
.. raw:: html
|
|
1287
|
+
|
|
1288
|
+
<p>Update the connector configuration.</p>
|
|
1289
|
+
<p>Update the configuration field in the connector document.</p>
|
|
1290
|
+
|
|
1219
1291
|
|
|
1220
|
-
`<https://www.elastic.co/
|
|
1292
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-configuration>`_
|
|
1221
1293
|
|
|
1222
1294
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1223
1295
|
:param configuration:
|
|
@@ -1269,12 +1341,15 @@ class ConnectorClient(NamespacedClient):
|
|
|
1269
1341
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1270
1342
|
) -> ObjectApiResponse[t.Any]:
|
|
1271
1343
|
"""
|
|
1272
|
-
|
|
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.
|
|
1344
|
+
.. raw:: html
|
|
1276
1345
|
|
|
1277
|
-
|
|
1346
|
+
<p>Update the connector error field.</p>
|
|
1347
|
+
<p>Set the error field for the connector.
|
|
1348
|
+
If the error provided in the request body is non-null, the connector’s status is updated to error.
|
|
1349
|
+
Otherwise, if the error is reset to null, the connector status is updated to connected.</p>
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-error>`_
|
|
1278
1353
|
|
|
1279
1354
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1280
1355
|
:param error:
|
|
@@ -1325,16 +1400,24 @@ class ConnectorClient(NamespacedClient):
|
|
|
1325
1400
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1326
1401
|
) -> ObjectApiResponse[t.Any]:
|
|
1327
1402
|
"""
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1403
|
+
.. raw:: html
|
|
1404
|
+
|
|
1405
|
+
<p>Update the connector features.
|
|
1406
|
+
Update the connector features in the connector document.
|
|
1407
|
+
This API can be used to control the following aspects of a connector:</p>
|
|
1408
|
+
<ul>
|
|
1409
|
+
<li>document-level security</li>
|
|
1410
|
+
<li>incremental syncs</li>
|
|
1411
|
+
<li>advanced sync rules</li>
|
|
1412
|
+
<li>basic sync rules</li>
|
|
1413
|
+
</ul>
|
|
1414
|
+
<p>Normally, the running connector service automatically manages these features.
|
|
1415
|
+
However, you can use this API to override the default behavior.</p>
|
|
1416
|
+
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
|
|
1417
|
+
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
|
|
1418
|
+
|
|
1336
1419
|
|
|
1337
|
-
`<https://www.elastic.co/
|
|
1420
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-features>`_
|
|
1338
1421
|
|
|
1339
1422
|
:param connector_id: The unique identifier of the connector to be updated.
|
|
1340
1423
|
:param features:
|
|
@@ -1387,12 +1470,15 @@ class ConnectorClient(NamespacedClient):
|
|
|
1387
1470
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1388
1471
|
) -> ObjectApiResponse[t.Any]:
|
|
1389
1472
|
"""
|
|
1390
|
-
|
|
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.
|
|
1473
|
+
.. raw:: html
|
|
1394
1474
|
|
|
1395
|
-
|
|
1475
|
+
<p>Update the connector filtering.</p>
|
|
1476
|
+
<p>Update the draft filtering configuration of a connector and marks the draft validation state as edited.
|
|
1477
|
+
The filtering draft is activated once validated by the running Elastic connector service.
|
|
1478
|
+
The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering>`_
|
|
1396
1482
|
|
|
1397
1483
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1398
1484
|
:param advanced_snippet:
|
|
@@ -1447,10 +1533,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
1447
1533
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1448
1534
|
) -> ObjectApiResponse[t.Any]:
|
|
1449
1535
|
"""
|
|
1450
|
-
|
|
1451
|
-
|
|
1536
|
+
.. raw:: html
|
|
1537
|
+
|
|
1538
|
+
<p>Update the connector draft filtering validation.</p>
|
|
1539
|
+
<p>Update the draft filtering validation info for a connector.</p>
|
|
1452
1540
|
|
|
1453
|
-
|
|
1541
|
+
|
|
1542
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering-validation>`_
|
|
1454
1543
|
|
|
1455
1544
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1456
1545
|
:param validation:
|
|
@@ -1501,10 +1590,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
1501
1590
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1502
1591
|
) -> ObjectApiResponse[t.Any]:
|
|
1503
1592
|
"""
|
|
1504
|
-
|
|
1505
|
-
|
|
1593
|
+
.. raw:: html
|
|
1594
|
+
|
|
1595
|
+
<p>Update the connector index name.</p>
|
|
1596
|
+
<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
1597
|
|
|
1507
|
-
|
|
1598
|
+
|
|
1599
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-index-name>`_
|
|
1508
1600
|
|
|
1509
1601
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1510
1602
|
:param index_name:
|
|
@@ -1556,9 +1648,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
1556
1648
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1557
1649
|
) -> ObjectApiResponse[t.Any]:
|
|
1558
1650
|
"""
|
|
1559
|
-
|
|
1651
|
+
.. raw:: html
|
|
1652
|
+
|
|
1653
|
+
<p>Update the connector name and description.</p>
|
|
1560
1654
|
|
|
1561
|
-
|
|
1655
|
+
|
|
1656
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-name>`_
|
|
1562
1657
|
|
|
1563
1658
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1564
1659
|
:param description:
|
|
@@ -1610,9 +1705,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
1610
1705
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1611
1706
|
) -> ObjectApiResponse[t.Any]:
|
|
1612
1707
|
"""
|
|
1613
|
-
|
|
1708
|
+
.. raw:: html
|
|
1709
|
+
|
|
1710
|
+
<p>Update the connector is_native flag.</p>
|
|
1614
1711
|
|
|
1615
|
-
|
|
1712
|
+
|
|
1713
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-native>`_
|
|
1616
1714
|
|
|
1617
1715
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1618
1716
|
:param is_native:
|
|
@@ -1663,10 +1761,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
1663
1761
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1664
1762
|
) -> ObjectApiResponse[t.Any]:
|
|
1665
1763
|
"""
|
|
1666
|
-
|
|
1667
|
-
|
|
1764
|
+
.. raw:: html
|
|
1765
|
+
|
|
1766
|
+
<p>Update the connector pipeline.</p>
|
|
1767
|
+
<p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
|
|
1668
1768
|
|
|
1669
|
-
|
|
1769
|
+
|
|
1770
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-pipeline>`_
|
|
1670
1771
|
|
|
1671
1772
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1672
1773
|
:param pipeline:
|
|
@@ -1717,9 +1818,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
1717
1818
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1718
1819
|
) -> ObjectApiResponse[t.Any]:
|
|
1719
1820
|
"""
|
|
1720
|
-
|
|
1821
|
+
.. raw:: html
|
|
1822
|
+
|
|
1823
|
+
<p>Update the connector scheduling.</p>
|
|
1721
1824
|
|
|
1722
|
-
|
|
1825
|
+
|
|
1826
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-scheduling>`_
|
|
1723
1827
|
|
|
1724
1828
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1725
1829
|
:param scheduling:
|
|
@@ -1770,9 +1874,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
1770
1874
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1771
1875
|
) -> ObjectApiResponse[t.Any]:
|
|
1772
1876
|
"""
|
|
1773
|
-
|
|
1877
|
+
.. raw:: html
|
|
1878
|
+
|
|
1879
|
+
<p>Update the connector service type.</p>
|
|
1774
1880
|
|
|
1775
|
-
|
|
1881
|
+
|
|
1882
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-service-type>`_
|
|
1776
1883
|
|
|
1777
1884
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1778
1885
|
:param service_type:
|
|
@@ -1830,9 +1937,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
1830
1937
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1831
1938
|
) -> ObjectApiResponse[t.Any]:
|
|
1832
1939
|
"""
|
|
1833
|
-
|
|
1940
|
+
.. raw:: html
|
|
1941
|
+
|
|
1942
|
+
<p>Update the connector status.</p>
|
|
1943
|
+
|
|
1834
1944
|
|
|
1835
|
-
`<https://www.elastic.co/
|
|
1945
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-status>`_
|
|
1836
1946
|
|
|
1837
1947
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1838
1948
|
:param status:
|