elasticsearch 8.15.0__py3-none-any.whl → 8.16.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/_async/client/__init__.py +202 -117
- elasticsearch/_async/client/async_search.py +25 -25
- elasticsearch/_async/client/autoscaling.py +24 -11
- elasticsearch/_async/client/cat.py +75 -66
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +40 -37
- elasticsearch/_async/client/connector.py +112 -51
- elasticsearch/_async/client/dangling_indices.py +27 -12
- elasticsearch/_async/client/enrich.py +10 -10
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +42 -4
- elasticsearch/_async/client/features.py +4 -3
- elasticsearch/_async/client/fleet.py +10 -2
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +16 -12
- elasticsearch/_async/client/indices.py +189 -108
- elasticsearch/_async/client/inference.py +15 -5
- elasticsearch/_async/client/ingest.py +200 -9
- elasticsearch/_async/client/license.py +10 -10
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +294 -291
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +16 -8
- elasticsearch/_async/client/query_rules.py +61 -8
- elasticsearch/_async/client/rollup.py +23 -9
- elasticsearch/_async/client/search_application.py +35 -16
- elasticsearch/_async/client/searchable_snapshots.py +13 -5
- elasticsearch/_async/client/security.py +371 -180
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +97 -12
- elasticsearch/_async/client/sql.py +11 -7
- elasticsearch/_async/client/ssl.py +18 -3
- elasticsearch/_async/client/synonyms.py +10 -8
- elasticsearch/_async/client/tasks.py +19 -9
- elasticsearch/_async/client/text_structure.py +2 -2
- elasticsearch/_async/client/transform.py +78 -72
- elasticsearch/_async/client/utils.py +4 -0
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +5 -3
- elasticsearch/_async/helpers.py +19 -10
- elasticsearch/_otel.py +23 -1
- elasticsearch/_sync/client/__init__.py +202 -117
- elasticsearch/_sync/client/async_search.py +25 -25
- elasticsearch/_sync/client/autoscaling.py +24 -11
- elasticsearch/_sync/client/cat.py +75 -66
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +40 -37
- elasticsearch/_sync/client/connector.py +112 -51
- elasticsearch/_sync/client/dangling_indices.py +27 -12
- elasticsearch/_sync/client/enrich.py +10 -10
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +42 -4
- elasticsearch/_sync/client/features.py +4 -3
- elasticsearch/_sync/client/fleet.py +10 -2
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +16 -12
- elasticsearch/_sync/client/indices.py +189 -108
- elasticsearch/_sync/client/inference.py +15 -5
- elasticsearch/_sync/client/ingest.py +200 -9
- elasticsearch/_sync/client/license.py +10 -10
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +294 -291
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +16 -8
- elasticsearch/_sync/client/query_rules.py +61 -8
- elasticsearch/_sync/client/rollup.py +23 -9
- elasticsearch/_sync/client/search_application.py +35 -16
- elasticsearch/_sync/client/searchable_snapshots.py +13 -5
- elasticsearch/_sync/client/security.py +371 -180
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +97 -12
- elasticsearch/_sync/client/sql.py +11 -7
- elasticsearch/_sync/client/ssl.py +18 -3
- elasticsearch/_sync/client/synonyms.py +10 -8
- elasticsearch/_sync/client/tasks.py +19 -9
- elasticsearch/_sync/client/text_structure.py +2 -2
- elasticsearch/_sync/client/transform.py +78 -72
- elasticsearch/_sync/client/utils.py +40 -0
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +5 -3
- elasticsearch/_version.py +1 -1
- elasticsearch/exceptions.py +4 -0
- elasticsearch/helpers/actions.py +134 -111
- elasticsearch/helpers/errors.py +12 -4
- elasticsearch/helpers/vectorstore/_async/strategies.py +30 -9
- elasticsearch/helpers/vectorstore/_sync/strategies.py +30 -9
- {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/METADATA +6 -7
- elasticsearch-8.16.0.dist-info/RECORD +117 -0
- {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/WHEEL +1 -1
- elasticsearch-8.15.0.dist-info/RECORD +0 -117
- {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.15.0.dist-info → elasticsearch-8.16.0.dist-info}/licenses/NOTICE +0 -0
|
@@ -20,12 +20,19 @@ import typing as t
|
|
|
20
20
|
from elastic_transport import ObjectApiResponse
|
|
21
21
|
|
|
22
22
|
from ._base import NamespacedClient
|
|
23
|
-
from .utils import
|
|
23
|
+
from .utils import (
|
|
24
|
+
SKIP_IN_PATH,
|
|
25
|
+
Stability,
|
|
26
|
+
_quote,
|
|
27
|
+
_rewrite_parameters,
|
|
28
|
+
_stability_warning,
|
|
29
|
+
)
|
|
24
30
|
|
|
25
31
|
|
|
26
32
|
class ConnectorClient(NamespacedClient):
|
|
27
33
|
|
|
28
34
|
@_rewrite_parameters()
|
|
35
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
29
36
|
async def check_in(
|
|
30
37
|
self,
|
|
31
38
|
*,
|
|
@@ -36,9 +43,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
36
43
|
pretty: t.Optional[bool] = None,
|
|
37
44
|
) -> ObjectApiResponse[t.Any]:
|
|
38
45
|
"""
|
|
39
|
-
|
|
46
|
+
Check in a connector. Update the `last_seen` field in the connector and set it
|
|
47
|
+
to the current timestamp.
|
|
40
48
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
49
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/check-in-connector-api.html>`_
|
|
42
50
|
|
|
43
51
|
:param connector_id: The unique identifier of the connector to be checked in
|
|
44
52
|
"""
|
|
@@ -66,6 +74,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
66
74
|
)
|
|
67
75
|
|
|
68
76
|
@_rewrite_parameters()
|
|
77
|
+
@_stability_warning(Stability.BETA)
|
|
69
78
|
async def delete(
|
|
70
79
|
self,
|
|
71
80
|
*,
|
|
@@ -77,9 +86,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
77
86
|
pretty: t.Optional[bool] = None,
|
|
78
87
|
) -> ObjectApiResponse[t.Any]:
|
|
79
88
|
"""
|
|
80
|
-
|
|
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.
|
|
81
93
|
|
|
82
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
94
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-api.html>`_
|
|
83
95
|
|
|
84
96
|
:param connector_id: The unique identifier of the connector to be deleted
|
|
85
97
|
:param delete_sync_jobs: A flag indicating if associated sync jobs should be
|
|
@@ -111,6 +123,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
111
123
|
)
|
|
112
124
|
|
|
113
125
|
@_rewrite_parameters()
|
|
126
|
+
@_stability_warning(Stability.BETA)
|
|
114
127
|
async def get(
|
|
115
128
|
self,
|
|
116
129
|
*,
|
|
@@ -121,9 +134,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
121
134
|
pretty: t.Optional[bool] = None,
|
|
122
135
|
) -> ObjectApiResponse[t.Any]:
|
|
123
136
|
"""
|
|
124
|
-
|
|
137
|
+
Get a connector. Get the details about a connector.
|
|
125
138
|
|
|
126
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
139
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-api.html>`_
|
|
127
140
|
|
|
128
141
|
:param connector_id: The unique identifier of the connector
|
|
129
142
|
"""
|
|
@@ -166,6 +179,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
166
179
|
"sync_cursor",
|
|
167
180
|
),
|
|
168
181
|
)
|
|
182
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
169
183
|
async def last_sync(
|
|
170
184
|
self,
|
|
171
185
|
*,
|
|
@@ -215,9 +229,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
215
229
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
216
230
|
) -> ObjectApiResponse[t.Any]:
|
|
217
231
|
"""
|
|
218
|
-
|
|
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.
|
|
219
234
|
|
|
220
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
235
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-last-sync-api.html>`_
|
|
221
236
|
|
|
222
237
|
:param connector_id: The unique identifier of the connector to be updated
|
|
223
238
|
:param last_access_control_sync_error:
|
|
@@ -294,6 +309,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
294
309
|
@_rewrite_parameters(
|
|
295
310
|
parameter_aliases={"from": "from_"},
|
|
296
311
|
)
|
|
312
|
+
@_stability_warning(Stability.BETA)
|
|
297
313
|
async def list(
|
|
298
314
|
self,
|
|
299
315
|
*,
|
|
@@ -309,9 +325,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
309
325
|
size: t.Optional[int] = None,
|
|
310
326
|
) -> ObjectApiResponse[t.Any]:
|
|
311
327
|
"""
|
|
312
|
-
|
|
328
|
+
Get all connectors. Get information about all connectors.
|
|
313
329
|
|
|
314
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
330
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-api.html>`_
|
|
315
331
|
|
|
316
332
|
:param connector_name: A comma-separated list of connector names to fetch connector
|
|
317
333
|
documents for
|
|
@@ -367,6 +383,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
367
383
|
"service_type",
|
|
368
384
|
),
|
|
369
385
|
)
|
|
386
|
+
@_stability_warning(Stability.BETA)
|
|
370
387
|
async def post(
|
|
371
388
|
self,
|
|
372
389
|
*,
|
|
@@ -383,9 +400,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
383
400
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
384
401
|
) -> ObjectApiResponse[t.Any]:
|
|
385
402
|
"""
|
|
386
|
-
|
|
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.
|
|
387
408
|
|
|
388
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
409
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html>`_
|
|
389
410
|
|
|
390
411
|
:param description:
|
|
391
412
|
:param index_name:
|
|
@@ -444,6 +465,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
444
465
|
"service_type",
|
|
445
466
|
),
|
|
446
467
|
)
|
|
468
|
+
@_stability_warning(Stability.BETA)
|
|
447
469
|
async def put(
|
|
448
470
|
self,
|
|
449
471
|
*,
|
|
@@ -461,9 +483,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
461
483
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
462
484
|
) -> ObjectApiResponse[t.Any]:
|
|
463
485
|
"""
|
|
464
|
-
|
|
486
|
+
Create or update a connector.
|
|
465
487
|
|
|
466
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
488
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-api.html>`_
|
|
467
489
|
|
|
468
490
|
:param connector_id: The unique identifier of the connector to be created or
|
|
469
491
|
updated. ID is auto-generated if not provided.
|
|
@@ -520,6 +542,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
520
542
|
)
|
|
521
543
|
|
|
522
544
|
@_rewrite_parameters()
|
|
545
|
+
@_stability_warning(Stability.BETA)
|
|
523
546
|
async def sync_job_cancel(
|
|
524
547
|
self,
|
|
525
548
|
*,
|
|
@@ -530,9 +553,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
530
553
|
pretty: t.Optional[bool] = None,
|
|
531
554
|
) -> ObjectApiResponse[t.Any]:
|
|
532
555
|
"""
|
|
533
|
-
|
|
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.
|
|
534
560
|
|
|
535
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
561
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cancel-connector-sync-job-api.html>`_
|
|
536
562
|
|
|
537
563
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
538
564
|
"""
|
|
@@ -564,6 +590,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
564
590
|
)
|
|
565
591
|
|
|
566
592
|
@_rewrite_parameters()
|
|
593
|
+
@_stability_warning(Stability.BETA)
|
|
567
594
|
async def sync_job_delete(
|
|
568
595
|
self,
|
|
569
596
|
*,
|
|
@@ -574,9 +601,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
574
601
|
pretty: t.Optional[bool] = None,
|
|
575
602
|
) -> ObjectApiResponse[t.Any]:
|
|
576
603
|
"""
|
|
577
|
-
|
|
604
|
+
Delete a connector sync job. Remove a connector sync job and its associated data.
|
|
605
|
+
This is a destructive action that is not recoverable.
|
|
578
606
|
|
|
579
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
607
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-connector-sync-job-api.html>`_
|
|
580
608
|
|
|
581
609
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
582
610
|
to be deleted
|
|
@@ -607,6 +635,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
607
635
|
)
|
|
608
636
|
|
|
609
637
|
@_rewrite_parameters()
|
|
638
|
+
@_stability_warning(Stability.BETA)
|
|
610
639
|
async def sync_job_get(
|
|
611
640
|
self,
|
|
612
641
|
*,
|
|
@@ -617,9 +646,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
617
646
|
pretty: t.Optional[bool] = None,
|
|
618
647
|
) -> ObjectApiResponse[t.Any]:
|
|
619
648
|
"""
|
|
620
|
-
|
|
649
|
+
Get a connector sync job.
|
|
621
650
|
|
|
622
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
651
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-connector-sync-job-api.html>`_
|
|
623
652
|
|
|
624
653
|
:param connector_sync_job_id: The unique identifier of the connector sync job
|
|
625
654
|
"""
|
|
@@ -651,6 +680,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
651
680
|
@_rewrite_parameters(
|
|
652
681
|
parameter_aliases={"from": "from_"},
|
|
653
682
|
)
|
|
683
|
+
@_stability_warning(Stability.BETA)
|
|
654
684
|
async def sync_job_list(
|
|
655
685
|
self,
|
|
656
686
|
*,
|
|
@@ -685,9 +715,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
685
715
|
] = None,
|
|
686
716
|
) -> ObjectApiResponse[t.Any]:
|
|
687
717
|
"""
|
|
688
|
-
|
|
718
|
+
Get all connector sync jobs. Get information about all stored connector sync
|
|
719
|
+
jobs listed by their creation date in ascending order.
|
|
689
720
|
|
|
690
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
721
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-connector-sync-jobs-api.html>`_
|
|
691
722
|
|
|
692
723
|
:param connector_id: A connector id to fetch connector sync jobs for
|
|
693
724
|
:param from_: Starting offset (default: 0)
|
|
@@ -729,6 +760,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
729
760
|
@_rewrite_parameters(
|
|
730
761
|
body_fields=("id", "job_type", "trigger_method"),
|
|
731
762
|
)
|
|
763
|
+
@_stability_warning(Stability.BETA)
|
|
732
764
|
async def sync_job_post(
|
|
733
765
|
self,
|
|
734
766
|
*,
|
|
@@ -746,9 +778,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
746
778
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
747
779
|
) -> ObjectApiResponse[t.Any]:
|
|
748
780
|
"""
|
|
749
|
-
|
|
781
|
+
Create a connector sync job. Create a connector sync job document in the internal
|
|
782
|
+
index and initialize its counters and timestamps with default values.
|
|
750
783
|
|
|
751
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
784
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/create-connector-sync-job-api.html>`_
|
|
752
785
|
|
|
753
786
|
:param id: The id of the associated connector
|
|
754
787
|
:param job_type:
|
|
@@ -787,6 +820,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
787
820
|
)
|
|
788
821
|
|
|
789
822
|
@_rewrite_parameters()
|
|
823
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
790
824
|
async def update_active_filtering(
|
|
791
825
|
self,
|
|
792
826
|
*,
|
|
@@ -797,9 +831,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
797
831
|
pretty: t.Optional[bool] = None,
|
|
798
832
|
) -> ObjectApiResponse[t.Any]:
|
|
799
833
|
"""
|
|
800
|
-
Activates the valid draft filtering for
|
|
834
|
+
Activate the connector draft filter. Activates the valid draft filtering for
|
|
835
|
+
a connector.
|
|
801
836
|
|
|
802
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
837
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html>`_
|
|
803
838
|
|
|
804
839
|
:param connector_id: The unique identifier of the connector to be updated
|
|
805
840
|
"""
|
|
@@ -829,6 +864,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
829
864
|
@_rewrite_parameters(
|
|
830
865
|
body_fields=("api_key_id", "api_key_secret_id"),
|
|
831
866
|
)
|
|
867
|
+
@_stability_warning(Stability.BETA)
|
|
832
868
|
async def update_api_key_id(
|
|
833
869
|
self,
|
|
834
870
|
*,
|
|
@@ -842,9 +878,13 @@ class ConnectorClient(NamespacedClient):
|
|
|
842
878
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
843
879
|
) -> ObjectApiResponse[t.Any]:
|
|
844
880
|
"""
|
|
845
|
-
|
|
881
|
+
Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id`
|
|
882
|
+
fields of a connector. You can specify the ID of the API key used for authorization
|
|
883
|
+
and the ID of the connector secret where the API key is stored. The connector
|
|
884
|
+
secret ID is required only for Elastic managed (native) connectors. Self-managed
|
|
885
|
+
connectors (connector clients) do not use this field.
|
|
846
886
|
|
|
847
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
887
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-api-key-id-api.html>`_
|
|
848
888
|
|
|
849
889
|
:param connector_id: The unique identifier of the connector to be updated
|
|
850
890
|
:param api_key_id:
|
|
@@ -883,6 +923,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
883
923
|
@_rewrite_parameters(
|
|
884
924
|
body_fields=("configuration", "values"),
|
|
885
925
|
)
|
|
926
|
+
@_stability_warning(Stability.BETA)
|
|
886
927
|
async def update_configuration(
|
|
887
928
|
self,
|
|
888
929
|
*,
|
|
@@ -896,9 +937,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
896
937
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
897
938
|
) -> ObjectApiResponse[t.Any]:
|
|
898
939
|
"""
|
|
899
|
-
|
|
940
|
+
Update the connector configuration. Update the configuration field in the connector
|
|
941
|
+
document.
|
|
900
942
|
|
|
901
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
943
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-configuration-api.html>`_
|
|
902
944
|
|
|
903
945
|
:param connector_id: The unique identifier of the connector to be updated
|
|
904
946
|
:param configuration:
|
|
@@ -937,6 +979,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
937
979
|
@_rewrite_parameters(
|
|
938
980
|
body_fields=("error",),
|
|
939
981
|
)
|
|
982
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
940
983
|
async def update_error(
|
|
941
984
|
self,
|
|
942
985
|
*,
|
|
@@ -949,9 +992,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
949
992
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
950
993
|
) -> ObjectApiResponse[t.Any]:
|
|
951
994
|
"""
|
|
952
|
-
|
|
995
|
+
Update the connector error field. Set the error field for the connector. If the
|
|
996
|
+
error provided in the request body is non-null, the connector’s status is updated
|
|
997
|
+
to error. Otherwise, if the error is reset to null, the connector status is updated
|
|
998
|
+
to connected.
|
|
953
999
|
|
|
954
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1000
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-error-api.html>`_
|
|
955
1001
|
|
|
956
1002
|
:param connector_id: The unique identifier of the connector to be updated
|
|
957
1003
|
:param error:
|
|
@@ -989,6 +1035,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
989
1035
|
@_rewrite_parameters(
|
|
990
1036
|
body_fields=("advanced_snippet", "filtering", "rules"),
|
|
991
1037
|
)
|
|
1038
|
+
@_stability_warning(Stability.BETA)
|
|
992
1039
|
async def update_filtering(
|
|
993
1040
|
self,
|
|
994
1041
|
*,
|
|
@@ -1003,9 +1050,12 @@ class ConnectorClient(NamespacedClient):
|
|
|
1003
1050
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1004
1051
|
) -> ObjectApiResponse[t.Any]:
|
|
1005
1052
|
"""
|
|
1006
|
-
|
|
1053
|
+
Update the connector filtering. Update the draft filtering configuration of a
|
|
1054
|
+
connector and marks the draft validation state as edited. The filtering draft
|
|
1055
|
+
is activated once validated by the running Elastic connector service. The filtering
|
|
1056
|
+
property is used to configure sync rules (both basic and advanced) for a connector.
|
|
1007
1057
|
|
|
1008
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1058
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-api.html>`_
|
|
1009
1059
|
|
|
1010
1060
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1011
1061
|
:param advanced_snippet:
|
|
@@ -1047,6 +1097,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1047
1097
|
@_rewrite_parameters(
|
|
1048
1098
|
body_fields=("validation",),
|
|
1049
1099
|
)
|
|
1100
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
1050
1101
|
async def update_filtering_validation(
|
|
1051
1102
|
self,
|
|
1052
1103
|
*,
|
|
@@ -1059,9 +1110,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
1059
1110
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1060
1111
|
) -> ObjectApiResponse[t.Any]:
|
|
1061
1112
|
"""
|
|
1062
|
-
|
|
1113
|
+
Update the connector draft filtering validation. Update the draft filtering validation
|
|
1114
|
+
info for a connector.
|
|
1063
1115
|
|
|
1064
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1116
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-filtering-validation-api.html>`_
|
|
1065
1117
|
|
|
1066
1118
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1067
1119
|
:param validation:
|
|
@@ -1099,6 +1151,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1099
1151
|
@_rewrite_parameters(
|
|
1100
1152
|
body_fields=("index_name",),
|
|
1101
1153
|
)
|
|
1154
|
+
@_stability_warning(Stability.BETA)
|
|
1102
1155
|
async def update_index_name(
|
|
1103
1156
|
self,
|
|
1104
1157
|
*,
|
|
@@ -1111,9 +1164,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
1111
1164
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1112
1165
|
) -> ObjectApiResponse[t.Any]:
|
|
1113
1166
|
"""
|
|
1114
|
-
|
|
1167
|
+
Update the connector index name. Update the `index_name` field of a connector,
|
|
1168
|
+
specifying the index where the data ingested by the connector is stored.
|
|
1115
1169
|
|
|
1116
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1170
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-index-name-api.html>`_
|
|
1117
1171
|
|
|
1118
1172
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1119
1173
|
:param index_name:
|
|
@@ -1151,6 +1205,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1151
1205
|
@_rewrite_parameters(
|
|
1152
1206
|
body_fields=("description", "name"),
|
|
1153
1207
|
)
|
|
1208
|
+
@_stability_warning(Stability.BETA)
|
|
1154
1209
|
async def update_name(
|
|
1155
1210
|
self,
|
|
1156
1211
|
*,
|
|
@@ -1164,9 +1219,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
1164
1219
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1165
1220
|
) -> ObjectApiResponse[t.Any]:
|
|
1166
1221
|
"""
|
|
1167
|
-
|
|
1222
|
+
Update the connector name and description.
|
|
1168
1223
|
|
|
1169
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1224
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-name-description-api.html>`_
|
|
1170
1225
|
|
|
1171
1226
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1172
1227
|
:param description:
|
|
@@ -1205,6 +1260,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1205
1260
|
@_rewrite_parameters(
|
|
1206
1261
|
body_fields=("is_native",),
|
|
1207
1262
|
)
|
|
1263
|
+
@_stability_warning(Stability.BETA)
|
|
1208
1264
|
async def update_native(
|
|
1209
1265
|
self,
|
|
1210
1266
|
*,
|
|
@@ -1217,9 +1273,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
1217
1273
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1218
1274
|
) -> ObjectApiResponse[t.Any]:
|
|
1219
1275
|
"""
|
|
1220
|
-
|
|
1276
|
+
Update the connector is_native flag.
|
|
1221
1277
|
|
|
1222
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1278
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-native-api.html>`_
|
|
1223
1279
|
|
|
1224
1280
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1225
1281
|
:param is_native:
|
|
@@ -1257,6 +1313,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1257
1313
|
@_rewrite_parameters(
|
|
1258
1314
|
body_fields=("pipeline",),
|
|
1259
1315
|
)
|
|
1316
|
+
@_stability_warning(Stability.BETA)
|
|
1260
1317
|
async def update_pipeline(
|
|
1261
1318
|
self,
|
|
1262
1319
|
*,
|
|
@@ -1269,9 +1326,10 @@ class ConnectorClient(NamespacedClient):
|
|
|
1269
1326
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1270
1327
|
) -> ObjectApiResponse[t.Any]:
|
|
1271
1328
|
"""
|
|
1272
|
-
|
|
1329
|
+
Update the connector pipeline. When you create a new connector, the configuration
|
|
1330
|
+
of an ingest pipeline is populated with default settings.
|
|
1273
1331
|
|
|
1274
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1332
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-pipeline-api.html>`_
|
|
1275
1333
|
|
|
1276
1334
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1277
1335
|
:param pipeline:
|
|
@@ -1309,6 +1367,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1309
1367
|
@_rewrite_parameters(
|
|
1310
1368
|
body_fields=("scheduling",),
|
|
1311
1369
|
)
|
|
1370
|
+
@_stability_warning(Stability.BETA)
|
|
1312
1371
|
async def update_scheduling(
|
|
1313
1372
|
self,
|
|
1314
1373
|
*,
|
|
@@ -1321,9 +1380,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
1321
1380
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1322
1381
|
) -> ObjectApiResponse[t.Any]:
|
|
1323
1382
|
"""
|
|
1324
|
-
|
|
1383
|
+
Update the connector scheduling.
|
|
1325
1384
|
|
|
1326
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1385
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-scheduling-api.html>`_
|
|
1327
1386
|
|
|
1328
1387
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1329
1388
|
:param scheduling:
|
|
@@ -1361,6 +1420,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1361
1420
|
@_rewrite_parameters(
|
|
1362
1421
|
body_fields=("service_type",),
|
|
1363
1422
|
)
|
|
1423
|
+
@_stability_warning(Stability.BETA)
|
|
1364
1424
|
async def update_service_type(
|
|
1365
1425
|
self,
|
|
1366
1426
|
*,
|
|
@@ -1373,9 +1433,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
1373
1433
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1374
1434
|
) -> ObjectApiResponse[t.Any]:
|
|
1375
1435
|
"""
|
|
1376
|
-
|
|
1436
|
+
Update the connector service type.
|
|
1377
1437
|
|
|
1378
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1438
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-service-type-api.html>`_
|
|
1379
1439
|
|
|
1380
1440
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1381
1441
|
:param service_type:
|
|
@@ -1413,6 +1473,7 @@ class ConnectorClient(NamespacedClient):
|
|
|
1413
1473
|
@_rewrite_parameters(
|
|
1414
1474
|
body_fields=("status",),
|
|
1415
1475
|
)
|
|
1476
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
1416
1477
|
async def update_status(
|
|
1417
1478
|
self,
|
|
1418
1479
|
*,
|
|
@@ -1432,9 +1493,9 @@ class ConnectorClient(NamespacedClient):
|
|
|
1432
1493
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1433
1494
|
) -> ObjectApiResponse[t.Any]:
|
|
1434
1495
|
"""
|
|
1435
|
-
|
|
1496
|
+
Update the connector status.
|
|
1436
1497
|
|
|
1437
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1498
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-connector-status-api.html>`_
|
|
1438
1499
|
|
|
1439
1500
|
:param connector_id: The unique identifier of the connector to be updated
|
|
1440
1501
|
:param status:
|
|
@@ -39,13 +39,17 @@ 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
|
-
|
|
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.
|
|
43
46
|
|
|
44
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
47
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-gateway-dangling-indices.html>`_
|
|
45
48
|
|
|
46
|
-
:param index_uuid: The UUID of the dangling
|
|
47
|
-
|
|
48
|
-
|
|
49
|
+
:param index_uuid: The UUID of the index to delete. Use the get dangling indices
|
|
50
|
+
API to find the UUID.
|
|
51
|
+
:param accept_data_loss: This parameter must be set to true to acknowledge that
|
|
52
|
+
it will no longer be possible to recove data from the dangling index.
|
|
49
53
|
:param master_timeout: Specify timeout for connection to master
|
|
50
54
|
:param timeout: Explicit operation timeout
|
|
51
55
|
"""
|
|
@@ -94,13 +98,20 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
94
98
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
95
99
|
) -> ObjectApiResponse[t.Any]:
|
|
96
100
|
"""
|
|
97
|
-
|
|
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.
|
|
98
105
|
|
|
99
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
106
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-gateway-dangling-indices.html>`_
|
|
100
107
|
|
|
101
|
-
:param index_uuid: The UUID of the dangling
|
|
102
|
-
|
|
103
|
-
|
|
108
|
+
:param index_uuid: The UUID of the index to import. Use the get dangling indices
|
|
109
|
+
API to locate the UUID.
|
|
110
|
+
:param accept_data_loss: This parameter must be set to true to import a dangling
|
|
111
|
+
index. Because Elasticsearch cannot know where the dangling index data came
|
|
112
|
+
from or determine which shard copies are fresh and which are stale, it cannot
|
|
113
|
+
guarantee that the imported data represents the latest state of the index
|
|
114
|
+
when it was last in the cluster.
|
|
104
115
|
:param master_timeout: Specify timeout for connection to master
|
|
105
116
|
:param timeout: Explicit operation timeout
|
|
106
117
|
"""
|
|
@@ -145,9 +156,13 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
145
156
|
pretty: t.Optional[bool] = None,
|
|
146
157
|
) -> ObjectApiResponse[t.Any]:
|
|
147
158
|
"""
|
|
148
|
-
|
|
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.
|
|
149
164
|
|
|
150
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
165
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-gateway-dangling-indices.html>`_
|
|
151
166
|
"""
|
|
152
167
|
__path_parts: t.Dict[str, str] = {}
|
|
153
168
|
__path = "/_dangling"
|
|
@@ -36,9 +36,9 @@ class EnrichClient(NamespacedClient):
|
|
|
36
36
|
pretty: t.Optional[bool] = None,
|
|
37
37
|
) -> ObjectApiResponse[t.Any]:
|
|
38
38
|
"""
|
|
39
|
-
Deletes an existing enrich policy and its enrich index.
|
|
39
|
+
Delete an enrich policy. Deletes an existing enrich policy and its enrich index.
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-enrich-policy-api.html>`_
|
|
42
42
|
|
|
43
43
|
:param name: Enrich policy to delete.
|
|
44
44
|
"""
|
|
@@ -79,7 +79,7 @@ class EnrichClient(NamespacedClient):
|
|
|
79
79
|
"""
|
|
80
80
|
Creates the enrich index for an existing enrich policy.
|
|
81
81
|
|
|
82
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
82
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html>`_
|
|
83
83
|
|
|
84
84
|
:param name: Enrich policy to execute.
|
|
85
85
|
:param wait_for_completion: If `true`, the request blocks other enrich policy
|
|
@@ -121,9 +121,9 @@ class EnrichClient(NamespacedClient):
|
|
|
121
121
|
pretty: t.Optional[bool] = None,
|
|
122
122
|
) -> ObjectApiResponse[t.Any]:
|
|
123
123
|
"""
|
|
124
|
-
Returns information about an enrich policy.
|
|
124
|
+
Get an enrich policy. Returns information about an enrich policy.
|
|
125
125
|
|
|
126
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
126
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-enrich-policy-api.html>`_
|
|
127
127
|
|
|
128
128
|
:param name: Comma-separated list of enrich policy names used to limit the request.
|
|
129
129
|
To return information for all enrich policies, omit this parameter.
|
|
@@ -171,9 +171,9 @@ class EnrichClient(NamespacedClient):
|
|
|
171
171
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
172
172
|
) -> ObjectApiResponse[t.Any]:
|
|
173
173
|
"""
|
|
174
|
-
Creates an enrich policy.
|
|
174
|
+
Create an enrich policy. Creates an enrich policy.
|
|
175
175
|
|
|
176
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
176
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-enrich-policy-api.html>`_
|
|
177
177
|
|
|
178
178
|
:param name: Name of the enrich policy to create or update.
|
|
179
179
|
:param geo_match: Matches enrich data to incoming documents based on a `geo_shape`
|
|
@@ -224,10 +224,10 @@ class EnrichClient(NamespacedClient):
|
|
|
224
224
|
pretty: t.Optional[bool] = None,
|
|
225
225
|
) -> ObjectApiResponse[t.Any]:
|
|
226
226
|
"""
|
|
227
|
-
Returns enrich coordinator statistics and information about
|
|
228
|
-
are currently executing.
|
|
227
|
+
Get enrich stats. Returns enrich coordinator statistics and information about
|
|
228
|
+
enrich policies that are currently executing.
|
|
229
229
|
|
|
230
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
230
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/enrich-stats-api.html>`_
|
|
231
231
|
"""
|
|
232
232
|
__path_parts: t.Dict[str, str] = {}
|
|
233
233
|
__path = "/_enrich/_stats"
|