forked from elastic/elasticsearch-py
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconnector.py
1531 lines (1451 loc) · 59.9 KB
/
connector.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import typing as t
from elastic_transport import ObjectApiResponse
from ._base import NamespacedClient
from .utils import (
SKIP_IN_PATH,
Stability,
_quote,
_rewrite_parameters,
_stability_warning,
)
class ConnectorClient(NamespacedClient):
@_rewrite_parameters()
@_stability_warning(Stability.EXPERIMENTAL)
async def check_in(
self,
*,
connector_id: str,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Check in a connector. Update the `last_seen` field in the connector and set it
to the current timestamp.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-api.html>`_
:param connector_id: The unique identifier of the connector to be checked in
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_check_in'
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.check_in",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.BETA)
async def delete(
self,
*,
connector_id: str,
delete_sync_jobs: t.Optional[bool] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Delete a connector. Removes a connector and associated sync jobs. This is a destructive
action that is not recoverable. NOTE: This action doesn’t delete any API keys,
ingest pipelines, or data indices associated with the connector. These need to
be removed manually.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-api.html>`_
:param connector_id: The unique identifier of the connector to be deleted
:param delete_sync_jobs: A flag indicating if associated sync jobs should be
also removed. Defaults to false.
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}'
__query: t.Dict[str, t.Any] = {}
if delete_sync_jobs is not None:
__query["delete_sync_jobs"] = delete_sync_jobs
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"DELETE",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.delete",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.BETA)
async def get(
self,
*,
connector_id: str,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Get a connector. Get the details about a connector.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-api.html>`_
:param connector_id: The unique identifier of the connector
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}'
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"GET",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.get",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=(
"last_access_control_sync_error",
"last_access_control_sync_scheduled_at",
"last_access_control_sync_status",
"last_deleted_document_count",
"last_incremental_sync_scheduled_at",
"last_indexed_document_count",
"last_seen",
"last_sync_error",
"last_sync_scheduled_at",
"last_sync_status",
"last_synced",
"sync_cursor",
),
)
@_stability_warning(Stability.EXPERIMENTAL)
async def last_sync(
self,
*,
connector_id: str,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
last_access_control_sync_error: t.Optional[str] = None,
last_access_control_sync_scheduled_at: t.Optional[t.Union[str, t.Any]] = None,
last_access_control_sync_status: t.Optional[
t.Union[
str,
t.Literal[
"canceled",
"canceling",
"completed",
"error",
"in_progress",
"pending",
"suspended",
],
]
] = None,
last_deleted_document_count: t.Optional[int] = None,
last_incremental_sync_scheduled_at: t.Optional[t.Union[str, t.Any]] = None,
last_indexed_document_count: t.Optional[int] = None,
last_seen: t.Optional[t.Union[str, t.Any]] = None,
last_sync_error: t.Optional[str] = None,
last_sync_scheduled_at: t.Optional[t.Union[str, t.Any]] = None,
last_sync_status: t.Optional[
t.Union[
str,
t.Literal[
"canceled",
"canceling",
"completed",
"error",
"in_progress",
"pending",
"suspended",
],
]
] = None,
last_synced: t.Optional[t.Union[str, t.Any]] = None,
pretty: t.Optional[bool] = None,
sync_cursor: t.Optional[t.Any] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Update the connector last sync stats. Update the fields related to the last sync
of a connector. This action is used for analytics and monitoring.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-last-sync-api.html>`_
:param connector_id: The unique identifier of the connector to be updated
:param last_access_control_sync_error:
:param last_access_control_sync_scheduled_at:
:param last_access_control_sync_status:
:param last_deleted_document_count:
:param last_incremental_sync_scheduled_at:
:param last_indexed_document_count:
:param last_seen:
:param last_sync_error:
:param last_sync_scheduled_at:
:param last_sync_status:
:param last_synced:
:param sync_cursor:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_last_sync'
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if last_access_control_sync_error is not None:
__body["last_access_control_sync_error"] = (
last_access_control_sync_error
)
if last_access_control_sync_scheduled_at is not None:
__body["last_access_control_sync_scheduled_at"] = (
last_access_control_sync_scheduled_at
)
if last_access_control_sync_status is not None:
__body["last_access_control_sync_status"] = (
last_access_control_sync_status
)
if last_deleted_document_count is not None:
__body["last_deleted_document_count"] = last_deleted_document_count
if last_incremental_sync_scheduled_at is not None:
__body["last_incremental_sync_scheduled_at"] = (
last_incremental_sync_scheduled_at
)
if last_indexed_document_count is not None:
__body["last_indexed_document_count"] = last_indexed_document_count
if last_seen is not None:
__body["last_seen"] = last_seen
if last_sync_error is not None:
__body["last_sync_error"] = last_sync_error
if last_sync_scheduled_at is not None:
__body["last_sync_scheduled_at"] = last_sync_scheduled_at
if last_sync_status is not None:
__body["last_sync_status"] = last_sync_status
if last_synced is not None:
__body["last_synced"] = last_synced
if sync_cursor is not None:
__body["sync_cursor"] = sync_cursor
__headers = {"accept": "application/json", "content-type": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.last_sync",
path_parts=__path_parts,
)
@_rewrite_parameters(
parameter_aliases={"from": "from_"},
)
@_stability_warning(Stability.BETA)
async def list(
self,
*,
connector_name: t.Optional[t.Union[str, t.Sequence[str]]] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
from_: t.Optional[int] = None,
human: t.Optional[bool] = None,
index_name: t.Optional[t.Union[str, t.Sequence[str]]] = None,
pretty: t.Optional[bool] = None,
query: t.Optional[str] = None,
service_type: t.Optional[t.Union[str, t.Sequence[str]]] = None,
size: t.Optional[int] = None,
) -> ObjectApiResponse[t.Any]:
"""
Get all connectors. Get information about all connectors.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-api.html>`_
:param connector_name: A comma-separated list of connector names to fetch connector
documents for
:param from_: Starting offset (default: 0)
:param index_name: A comma-separated list of connector index names to fetch connector
documents for
:param query: A wildcard query string that filters connectors with matching name,
description or index name
:param service_type: A comma-separated list of connector service types to fetch
connector documents for
:param size: Specifies a max number of results to get
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_connector"
__query: t.Dict[str, t.Any] = {}
if connector_name is not None:
__query["connector_name"] = connector_name
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if from_ is not None:
__query["from"] = from_
if human is not None:
__query["human"] = human
if index_name is not None:
__query["index_name"] = index_name
if pretty is not None:
__query["pretty"] = pretty
if query is not None:
__query["query"] = query
if service_type is not None:
__query["service_type"] = service_type
if size is not None:
__query["size"] = size
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"GET",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.list",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=(
"description",
"index_name",
"is_native",
"language",
"name",
"service_type",
),
)
@_stability_warning(Stability.BETA)
async def post(
self,
*,
description: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
index_name: t.Optional[str] = None,
is_native: t.Optional[bool] = None,
language: t.Optional[str] = None,
name: t.Optional[str] = None,
pretty: t.Optional[bool] = None,
service_type: t.Optional[str] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Create a connector. 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. Elastic managed connectors (Native connectors) are
a managed service on Elastic Cloud. Self-managed connectors (Connector clients)
are self-managed on your infrastructure.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html>`_
:param description:
:param index_name:
:param is_native:
:param language:
:param name:
:param service_type:
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_connector"
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if description is not None:
__body["description"] = description
if index_name is not None:
__body["index_name"] = index_name
if is_native is not None:
__body["is_native"] = is_native
if language is not None:
__body["language"] = language
if name is not None:
__body["name"] = name
if service_type is not None:
__body["service_type"] = service_type
if not __body:
__body = None # type: ignore[assignment]
__headers = {"accept": "application/json"}
if __body is not None:
__headers["content-type"] = "application/json"
return await self.perform_request( # type: ignore[return-value]
"POST",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.post",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=(
"description",
"index_name",
"is_native",
"language",
"name",
"service_type",
),
)
@_stability_warning(Stability.BETA)
async def put(
self,
*,
connector_id: t.Optional[str] = None,
description: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
index_name: t.Optional[str] = None,
is_native: t.Optional[bool] = None,
language: t.Optional[str] = None,
name: t.Optional[str] = None,
pretty: t.Optional[bool] = None,
service_type: t.Optional[str] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Create or update a connector.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-api.html>`_
:param connector_id: The unique identifier of the connector to be created or
updated. ID is auto-generated if not provided.
:param description:
:param index_name:
:param is_native:
:param language:
:param name:
:param service_type:
"""
__path_parts: t.Dict[str, str]
if connector_id not in SKIP_IN_PATH:
__path_parts = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}'
else:
__path_parts = {}
__path = "/_connector"
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if description is not None:
__body["description"] = description
if index_name is not None:
__body["index_name"] = index_name
if is_native is not None:
__body["is_native"] = is_native
if language is not None:
__body["language"] = language
if name is not None:
__body["name"] = name
if service_type is not None:
__body["service_type"] = service_type
if not __body:
__body = None # type: ignore[assignment]
__headers = {"accept": "application/json"}
if __body is not None:
__headers["content-type"] = "application/json"
return await self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.put",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.BETA)
async def sync_job_cancel(
self,
*,
connector_sync_job_id: str,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Cancel a connector sync job. Cancel a connector sync job, which sets the status
to cancelling and updates `cancellation_requested_at` to the current time. The
connector service is then responsible for setting the status of connector sync
jobs to cancelled.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cancel-connector-sync-job-api.html>`_
:param connector_sync_job_id: The unique identifier of the connector sync job
"""
if connector_sync_job_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
__path_parts: t.Dict[str, str] = {
"connector_sync_job_id": _quote(connector_sync_job_id)
}
__path = (
f'/_connector/_sync_job/{__path_parts["connector_sync_job_id"]}/_cancel'
)
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.sync_job_cancel",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.BETA)
async def sync_job_delete(
self,
*,
connector_sync_job_id: str,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Delete a connector sync job. Remove a connector sync job and its associated data.
This is a destructive action that is not recoverable.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-sync-job-api.html>`_
:param connector_sync_job_id: The unique identifier of the connector sync job
to be deleted
"""
if connector_sync_job_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
__path_parts: t.Dict[str, str] = {
"connector_sync_job_id": _quote(connector_sync_job_id)
}
__path = f'/_connector/_sync_job/{__path_parts["connector_sync_job_id"]}'
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"DELETE",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.sync_job_delete",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.BETA)
async def sync_job_get(
self,
*,
connector_sync_job_id: str,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Get a connector sync job.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-sync-job-api.html>`_
:param connector_sync_job_id: The unique identifier of the connector sync job
"""
if connector_sync_job_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
__path_parts: t.Dict[str, str] = {
"connector_sync_job_id": _quote(connector_sync_job_id)
}
__path = f'/_connector/_sync_job/{__path_parts["connector_sync_job_id"]}'
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"GET",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.sync_job_get",
path_parts=__path_parts,
)
@_rewrite_parameters(
parameter_aliases={"from": "from_"},
)
@_stability_warning(Stability.BETA)
async def sync_job_list(
self,
*,
connector_id: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
from_: t.Optional[int] = None,
human: t.Optional[bool] = None,
job_type: t.Optional[
t.Union[
t.Sequence[
t.Union[str, t.Literal["access_control", "full", "incremental"]]
],
t.Union[str, t.Literal["access_control", "full", "incremental"]],
]
] = None,
pretty: t.Optional[bool] = None,
size: t.Optional[int] = None,
status: t.Optional[
t.Union[
str,
t.Literal[
"canceled",
"canceling",
"completed",
"error",
"in_progress",
"pending",
"suspended",
],
]
] = None,
) -> ObjectApiResponse[t.Any]:
"""
Get all connector sync jobs. Get information about all stored connector sync
jobs listed by their creation date in ascending order.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-sync-jobs-api.html>`_
:param connector_id: A connector id to fetch connector sync jobs for
:param from_: Starting offset (default: 0)
:param job_type: A comma-separated list of job types to fetch the sync jobs for
:param size: Specifies a max number of results to get
:param status: A sync job status to fetch connector sync jobs for
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_connector/_sync_job"
__query: t.Dict[str, t.Any] = {}
if connector_id is not None:
__query["connector_id"] = connector_id
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if from_ is not None:
__query["from"] = from_
if human is not None:
__query["human"] = human
if job_type is not None:
__query["job_type"] = job_type
if pretty is not None:
__query["pretty"] = pretty
if size is not None:
__query["size"] = size
if status is not None:
__query["status"] = status
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"GET",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.sync_job_list",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("id", "job_type", "trigger_method"),
)
@_stability_warning(Stability.BETA)
async def sync_job_post(
self,
*,
id: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
job_type: t.Optional[
t.Union[str, t.Literal["access_control", "full", "incremental"]]
] = None,
pretty: t.Optional[bool] = None,
trigger_method: t.Optional[
t.Union[str, t.Literal["on_demand", "scheduled"]]
] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Create a connector sync job. Create a connector sync job document in the internal
index and initialize its counters and timestamps with default values.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-sync-job-api.html>`_
:param id: The id of the associated connector
:param job_type:
:param trigger_method:
"""
if id is None and body is None:
raise ValueError("Empty value passed for parameter 'id'")
__path_parts: t.Dict[str, str] = {}
__path = "/_connector/_sync_job"
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if id is not None:
__body["id"] = id
if job_type is not None:
__body["job_type"] = job_type
if trigger_method is not None:
__body["trigger_method"] = trigger_method
__headers = {"accept": "application/json", "content-type": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"POST",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.sync_job_post",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.EXPERIMENTAL)
async def update_active_filtering(
self,
*,
connector_id: str,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Activate the connector draft filter. Activates the valid draft filtering for
a connector.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-filtering-api.html>`_
:param connector_id: The unique identifier of the connector to be updated
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_filtering/_activate'
__query: t.Dict[str, t.Any] = {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.update_active_filtering",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("api_key_id", "api_key_secret_id"),
)
@_stability_warning(Stability.BETA)
async def update_api_key_id(
self,
*,
connector_id: str,
api_key_id: t.Optional[str] = None,
api_key_secret_id: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id`
fields of a connector. 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. The connector
secret ID is required only for Elastic managed (native) connectors. Self-managed
connectors (connector clients) do not use this field.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-api-key-id-api.html>`_
:param connector_id: The unique identifier of the connector to be updated
:param api_key_id:
:param api_key_secret_id:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_api_key_id'
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if api_key_id is not None:
__body["api_key_id"] = api_key_id
if api_key_secret_id is not None:
__body["api_key_secret_id"] = api_key_secret_id
__headers = {"accept": "application/json", "content-type": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_api_key_id",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("configuration", "values"),
)
@_stability_warning(Stability.BETA)
async def update_configuration(
self,
*,
connector_id: str,
configuration: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
values: t.Optional[t.Mapping[str, t.Any]] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Update the connector configuration. Update the configuration field in the connector
document.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-configuration-api.html>`_
:param connector_id: The unique identifier of the connector to be updated
:param configuration:
:param values:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_configuration'
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if configuration is not None:
__body["configuration"] = configuration
if values is not None:
__body["values"] = values
__headers = {"accept": "application/json", "content-type": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_configuration",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("error",),
)
@_stability_warning(Stability.EXPERIMENTAL)
async def update_error(
self,
*,
connector_id: str,
error: t.Optional[t.Union[None, t.Any]] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Update the connector error field. Set the error field for the connector. If the
error provided in the request body is non-null, the connector’s status is updated
to error. Otherwise, if the error is reset to null, the connector status is updated
to connected.
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-error-api.html>`_