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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
|
# 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)
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]:
"""
.. raw:: html
<p>Check in a connector.</p>
<p>Update the <code>last_seen</code> field in the connector and set it to the current timestamp.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in>`_
: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 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)
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,
hard: t.Optional[bool] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Delete a connector.</p>
<p>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.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete>`_
: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.
:param hard: A flag indicating if the connector should be hard deleted.
"""
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 hard is not None:
__query["hard"] = hard
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return 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)
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,
include_deleted: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Get a connector.</p>
<p>Get the details about a connector.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get>`_
:param connector_id: The unique identifier of the connector
:param include_deleted: A flag to indicate if the desired connector should be
fetched, even if it was soft-deleted.
"""
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 include_deleted is not None:
__query["include_deleted"] = include_deleted
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
return 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)
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]:
"""
.. raw:: html
<p>Update the connector last sync stats.</p>
<p>Update the fields related to the last sync of a connector.
This action is used for analytics and monitoring.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-last-sync>`_
: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 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)
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,
include_deleted: 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]:
"""
.. raw:: html
<p>Get all connectors.</p>
<p>Get information about all connectors.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list>`_
:param connector_name: A comma-separated list of connector names to fetch connector
documents for
:param from_: Starting offset (default: 0)
:param include_deleted: A flag to indicate if the desired connector should be
fetched, even if it was soft-deleted.
: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 include_deleted is not None:
__query["include_deleted"] = include_deleted
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 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)
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]:
"""
.. raw:: html
<p>Create a connector.</p>
<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.
Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud.
Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put>`_
: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 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)
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]:
"""
.. raw:: html
<p>Create or update a connector.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put>`_
: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 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)
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]:
"""
.. raw:: html
<p>Cancel a connector sync job.</p>
<p>Cancel a connector sync job, which sets the status to cancelling and updates <code>cancellation_requested_at</code> to the current time.
The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel>`_
: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 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.EXPERIMENTAL)
def sync_job_check_in(
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]:
"""
.. raw:: html
<p>Check in a connector sync job.
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>
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in>`_
:param connector_sync_job_id: The unique identifier of the connector sync job
to be checked in.
"""
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"]}/_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 self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
endpoint_id="connector.sync_job_check_in",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("worker_hostname", "sync_cursor"),
)
@_stability_warning(Stability.EXPERIMENTAL)
def sync_job_claim(
self,
*,
connector_sync_job_id: str,
worker_hostname: 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,
sync_cursor: t.Optional[t.Any] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Claim a connector sync job.
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.
Additionally, it can set the <code>sync_cursor</code> property for the sync job.</p>
<p>This API is not intended for direct connector management by users.
It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.</p>
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim>`_
:param connector_sync_job_id: The unique identifier of the connector sync job.
:param worker_hostname: The host name of the current system that will run the
job.
:param sync_cursor: The cursor object from the last incremental sync job. This
should reference the `sync_cursor` field in the connector state for which
the job runs.
"""
if connector_sync_job_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
if worker_hostname is None and body is None:
raise ValueError("Empty value passed for parameter 'worker_hostname'")
__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"]}/_claim'
__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 worker_hostname is not None:
__body["worker_hostname"] = worker_hostname
if sync_cursor is not None:
__body["sync_cursor"] = sync_cursor
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.sync_job_claim",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.BETA)
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]:
"""
.. raw:: html
<p>Delete a connector sync job.</p>
<p>Remove a connector sync job and its associated data.
This is a destructive action that is not recoverable.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete>`_
: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 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(
body_fields=("error",),
)
@_stability_warning(Stability.EXPERIMENTAL)
def sync_job_error(
self,
*,
connector_sync_job_id: str,
error: 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]:
"""
.. raw:: html
<p>Set a connector sync job error.
Set the <code>error</code> field for a connector sync job and set its <code>status</code> to <code>error</code>.</p>
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error>`_
:param connector_sync_job_id: The unique identifier for the connector sync job.
:param error: The error for the connector sync job error field.
"""
if connector_sync_job_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
if error is None and body is None:
raise ValueError("Empty value passed for parameter 'error'")
__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"]}/_error'
__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 error is not None:
__body["error"] = error
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.sync_job_error",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.BETA)
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]:
"""
.. raw:: html
<p>Get a connector sync job.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get>`_
: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 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)
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]:
"""
.. raw:: html
<p>Get all connector sync jobs.</p>
<p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list>`_
: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 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)
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]:
"""
.. raw:: html
<p>Create a connector sync job.</p>
<p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post>`_
: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 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(
body_fields=(
"deleted_document_count",
"indexed_document_count",
"indexed_document_volume",
"last_seen",
"metadata",
"total_document_count",
),
)
@_stability_warning(Stability.EXPERIMENTAL)
def sync_job_update_stats(
self,
*,
connector_sync_job_id: str,
deleted_document_count: t.Optional[int] = None,
indexed_document_count: t.Optional[int] = None,
indexed_document_volume: t.Optional[int] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
last_seen: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
metadata: t.Optional[t.Mapping[str, t.Any]] = None,
pretty: t.Optional[bool] = None,
total_document_count: t.Optional[int] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Set the connector sync job stats.
Stats include: <code>deleted_document_count</code>, <code>indexed_document_count</code>, <code>indexed_document_volume</code>, and <code>total_document_count</code>.
You can also update <code>last_seen</code>.
This API is mainly used by the connector service for updating sync job information.</p>
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats>`_
:param connector_sync_job_id: The unique identifier of the connector sync job.
:param deleted_document_count: The number of documents the sync job deleted.
:param indexed_document_count: The number of documents the sync job indexed.
:param indexed_document_volume: The total size of the data (in MiB) the sync
job indexed.
:param last_seen: The timestamp to use in the `last_seen` property for the connector
sync job.
:param metadata: The connector-specific metadata.
:param total_document_count: The total number of documents in the target index
after the sync job finished.
"""
if connector_sync_job_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
if deleted_document_count is None and body is None:
raise ValueError(
"Empty value passed for parameter 'deleted_document_count'"
)
if indexed_document_count is None and body is None:
raise ValueError(
"Empty value passed for parameter 'indexed_document_count'"
)
if indexed_document_volume is None and body is None:
raise ValueError(
"Empty value passed for parameter 'indexed_document_volume'"
)
__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"]}/_stats'
__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 deleted_document_count is not None:
__body["deleted_document_count"] = deleted_document_count
if indexed_document_count is not None:
__body["indexed_document_count"] = indexed_document_count
if indexed_document_volume is not None:
__body["indexed_document_volume"] = indexed_document_volume
if last_seen is not None:
__body["last_seen"] = last_seen
if metadata is not None:
__body["metadata"] = metadata
if total_document_count is not None:
__body["total_document_count"] = total_document_count
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.sync_job_update_stats",
path_parts=__path_parts,
)
@_rewrite_parameters()
@_stability_warning(Stability.EXPERIMENTAL)
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]:
"""
.. raw:: html
<p>Activate the connector draft filter.</p>
<p>Activates the valid draft filtering for a connector.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering>`_
: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 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)
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]:
"""
.. raw:: html
<p>Update the connector API key ID.</p>
<p>Update the <code>api_key_id</code> and <code>api_key_secret_id</code> 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.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id>`_
: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 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)
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]:
"""
.. raw:: html
<p>Update the connector configuration.</p>
<p>Update the configuration field in the connector document.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration>`_
: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 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)
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]:
"""
.. raw:: html
<p>Update the connector error field.</p>
<p>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.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error>`_
:param connector_id: The unique identifier of the connector to be updated
:param error:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if error is None and body is None:
raise ValueError("Empty value passed for parameter 'error'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_error'
__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 error is not None:
__body["error"] = error
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_error",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("features",),
)
@_stability_warning(Stability.EXPERIMENTAL)
def update_features(
self,
*,
connector_id: str,
features: t.Optional[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,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Update the connector features.
Update the connector features in the connector document.
This API can be used to control the following aspects of a connector:</p>
<ul>
<li>document-level security</li>
<li>incremental syncs</li>
<li>advanced sync rules</li>
<li>basic sync rules</li>
</ul>
<p>Normally, the running connector service automatically manages these features.
However, you can use this API to override the default behavior.</p>
<p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features>`_
:param connector_id: The unique identifier of the connector to be updated.
:param features:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if features is None and body is None:
raise ValueError("Empty value passed for parameter 'features'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_features'
__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 features is not None:
__body["features"] = features
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_features",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("advanced_snippet", "filtering", "rules"),
)
@_stability_warning(Stability.BETA)
def update_filtering(
self,
*,
connector_id: str,
advanced_snippet: t.Optional[t.Mapping[str, t.Any]] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
filtering: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
human: t.Optional[bool] = None,
pretty: t.Optional[bool] = None,
rules: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Update the connector filtering.</p>
<p>Update the draft filtering configuration of a connector and marks the draft validation state as edited.
The filtering draft is activated once validated by the running Elastic connector service.
The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering>`_
:param connector_id: The unique identifier of the connector to be updated
:param advanced_snippet:
:param filtering:
:param rules:
"""
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'
__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 advanced_snippet is not None:
__body["advanced_snippet"] = advanced_snippet
if filtering is not None:
__body["filtering"] = filtering
if rules is not None:
__body["rules"] = rules
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_filtering",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("validation",),
)
@_stability_warning(Stability.EXPERIMENTAL)
def update_filtering_validation(
self,
*,
connector_id: str,
validation: t.Optional[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,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Update the connector draft filtering validation.</p>
<p>Update the draft filtering validation info for a connector.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering-validation>`_
:param connector_id: The unique identifier of the connector to be updated
:param validation:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if validation is None and body is None:
raise ValueError("Empty value passed for parameter 'validation'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_filtering/_validation'
__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 validation is not None:
__body["validation"] = validation
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_filtering_validation",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("index_name",),
)
@_stability_warning(Stability.BETA)
def update_index_name(
self,
*,
connector_id: str,
index_name: 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]:
"""
.. raw:: html
<p>Update the connector index name.</p>
<p>Update the <code>index_name</code> field of a connector, specifying the index where the data ingested by the connector is stored.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name>`_
:param connector_id: The unique identifier of the connector to be updated
:param index_name:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if index_name is None and body is None:
raise ValueError("Empty value passed for parameter 'index_name'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_index_name'
__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 index_name is not None:
__body["index_name"] = index_name
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_index_name",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("description", "name"),
)
@_stability_warning(Stability.BETA)
def update_name(
self,
*,
connector_id: str,
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,
name: t.Optional[str] = None,
pretty: t.Optional[bool] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Update the connector name and description.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name>`_
:param connector_id: The unique identifier of the connector to be updated
:param description:
:param name:
"""
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"]}/_name'
__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 name is not None:
__body["name"] = name
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_name",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("is_native",),
)
@_stability_warning(Stability.BETA)
def update_native(
self,
*,
connector_id: str,
is_native: 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,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Update the connector is_native flag.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-native>`_
:param connector_id: The unique identifier of the connector to be updated
:param is_native:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if is_native is None and body is None:
raise ValueError("Empty value passed for parameter 'is_native'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_native'
__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 is_native is not None:
__body["is_native"] = is_native
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_native",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("pipeline",),
)
@_stability_warning(Stability.BETA)
def update_pipeline(
self,
*,
connector_id: str,
pipeline: t.Optional[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,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Update the connector pipeline.</p>
<p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline>`_
:param connector_id: The unique identifier of the connector to be updated
:param pipeline:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if pipeline is None and body is None:
raise ValueError("Empty value passed for parameter 'pipeline'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_pipeline'
__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 pipeline is not None:
__body["pipeline"] = pipeline
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_pipeline",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("scheduling",),
)
@_stability_warning(Stability.BETA)
def update_scheduling(
self,
*,
connector_id: str,
scheduling: t.Optional[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,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
<p>Update the connector scheduling.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling>`_
:param connector_id: The unique identifier of the connector to be updated
:param scheduling:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if scheduling is None and body is None:
raise ValueError("Empty value passed for parameter 'scheduling'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_scheduling'
__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 scheduling is not None:
__body["scheduling"] = scheduling
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_scheduling",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("service_type",),
)
@_stability_warning(Stability.BETA)
def update_service_type(
self,
*,
connector_id: str,
service_type: 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]:
"""
.. raw:: html
<p>Update the connector service type.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type>`_
:param connector_id: The unique identifier of the connector to be updated
:param service_type:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if service_type is None and body is None:
raise ValueError("Empty value passed for parameter 'service_type'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_service_type'
__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 service_type is not None:
__body["service_type"] = service_type
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_service_type",
path_parts=__path_parts,
)
@_rewrite_parameters(
body_fields=("status",),
)
@_stability_warning(Stability.EXPERIMENTAL)
def update_status(
self,
*,
connector_id: str,
status: t.Optional[
t.Union[
str,
t.Literal[
"configured", "connected", "created", "error", "needs_configuration"
],
]
] = 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]:
"""
.. raw:: html
<p>Update the connector status.</p>
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status>`_
:param connector_id: The unique identifier of the connector to be updated
:param status:
"""
if connector_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'connector_id'")
if status is None and body is None:
raise ValueError("Empty value passed for parameter 'status'")
__path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
__path = f'/_connector/{__path_parts["connector_id"]}/_status'
__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 status is not None:
__body["status"] = status
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"PUT",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="connector.update_status",
path_parts=__path_parts,
)
|