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 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770
// This file is @generated by prost-build.
/// Detailed statistics on the entry's usage.
///
/// Usage statistics have the following limitations:
///
/// - Only BigQuery tables have them.
/// - They only include BigQuery query jobs.
/// - They might be underestimated because wildcard table references
/// are not yet counted. For more information, see
/// \[Querying multiple tables using a wildcard table\]
/// (<https://cloud.google.com/bigquery/docs/querying-wildcard-tables>)
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UsageStats {
/// The number of successful uses of the underlying entry.
#[prost(float, tag = "1")]
pub total_completions: f32,
/// The number of failed attempts to use the underlying entry.
#[prost(float, tag = "2")]
pub total_failures: f32,
/// The number of cancelled attempts to use the underlying entry.
#[prost(float, tag = "3")]
pub total_cancellations: f32,
/// Total time spent only on successful uses, in milliseconds.
#[prost(float, tag = "4")]
pub total_execution_time_for_completions_millis: f32,
}
/// Common statistics on the entry's usage.
///
/// They can be set on any system.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CommonUsageStats {
/// View count in source system.
#[prost(int64, optional, tag = "1")]
pub view_count: ::core::option::Option<i64>,
}
/// The set of all usage signals that Data Catalog stores.
///
/// Note: Usually, these signals are updated daily. In rare cases, an update may
/// fail but will be performed again on the next day.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UsageSignal {
/// The end timestamp of the duration of usage statistics.
#[prost(message, optional, tag = "1")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. BigQuery usage statistics over each of the predefined time
/// ranges.
///
/// Supported time ranges are `{"24H", "7D", "30D"}`.
#[prost(btree_map = "string, message", tag = "2")]
pub usage_within_time_range: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
UsageStats,
>,
/// Common usage statistics over each of the predefined time ranges.
///
/// Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`.
#[prost(btree_map = "string, message", tag = "3")]
pub common_usage_within_time_range: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
CommonUsageStats,
>,
/// Favorite count in the source system.
#[prost(int64, optional, tag = "4")]
pub favorite_count: ::core::option::Option<i64>,
}
/// Specification for the BigQuery connection.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQueryConnectionSpec {
/// The type of the BigQuery connection.
#[prost(enumeration = "big_query_connection_spec::ConnectionType", tag = "1")]
pub connection_type: i32,
/// True if there are credentials attached to the BigQuery connection; false
/// otherwise.
#[prost(bool, tag = "3")]
pub has_credential: bool,
#[prost(oneof = "big_query_connection_spec::ConnectionSpec", tags = "2")]
pub connection_spec: ::core::option::Option<
big_query_connection_spec::ConnectionSpec,
>,
}
/// Nested message and enum types in `BigQueryConnectionSpec`.
pub mod big_query_connection_spec {
/// The type of the BigQuery connection.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ConnectionType {
/// Unspecified type.
Unspecified = 0,
/// Cloud SQL connection.
CloudSql = 1,
}
impl ConnectionType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ConnectionType::Unspecified => "CONNECTION_TYPE_UNSPECIFIED",
ConnectionType::CloudSql => "CLOUD_SQL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"CONNECTION_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"CLOUD_SQL" => Some(Self::CloudSql),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConnectionSpec {
/// Specification for the BigQuery connection to a Cloud SQL instance.
#[prost(message, tag = "2")]
CloudSql(super::CloudSqlBigQueryConnectionSpec),
}
}
/// Specification for the BigQuery connection to a Cloud SQL instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CloudSqlBigQueryConnectionSpec {
/// Cloud SQL instance ID in the format of `project:location:instance`.
#[prost(string, tag = "1")]
pub instance_id: ::prost::alloc::string::String,
/// Database name.
#[prost(string, tag = "2")]
pub database: ::prost::alloc::string::String,
/// Type of the Cloud SQL database.
#[prost(
enumeration = "cloud_sql_big_query_connection_spec::DatabaseType",
tag = "3"
)]
pub r#type: i32,
}
/// Nested message and enum types in `CloudSqlBigQueryConnectionSpec`.
pub mod cloud_sql_big_query_connection_spec {
/// Supported Cloud SQL database types.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DatabaseType {
/// Unspecified database type.
Unspecified = 0,
/// Cloud SQL for PostgreSQL.
Postgres = 1,
/// Cloud SQL for MySQL.
Mysql = 2,
}
impl DatabaseType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
DatabaseType::Unspecified => "DATABASE_TYPE_UNSPECIFIED",
DatabaseType::Postgres => "POSTGRES",
DatabaseType::Mysql => "MYSQL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DATABASE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"POSTGRES" => Some(Self::Postgres),
"MYSQL" => Some(Self::Mysql),
_ => None,
}
}
}
}
/// Fields specific for BigQuery routines.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQueryRoutineSpec {
/// Paths of the imported libraries.
#[prost(string, repeated, tag = "1")]
pub imported_libraries: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Entry metadata relevant only to the user and private to them.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct PersonalDetails {
/// True if the entry is starred by the user; false otherwise.
#[prost(bool, tag = "1")]
pub starred: bool,
/// Set if the entry is starred; unset otherwise.
#[prost(message, optional, tag = "2")]
pub star_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// This enum lists all the systems that Data Catalog integrates with.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum IntegratedSystem {
/// Default unknown system.
Unspecified = 0,
/// BigQuery.
Bigquery = 1,
/// Cloud Pub/Sub.
CloudPubsub = 2,
/// Dataproc Metastore.
DataprocMetastore = 3,
/// Dataplex.
Dataplex = 4,
/// Cloud Spanner
CloudSpanner = 6,
/// Cloud Bigtable
CloudBigtable = 7,
/// Cloud Sql
CloudSql = 8,
/// Looker
Looker = 9,
/// Vertex AI
VertexAi = 10,
}
impl IntegratedSystem {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
IntegratedSystem::Unspecified => "INTEGRATED_SYSTEM_UNSPECIFIED",
IntegratedSystem::Bigquery => "BIGQUERY",
IntegratedSystem::CloudPubsub => "CLOUD_PUBSUB",
IntegratedSystem::DataprocMetastore => "DATAPROC_METASTORE",
IntegratedSystem::Dataplex => "DATAPLEX",
IntegratedSystem::CloudSpanner => "CLOUD_SPANNER",
IntegratedSystem::CloudBigtable => "CLOUD_BIGTABLE",
IntegratedSystem::CloudSql => "CLOUD_SQL",
IntegratedSystem::Looker => "LOOKER",
IntegratedSystem::VertexAi => "VERTEX_AI",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INTEGRATED_SYSTEM_UNSPECIFIED" => Some(Self::Unspecified),
"BIGQUERY" => Some(Self::Bigquery),
"CLOUD_PUBSUB" => Some(Self::CloudPubsub),
"DATAPROC_METASTORE" => Some(Self::DataprocMetastore),
"DATAPLEX" => Some(Self::Dataplex),
"CLOUD_SPANNER" => Some(Self::CloudSpanner),
"CLOUD_BIGTABLE" => Some(Self::CloudBigtable),
"CLOUD_SQL" => Some(Self::CloudSql),
"LOOKER" => Some(Self::Looker),
"VERTEX_AI" => Some(Self::VertexAi),
_ => None,
}
}
}
/// This enum describes all the systems that manage
/// Taxonomy and PolicyTag resources in DataCatalog.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ManagingSystem {
/// Default value
Unspecified = 0,
/// Dataplex.
Dataplex = 1,
/// Other
Other = 2,
}
impl ManagingSystem {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ManagingSystem::Unspecified => "MANAGING_SYSTEM_UNSPECIFIED",
ManagingSystem::Dataplex => "MANAGING_SYSTEM_DATAPLEX",
ManagingSystem::Other => "MANAGING_SYSTEM_OTHER",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MANAGING_SYSTEM_UNSPECIFIED" => Some(Self::Unspecified),
"MANAGING_SYSTEM_DATAPLEX" => Some(Self::Dataplex),
"MANAGING_SYSTEM_OTHER" => Some(Self::Other),
_ => None,
}
}
}
/// Physical location of an entry.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataSource {
/// Service that physically stores the data.
#[prost(enumeration = "data_source::Service", tag = "1")]
pub service: i32,
/// Full name of a resource as defined by the service. For example:
///
/// `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
#[prost(string, tag = "2")]
pub resource: ::prost::alloc::string::String,
/// Output only. Data Catalog entry name, if applicable.
#[prost(string, tag = "3")]
pub source_entry: ::prost::alloc::string::String,
#[prost(oneof = "data_source::Properties", tags = "4")]
pub properties: ::core::option::Option<data_source::Properties>,
}
/// Nested message and enum types in `DataSource`.
pub mod data_source {
/// Name of a service that stores the data.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Service {
/// Default unknown service.
Unspecified = 0,
/// Google Cloud Storage service.
CloudStorage = 1,
/// BigQuery service.
Bigquery = 2,
}
impl Service {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Service::Unspecified => "SERVICE_UNSPECIFIED",
Service::CloudStorage => "CLOUD_STORAGE",
Service::Bigquery => "BIGQUERY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SERVICE_UNSPECIFIED" => Some(Self::Unspecified),
"CLOUD_STORAGE" => Some(Self::CloudStorage),
"BIGQUERY" => Some(Self::Bigquery),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Properties {
/// Detailed properties of the underlying storage.
#[prost(message, tag = "4")]
StorageProperties(super::StorageProperties),
}
}
/// Details the properties of the underlying storage.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StorageProperties {
/// Patterns to identify a set of files for this fileset.
///
/// Examples of a valid `file_pattern`:
///
/// * `gs://bucket_name/dir/*`: matches all files in the `bucket_name/dir`
/// directory
/// * `gs://bucket_name/dir/**`: matches all files in the `bucket_name/dir`
/// and all subdirectories recursively
/// * `gs://bucket_name/file*`: matches files prefixed by `file` in
/// `bucket_name`
/// * `gs://bucket_name/??.txt`: matches files with two characters followed by
/// `.txt` in `bucket_name`
/// * `gs://bucket_name/\[aeiou\].txt`: matches files that contain a single
/// vowel character followed by `.txt` in
/// `bucket_name`
/// * `gs://bucket_name/\[a-m\].txt`: matches files that contain `a`, `b`, ...
/// or `m` followed by `.txt` in `bucket_name`
/// * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match
/// the `a/*/b` pattern, such as `a/c/b`, `a/d/b`
/// * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`
#[prost(string, repeated, tag = "1")]
pub file_pattern: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// File type in MIME format, for example, `text/plain`.
#[prost(string, tag = "2")]
pub file_type: ::prost::alloc::string::String,
}
/// Native schema used by a resource represented as an entry. Used by query
/// engines for deserializing and parsing source data.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PhysicalSchema {
#[prost(oneof = "physical_schema::Schema", tags = "1, 2, 3, 4, 5, 6")]
pub schema: ::core::option::Option<physical_schema::Schema>,
}
/// Nested message and enum types in `PhysicalSchema`.
pub mod physical_schema {
/// Schema in Avro JSON format.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AvroSchema {
/// JSON source of the Avro schema.
#[prost(string, tag = "1")]
pub text: ::prost::alloc::string::String,
}
/// Schema in Thrift format.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ThriftSchema {
/// Thrift IDL source of the schema.
#[prost(string, tag = "1")]
pub text: ::prost::alloc::string::String,
}
/// Schema in protocol buffer format.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProtobufSchema {
/// Protocol buffer source of the schema.
#[prost(string, tag = "1")]
pub text: ::prost::alloc::string::String,
}
/// Marks a Parquet-encoded data source.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ParquetSchema {}
/// Marks an ORC-encoded data source.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct OrcSchema {}
/// Marks a CSV-encoded data source.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CsvSchema {}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Schema {
/// Schema in Avro JSON format.
#[prost(message, tag = "1")]
Avro(AvroSchema),
/// Schema in Thrift format.
#[prost(message, tag = "2")]
Thrift(ThriftSchema),
/// Schema in protocol buffer format.
#[prost(message, tag = "3")]
Protobuf(ProtobufSchema),
/// Marks a Parquet-encoded data source.
#[prost(message, tag = "4")]
Parquet(ParquetSchema),
/// Marks an ORC-encoded data source.
#[prost(message, tag = "5")]
Orc(OrcSchema),
/// Marks a CSV-encoded data source.
#[prost(message, tag = "6")]
Csv(CsvSchema),
}
}
/// Common Dataplex fields.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataplexSpec {
/// Fully qualified resource name of an asset in Dataplex, to which the
/// underlying data source (Cloud Storage bucket or BigQuery dataset) of the
/// entity is attached.
#[prost(string, tag = "1")]
pub asset: ::prost::alloc::string::String,
/// Format of the data.
#[prost(message, optional, tag = "2")]
pub data_format: ::core::option::Option<PhysicalSchema>,
/// Compression format of the data, e.g., zip, gzip etc.
#[prost(string, tag = "3")]
pub compression_format: ::prost::alloc::string::String,
/// Project ID of the underlying Cloud Storage or BigQuery data. Note that
/// this may not be the same project as the correspondingly Dataplex lake /
/// zone / asset.
#[prost(string, tag = "4")]
pub project_id: ::prost::alloc::string::String,
}
/// Entry specyfication for a Dataplex fileset.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataplexFilesetSpec {
/// Common Dataplex fields.
#[prost(message, optional, tag = "1")]
pub dataplex_spec: ::core::option::Option<DataplexSpec>,
}
/// Entry specification for a Dataplex table.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataplexTableSpec {
/// List of external tables registered by Dataplex in other systems based on
/// the same underlying data.
///
/// External tables allow to query this data in those systems.
#[prost(message, repeated, tag = "1")]
pub external_tables: ::prost::alloc::vec::Vec<DataplexExternalTable>,
/// Common Dataplex fields.
#[prost(message, optional, tag = "2")]
pub dataplex_spec: ::core::option::Option<DataplexSpec>,
/// Indicates if the table schema is managed by the user or not.
#[prost(bool, tag = "3")]
pub user_managed: bool,
}
/// External table registered by Dataplex.
/// Dataplex publishes data discovered from an asset into multiple other systems
/// (BigQuery, DPMS) in form of tables. We call them "external tables". External
/// tables are also synced into the Data Catalog.
/// This message contains pointers to
/// those external tables (fully qualified name, resource name et cetera) within
/// the Data Catalog.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataplexExternalTable {
/// Service in which the external table is registered.
#[prost(enumeration = "IntegratedSystem", tag = "1")]
pub system: i32,
/// Fully qualified name (FQN) of the external table.
#[prost(string, tag = "28")]
pub fully_qualified_name: ::prost::alloc::string::String,
/// Google Cloud resource name of the external table.
#[prost(string, tag = "3")]
pub google_cloud_resource: ::prost::alloc::string::String,
/// Name of the Data Catalog entry representing the external table.
#[prost(string, tag = "4")]
pub data_catalog_entry: ::prost::alloc::string::String,
}
/// Timestamps associated with this resource in a particular system.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SystemTimestamps {
/// Creation timestamp of the resource within the given system.
#[prost(message, optional, tag = "1")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Timestamp of the last modification of the resource or its metadata within
/// a given system.
///
/// Note: Depending on the source system, not every modification updates this
/// timestamp.
/// For example, BigQuery timestamps every metadata modification but not data
/// or permission changes.
#[prost(message, optional, tag = "2")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Expiration timestamp of the resource within the given system.
///
/// Currently only applicable to BigQuery resources.
#[prost(message, optional, tag = "3")]
pub expire_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Describes a Cloud Storage fileset entry.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GcsFilesetSpec {
/// Required. Patterns to identify a set of files in Google Cloud Storage.
///
/// For more information, see \[Wildcard Names\]
/// (<https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames>).
///
/// Note: Currently, bucket wildcards are not supported.
///
/// Examples of valid `file_patterns`:
///
/// * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir`
/// directory
/// * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir`
/// and all subdirectories
/// * `gs://bucket_name/file*`: matches files prefixed by `file` in
/// `bucket_name`
/// * `gs://bucket_name/??.txt`: matches files with two characters followed by
/// `.txt` in `bucket_name`
/// * `gs://bucket_name/\[aeiou\].txt`: matches files that contain a single
/// vowel character followed by `.txt` in
/// `bucket_name`
/// * `gs://bucket_name/\[a-m\].txt`: matches files that contain `a`, `b`, ...
/// or `m` followed by `.txt` in `bucket_name`
/// * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match
/// the `a/*/b` pattern, such as `a/c/b`, `a/d/b`
/// * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`
///
/// You can combine wildcards to match complex sets of files, for example:
///
/// `gs://bucket_name/\[a-m\]??.j*g`
#[prost(string, repeated, tag = "1")]
pub file_patterns: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Output only. Sample files contained in this fileset, not all files
/// contained in this fileset are represented here.
#[prost(message, repeated, tag = "2")]
pub sample_gcs_file_specs: ::prost::alloc::vec::Vec<GcsFileSpec>,
}
/// Specification of a single file in Cloud Storage.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GcsFileSpec {
/// Required. Full file path. Example: `gs://bucket_name/a/b.txt`.
#[prost(string, tag = "1")]
pub file_path: ::prost::alloc::string::String,
/// Output only. Creation, modification, and expiration timestamps of a Cloud
/// Storage file.
#[prost(message, optional, tag = "2")]
pub gcs_timestamps: ::core::option::Option<SystemTimestamps>,
/// Output only. File size in bytes.
#[prost(int64, tag = "4")]
pub size_bytes: i64,
}
/// Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Schema {
/// The unified GoogleSQL-like schema of columns.
///
/// The overall maximum number of columns and nested columns is 10,000.
/// The maximum nested depth is 15 levels.
#[prost(message, repeated, tag = "2")]
pub columns: ::prost::alloc::vec::Vec<ColumnSchema>,
}
/// A column within a schema. Columns can be nested inside
/// other columns.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ColumnSchema {
/// Required. Name of the column.
///
/// Must be a UTF-8 string without dots (.).
/// The maximum size is 64 bytes.
#[prost(string, tag = "6")]
pub column: ::prost::alloc::string::String,
/// Required. Type of the column.
///
/// Must be a UTF-8 string with the maximum size of 128 bytes.
#[prost(string, tag = "1")]
pub r#type: ::prost::alloc::string::String,
/// Optional. Description of the column. Default value is an empty string.
///
/// The description must be a UTF-8 string with the maximum size of 2000
/// bytes.
#[prost(string, tag = "2")]
pub description: ::prost::alloc::string::String,
/// Optional. A column's mode indicates whether values in this column are
/// required, nullable, or repeated.
///
/// Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported.
/// Default mode is `NULLABLE`.
#[prost(string, tag = "3")]
pub mode: ::prost::alloc::string::String,
/// Optional. Default value for the column.
#[prost(string, tag = "8")]
pub default_value: ::prost::alloc::string::String,
/// Optional. Ordinal position
#[prost(int32, tag = "9")]
pub ordinal_position: i32,
/// Optional. Most important inclusion of this column.
#[prost(enumeration = "column_schema::IndexingType", tag = "10")]
pub highest_indexing_type: i32,
/// Optional. Schema of sub-columns. A column can have zero or more
/// sub-columns.
#[prost(message, repeated, tag = "7")]
pub subcolumns: ::prost::alloc::vec::Vec<ColumnSchema>,
/// Optional. The subtype of the RANGE, if the type of this field is RANGE. If
/// the type is RANGE, this field is required. Possible values for the field
/// element type of a RANGE include:
/// * DATE
/// * DATETIME
/// * TIMESTAMP
#[prost(message, optional, tag = "19")]
pub range_element_type: ::core::option::Option<column_schema::FieldElementType>,
/// Optional. Garbage collection policy for the column or column family.
/// Applies to systems like Cloud Bigtable.
#[prost(string, tag = "11")]
pub gc_rule: ::prost::alloc::string::String,
/// Information only applying for columns in Entries from a specific system.
#[prost(oneof = "column_schema::SystemSpec", tags = "18")]
pub system_spec: ::core::option::Option<column_schema::SystemSpec>,
}
/// Nested message and enum types in `ColumnSchema`.
pub mod column_schema {
/// Column info specific to Looker System.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct LookerColumnSpec {
/// Looker specific column type of this column.
#[prost(enumeration = "looker_column_spec::LookerColumnType", tag = "1")]
pub r#type: i32,
}
/// Nested message and enum types in `LookerColumnSpec`.
pub mod looker_column_spec {
/// Column type in Looker.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum LookerColumnType {
/// Unspecified.
Unspecified = 0,
/// Dimension.
Dimension = 1,
/// Dimension group - parent for Dimension.
DimensionGroup = 2,
/// Filter.
Filter = 3,
/// Measure.
Measure = 4,
/// Parameter.
Parameter = 5,
}
impl LookerColumnType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
LookerColumnType::Unspecified => "LOOKER_COLUMN_TYPE_UNSPECIFIED",
LookerColumnType::Dimension => "DIMENSION",
LookerColumnType::DimensionGroup => "DIMENSION_GROUP",
LookerColumnType::Filter => "FILTER",
LookerColumnType::Measure => "MEASURE",
LookerColumnType::Parameter => "PARAMETER",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"LOOKER_COLUMN_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"DIMENSION" => Some(Self::Dimension),
"DIMENSION_GROUP" => Some(Self::DimensionGroup),
"FILTER" => Some(Self::Filter),
"MEASURE" => Some(Self::Measure),
"PARAMETER" => Some(Self::Parameter),
_ => None,
}
}
}
}
/// Represents the type of a field element.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FieldElementType {
/// Required. The type of a field element. See
/// [ColumnSchema.type][google.cloud.datacatalog.v1.ColumnSchema.type].
#[prost(string, tag = "1")]
pub r#type: ::prost::alloc::string::String,
}
/// Specifies inclusion of the column in an index
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum IndexingType {
/// Unspecified.
Unspecified = 0,
/// Column not a part of an index.
None = 1,
/// Column Part of non unique index.
NonUnique = 2,
/// Column part of unique index.
Unique = 3,
/// Column part of the primary key.
PrimaryKey = 4,
}
impl IndexingType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
IndexingType::Unspecified => "INDEXING_TYPE_UNSPECIFIED",
IndexingType::None => "INDEXING_TYPE_NONE",
IndexingType::NonUnique => "INDEXING_TYPE_NON_UNIQUE",
IndexingType::Unique => "INDEXING_TYPE_UNIQUE",
IndexingType::PrimaryKey => "INDEXING_TYPE_PRIMARY_KEY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INDEXING_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"INDEXING_TYPE_NONE" => Some(Self::None),
"INDEXING_TYPE_NON_UNIQUE" => Some(Self::NonUnique),
"INDEXING_TYPE_UNIQUE" => Some(Self::Unique),
"INDEXING_TYPE_PRIMARY_KEY" => Some(Self::PrimaryKey),
_ => None,
}
}
}
/// Information only applying for columns in Entries from a specific system.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum SystemSpec {
/// Looker specific column info of this column.
#[prost(message, tag = "18")]
LookerColumnSpec(LookerColumnSpec),
}
}
/// Result in the response to a search request.
///
/// Each result captures details of one entry that matches the search.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchCatalogResult {
/// Type of the search result.
///
/// You can use this field to determine which get method to call to fetch the
/// full resource.
#[prost(enumeration = "SearchResultType", tag = "1")]
pub search_result_type: i32,
/// Sub-type of the search result.
///
/// A dot-delimited full type of the resource. The same type you
/// specify in the `type` search predicate.
///
/// Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.
#[prost(string, tag = "2")]
pub search_result_subtype: ::prost::alloc::string::String,
/// The relative name of the resource in URL format.
///
/// Examples:
///
/// * `projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`
/// * `projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}`
#[prost(string, tag = "3")]
pub relative_resource_name: ::prost::alloc::string::String,
/// The full name of the Google Cloud resource the entry belongs to.
///
/// For more information, see \[Full Resource Name\]
/// (/apis/design/resource_names#full_resource_name).
///
/// Example:
///
/// `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`
#[prost(string, tag = "4")]
pub linked_resource: ::prost::alloc::string::String,
/// The last modification timestamp of the entry in the source system.
#[prost(message, optional, tag = "7")]
pub modify_time: ::core::option::Option<::prost_types::Timestamp>,
/// Fully qualified name (FQN) of the resource.
///
/// FQNs take two forms:
///
/// * For non-regionalized resources:
///
/// `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
///
/// * For regionalized resources:
///
/// `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
///
/// Example for a DPMS table:
///
/// `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`
#[prost(string, tag = "10")]
pub fully_qualified_name: ::prost::alloc::string::String,
/// The display name of the result.
#[prost(string, tag = "12")]
pub display_name: ::prost::alloc::string::String,
/// Entry description that can consist of several sentences or paragraphs that
/// describe entry contents.
#[prost(string, tag = "13")]
pub description: ::prost::alloc::string::String,
/// The source system of the entry. Applicable only when the
/// `search_result_type` is `ENTRY`.
#[prost(oneof = "search_catalog_result::System", tags = "8, 9")]
pub system: ::core::option::Option<search_catalog_result::System>,
}
/// Nested message and enum types in `SearchCatalogResult`.
pub mod search_catalog_result {
/// The source system of the entry. Applicable only when the
/// `search_result_type` is `ENTRY`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum System {
/// Output only. The source system that Data Catalog automatically integrates
/// with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
#[prost(enumeration = "super::IntegratedSystem", tag = "8")]
IntegratedSystem(i32),
/// Custom source system that you can manually integrate Data Catalog with.
#[prost(string, tag = "9")]
UserSpecifiedSystem(::prost::alloc::string::String),
}
}
/// The resource types that can be returned in search results.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum SearchResultType {
/// Default unknown type.
Unspecified = 0,
/// An [Entry][google.cloud.datacatalog.v1.Entry].
Entry = 1,
/// A [TagTemplate][google.cloud.datacatalog.v1.TagTemplate].
TagTemplate = 2,
/// An [EntryGroup][google.cloud.datacatalog.v1.EntryGroup].
EntryGroup = 3,
}
impl SearchResultType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
SearchResultType::Unspecified => "SEARCH_RESULT_TYPE_UNSPECIFIED",
SearchResultType::Entry => "ENTRY",
SearchResultType::TagTemplate => "TAG_TEMPLATE",
SearchResultType::EntryGroup => "ENTRY_GROUP",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SEARCH_RESULT_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"ENTRY" => Some(Self::Entry),
"TAG_TEMPLATE" => Some(Self::TagTemplate),
"ENTRY_GROUP" => Some(Self::EntryGroup),
_ => None,
}
}
}
/// Describes a BigQuery table.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQueryTableSpec {
/// Output only. The table source type.
#[prost(enumeration = "TableSourceType", tag = "1")]
pub table_source_type: i32,
/// Output only.
#[prost(oneof = "big_query_table_spec::TypeSpec", tags = "2, 3")]
pub type_spec: ::core::option::Option<big_query_table_spec::TypeSpec>,
}
/// Nested message and enum types in `BigQueryTableSpec`.
pub mod big_query_table_spec {
/// Output only.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TypeSpec {
/// Table view specification. Populated only if
/// the `table_source_type` is `BIGQUERY_VIEW`.
#[prost(message, tag = "2")]
ViewSpec(super::ViewSpec),
/// Specification of a BigQuery table. Populated only if
/// the `table_source_type` is `BIGQUERY_TABLE`.
#[prost(message, tag = "3")]
TableSpec(super::TableSpec),
}
}
/// Table view specification.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ViewSpec {
/// Output only. The query that defines the table view.
#[prost(string, tag = "1")]
pub view_query: ::prost::alloc::string::String,
}
/// Normal BigQuery table specification.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TableSpec {
/// Output only. If the table is date-sharded, that is, it matches the
/// `\[prefix\]YYYYMMDD` name pattern, this field is the Data Catalog resource
/// name of the date-sharded grouped entry. For example:
///
/// `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`.
///
/// Otherwise, `grouped_entry` is empty.
#[prost(string, tag = "1")]
pub grouped_entry: ::prost::alloc::string::String,
}
/// Specification for a group of BigQuery tables with the `\[prefix\]YYYYMMDD` name
/// pattern.
///
/// For more information, see \[Introduction to partitioned tables\]
/// (<https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQueryDateShardedSpec {
/// Output only. The Data Catalog resource name of the dataset entry the
/// current table belongs to. For example:
///
/// `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`.
#[prost(string, tag = "1")]
pub dataset: ::prost::alloc::string::String,
/// Output only. The table name prefix of the shards.
///
/// The name of any given shard is `\[table_prefix\]YYYYMMDD`.
/// For example, for the `MyTable20180101` shard, the
/// `table_prefix` is `MyTable`.
#[prost(string, tag = "2")]
pub table_prefix: ::prost::alloc::string::String,
/// Output only. Total number of shards.
#[prost(int64, tag = "3")]
pub shard_count: i64,
/// Output only. BigQuery resource name of the latest shard.
#[prost(string, tag = "4")]
pub latest_shard_resource: ::prost::alloc::string::String,
}
/// Table source type.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum TableSourceType {
/// Default unknown type.
Unspecified = 0,
/// Table view.
BigqueryView = 2,
/// BigQuery native table.
BigqueryTable = 5,
/// BigQuery materialized view.
BigqueryMaterializedView = 7,
}
impl TableSourceType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
TableSourceType::Unspecified => "TABLE_SOURCE_TYPE_UNSPECIFIED",
TableSourceType::BigqueryView => "BIGQUERY_VIEW",
TableSourceType::BigqueryTable => "BIGQUERY_TABLE",
TableSourceType::BigqueryMaterializedView => "BIGQUERY_MATERIALIZED_VIEW",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TABLE_SOURCE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"BIGQUERY_VIEW" => Some(Self::BigqueryView),
"BIGQUERY_TABLE" => Some(Self::BigqueryTable),
"BIGQUERY_MATERIALIZED_VIEW" => Some(Self::BigqueryMaterializedView),
_ => None,
}
}
}
/// Tags contain custom metadata and are attached to Data Catalog resources. Tags
/// conform with the specification of their tag template.
///
/// See [Data Catalog
/// IAM](<https://cloud.google.com/data-catalog/docs/concepts/iam>) for information
/// on the permissions needed to create or view tags.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Tag {
/// The resource name of the tag in URL format where tag ID is a
/// system-generated identifier.
///
/// Note: The tag itself might not be stored in the location specified in its
/// name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The resource name of the tag template this tag uses. Example:
///
/// `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}`
///
/// This field cannot be modified after creation.
#[prost(string, tag = "2")]
pub template: ::prost::alloc::string::String,
/// Output only. The display name of the tag template.
#[prost(string, tag = "5")]
pub template_display_name: ::prost::alloc::string::String,
/// Required. Maps the ID of a tag field to its value and additional
/// information about that field.
///
/// Tag template defines valid field IDs. A tag
/// must have at least 1 field and at most 500 fields.
#[prost(btree_map = "string, message", tag = "3")]
pub fields: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
TagField,
>,
/// The scope within the parent resource that this tag is attached to. If not
/// provided, the tag is attached to the parent resource itself.
///
/// Deleting the scope from the parent resource deletes all tags attached
/// to that scope.
///
/// These fields cannot be updated after creation.
#[prost(oneof = "tag::Scope", tags = "4")]
pub scope: ::core::option::Option<tag::Scope>,
}
/// Nested message and enum types in `Tag`.
pub mod tag {
/// The scope within the parent resource that this tag is attached to. If not
/// provided, the tag is attached to the parent resource itself.
///
/// Deleting the scope from the parent resource deletes all tags attached
/// to that scope.
///
/// These fields cannot be updated after creation.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Scope {
/// Resources like entry can have schemas associated with them. This scope
/// allows you to attach tags to an individual column based on that schema.
///
/// To attach a tag to a nested column, separate column names with a dot
/// (`.`). Example: `column.nested_column`.
#[prost(string, tag = "4")]
Column(::prost::alloc::string::String),
}
}
/// Contains the value and additional information on a field within
/// a [Tag][google.cloud.datacatalog.v1.Tag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TagField {
/// Output only. The display name of this field.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
/// Output only. The order of this field with respect to other fields in this
/// tag. Can be set by
/// [Tag][google.cloud.datacatalog.v1.TagTemplateField.order].
///
/// For example, a higher value can indicate a more important field.
/// The value can be negative. Multiple fields can have the same order, and
/// field orders within a tag don't have to be sequential.
#[prost(int32, tag = "7")]
pub order: i32,
/// Required. The value of this field.
#[prost(oneof = "tag_field::Kind", tags = "2, 3, 4, 5, 6, 8")]
pub kind: ::core::option::Option<tag_field::Kind>,
}
/// Nested message and enum types in `TagField`.
pub mod tag_field {
/// An enum value.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnumValue {
/// The display name of the enum value.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
}
/// Required. The value of this field.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
/// The value of a tag field with a double type.
#[prost(double, tag = "2")]
DoubleValue(f64),
/// The value of a tag field with a string type.
///
/// The maximum length is 2000 UTF-8 characters.
#[prost(string, tag = "3")]
StringValue(::prost::alloc::string::String),
/// The value of a tag field with a boolean type.
#[prost(bool, tag = "4")]
BoolValue(bool),
/// The value of a tag field with a timestamp type.
#[prost(message, tag = "5")]
TimestampValue(::prost_types::Timestamp),
/// The value of a tag field with an enum type.
///
/// This value must be one of the allowed values listed in this enum.
#[prost(message, tag = "6")]
EnumValue(EnumValue),
/// The value of a tag field with a rich text type.
///
/// The maximum length is 10 MiB as this value holds HTML descriptions
/// including encoded images. The maximum length of the text without images
/// is 100 KiB.
#[prost(string, tag = "8")]
RichtextValue(::prost::alloc::string::String),
}
}
/// A tag template defines a tag that can have one or more typed fields.
///
/// The template is used to create tags that are attached to Google Cloud
/// resources. \[Tag template roles\]
/// (<https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles>)
/// provide permissions to create, edit, and use the template. For example,
/// see the \[TagTemplate User\]
/// (<https://cloud.google.com/data-catalog/docs/how-to/template-user>) role
/// that includes a permission to use the tag template to tag resources.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TagTemplate {
/// The resource name of the tag template in URL format.
///
/// Note: The tag template itself and its child resources might not be
/// stored in the location specified in its name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Display name for this template. Defaults to an empty string.
///
/// The name must contain only Unicode letters, numbers (0-9), underscores (_),
/// dashes (-), spaces ( ), and can't start or end with spaces.
/// The maximum length is 200 characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Indicates whether tags created with this template are public. Public tags
/// do not require tag template access to appear in
/// [ListTags][google.cloud.datacatalog.v1.ListTags] API response.
///
/// Additionally, you can search for a public tag by value with a
/// simple search query in addition to using a ``tag:`` predicate.
#[prost(bool, tag = "5")]
pub is_publicly_readable: bool,
/// Required. Map of tag template field IDs to the settings for the field.
/// This map is an exhaustive list of the allowed fields. The map must contain
/// at least one field and at most 500 fields.
///
/// The keys to this map are tag template field IDs. The IDs have the
/// following limitations:
///
/// * Can contain uppercase and lowercase letters, numbers (0-9) and
/// underscores (_).
/// * Must be at least 1 character and at most 64 characters long.
/// * Must start with a letter or underscore.
#[prost(btree_map = "string, message", tag = "3")]
pub fields: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
TagTemplateField,
>,
}
/// The template for an individual field within a tag template.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TagTemplateField {
/// Output only. The resource name of the tag template field in URL format.
/// Example:
///
/// `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}`
///
/// Note: The tag template field itself might not be stored in the location
/// specified in its name.
///
/// The name must contain only letters (a-z, A-Z), numbers (0-9),
/// or underscores (_), and must start with a letter or underscore.
/// The maximum length is 64 characters.
#[prost(string, tag = "6")]
pub name: ::prost::alloc::string::String,
/// The display name for this field. Defaults to an empty string.
///
/// The name must contain only Unicode letters, numbers (0-9), underscores (_),
/// dashes (-), spaces ( ), and can't start or end with spaces.
/// The maximum length is 200 characters.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
/// Required. The type of value this tag field can contain.
#[prost(message, optional, tag = "2")]
pub r#type: ::core::option::Option<FieldType>,
/// If true, this field is required. Defaults to false.
#[prost(bool, tag = "3")]
pub is_required: bool,
/// The description for this field. Defaults to an empty string.
#[prost(string, tag = "4")]
pub description: ::prost::alloc::string::String,
/// The order of this field with respect to other fields in this tag
/// template.
///
/// For example, a higher value can indicate a more important field.
/// The value can be negative. Multiple fields can have the same order and
/// field orders within a tag don't have to be sequential.
#[prost(int32, tag = "5")]
pub order: i32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FieldType {
/// Required.
#[prost(oneof = "field_type::TypeDecl", tags = "1, 2")]
pub type_decl: ::core::option::Option<field_type::TypeDecl>,
}
/// Nested message and enum types in `FieldType`.
pub mod field_type {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnumType {
/// The set of allowed values for this enum.
///
/// This set must not be empty and can include up to 100 allowed values.
/// The display names of the values in this set must not be empty and must
/// be case-insensitively unique within this set.
///
/// The order of items in this set is preserved. This field can be used to
/// create, remove, and reorder enum values. To rename enum values, use the
/// `RenameTagTemplateFieldEnumValue` method.
#[prost(message, repeated, tag = "1")]
pub allowed_values: ::prost::alloc::vec::Vec<enum_type::EnumValue>,
}
/// Nested message and enum types in `EnumType`.
pub mod enum_type {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnumValue {
/// Required. The display name of the enum value. Must not be an empty
/// string.
///
/// The name must contain only Unicode letters, numbers (0-9), underscores
/// (_), dashes (-), spaces ( ), and can't start or end with spaces. The
/// maximum length is 200 characters.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
}
}
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum PrimitiveType {
/// The default invalid value for a type.
Unspecified = 0,
/// A double precision number.
Double = 1,
/// An UTF-8 string.
String = 2,
/// A boolean value.
Bool = 3,
/// A timestamp.
Timestamp = 4,
/// A Richtext description.
Richtext = 5,
}
impl PrimitiveType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PrimitiveType::Unspecified => "PRIMITIVE_TYPE_UNSPECIFIED",
PrimitiveType::Double => "DOUBLE",
PrimitiveType::String => "STRING",
PrimitiveType::Bool => "BOOL",
PrimitiveType::Timestamp => "TIMESTAMP",
PrimitiveType::Richtext => "RICHTEXT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PRIMITIVE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"DOUBLE" => Some(Self::Double),
"STRING" => Some(Self::String),
"BOOL" => Some(Self::Bool),
"TIMESTAMP" => Some(Self::Timestamp),
"RICHTEXT" => Some(Self::Richtext),
_ => None,
}
}
}
/// Required.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TypeDecl {
/// Primitive types, such as string, boolean, etc.
#[prost(enumeration = "PrimitiveType", tag = "1")]
PrimitiveType(i32),
/// An enum type.
#[prost(message, tag = "2")]
EnumType(EnumType),
}
}
/// Request message for
/// [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchCatalogRequest {
/// Required. The scope of this search request.
///
/// The `scope` is invalid if `include_org_ids`, `include_project_ids` are
/// empty AND `include_gcp_public_datasets` is set to `false`. In this case,
/// the request returns an error.
#[prost(message, optional, tag = "6")]
pub scope: ::core::option::Option<search_catalog_request::Scope>,
/// Optional. The query string with a minimum of 3 characters and specific
/// syntax. For more information, see [Data Catalog search
/// syntax](<https://cloud.google.com/data-catalog/docs/how-to/search-reference>).
///
/// An empty query string returns all data assets (in the specified scope)
/// that you have access to.
///
/// A query string can be a simple `xyz` or qualified by predicates:
///
/// * `name:x`
/// * `column:y`
/// * `description:z`
#[prost(string, tag = "1")]
pub query: ::prost::alloc::string::String,
/// Upper bound on the number of results you can get in a single response.
///
/// Can't be negative or 0, defaults to 10 in this case.
/// The maximum number is 1000. If exceeded, throws an "invalid argument"
/// exception.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. Pagination token that, if specified, returns the next page of
/// search results. If empty, returns the first page.
///
/// This token is returned in the
/// [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
/// field of the response to a previous
/// [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
/// call.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Specifies the order of results.
///
/// Currently supported case-sensitive values are:
///
/// * `relevance` that can only be descending
/// * `last_modified_timestamp \[asc|desc\]` with descending (`desc`) as default
/// * `default` that can only be descending
///
/// Search queries don't guarantee full recall. Results that match your query
/// might not be returned, even in subsequent result pages. Additionally,
/// returned (and not returned) results can vary if you repeat search queries.
/// If you are experiencing recall issues and you don't have to fetch the
/// results in any specific order, consider setting this parameter to
/// `default`.
///
/// If this parameter is omitted, it defaults to the descending `relevance`.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Optional. If set, use searchAll permission granted on organizations from
/// `include_org_ids` and projects from `include_project_ids` instead of the
/// fine grained per resource permissions when filtering the search results.
/// The only allowed `order_by` criteria for admin_search mode is `default`.
/// Using this flags guarantees a full recall of the search results.
#[prost(bool, tag = "17")]
pub admin_search: bool,
}
/// Nested message and enum types in `SearchCatalogRequest`.
pub mod search_catalog_request {
/// The criteria that select the subspace used for query matching.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Scope {
/// The list of organization IDs to search within.
///
/// To find your organization ID, follow the steps from
/// \[Creating and managing organizations\]
/// (/resource-manager/docs/creating-managing-organization).
#[prost(string, repeated, tag = "2")]
pub include_org_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The list of project IDs to search within.
///
/// For more information on the distinction between project names, IDs, and
/// numbers, see [Projects](/docs/overview/#projects).
#[prost(string, repeated, tag = "3")]
pub include_project_ids: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// If `true`, include Google Cloud public datasets in
/// search results. By default, they are excluded.
///
/// See [Google Cloud Public Datasets](/public-datasets) for more
/// information.
#[prost(bool, tag = "7")]
pub include_gcp_public_datasets: bool,
/// Optional. The list of locations to search within. If empty, all locations
/// are searched.
///
/// Returns an error if any location in the list isn't one of the [Supported
/// regions](<https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions>).
///
/// If a location is unreachable, its name is returned in the
/// `SearchCatalogResponse.unreachable` field. To get additional information
/// on the error, repeat the search request and set the location name as the
/// value of this parameter.
#[prost(string, repeated, tag = "16")]
pub restricted_locations: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// Optional. If `true`, search only among starred entries.
///
/// By default, all results are returned, starred or not.
#[prost(bool, tag = "18")]
pub starred_only: bool,
/// Optional. This field is deprecated. The search mechanism for public and
/// private tag templates is the same.
#[deprecated]
#[prost(bool, tag = "19")]
pub include_public_tag_templates: bool,
}
}
/// Response message for
/// [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchCatalogResponse {
/// Search results.
#[prost(message, repeated, tag = "1")]
pub results: ::prost::alloc::vec::Vec<SearchCatalogResult>,
/// The approximate total number of entries matched by the query.
#[prost(int32, tag = "2")]
pub total_size: i32,
/// Pagination token that can be used in subsequent calls to retrieve the next
/// page of results.
#[prost(string, tag = "3")]
pub next_page_token: ::prost::alloc::string::String,
/// Unreachable locations. Search results don't include data from those
/// locations.
///
/// To get additional information on an error, repeat the search request and
/// restrict it to specific locations by setting the
/// `SearchCatalogRequest.scope.restricted_locations` parameter.
#[prost(string, repeated, tag = "6")]
pub unreachable: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request message for
/// [CreateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateEntryGroupRequest {
/// Required. The names of the project and location that the new entry group
/// belongs to.
///
/// Note: The entry group itself and its child resources might not be
/// stored in the location specified in its name.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ID of the entry group to create.
///
/// The ID must contain only letters (a-z, A-Z), numbers (0-9),
/// underscores (_), and must start with a letter or underscore.
/// The maximum size is 64 bytes when encoded in UTF-8.
#[prost(string, tag = "3")]
pub entry_group_id: ::prost::alloc::string::String,
/// The entry group to create. Defaults to empty.
#[prost(message, optional, tag = "2")]
pub entry_group: ::core::option::Option<EntryGroup>,
}
/// Request message for
/// [UpdateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateEntryGroupRequest {
/// Required. Updates for the entry group. The `name` field must be set.
#[prost(message, optional, tag = "1")]
pub entry_group: ::core::option::Option<EntryGroup>,
/// Names of fields whose values to overwrite on an entry group.
///
/// If this parameter is absent or empty, all modifiable fields
/// are overwritten. If such fields are non-required and omitted in the
/// request body, their values are emptied.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [GetEntryGroup][google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetEntryGroupRequest {
/// Required. The name of the entry group to get.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The fields to return. If empty or omitted, all fields are returned.
#[prost(message, optional, tag = "2")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DeleteEntryGroup][google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteEntryGroupRequest {
/// Required. The name of the entry group to delete.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. If true, deletes all entries in the entry group.
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntryGroupsRequest {
/// Required. The name of the location that contains the entry groups to list.
///
/// Can be provided as a URL.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The maximum number of items to return.
///
/// Default is 10. Maximum limit is 1000.
/// Throws an invalid argument if `page_size` is greater than 1000.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. Pagination token that specifies the next page to return.
/// If empty, returns the first page.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntryGroupsResponse {
/// Entry group details.
#[prost(message, repeated, tag = "1")]
pub entry_groups: ::prost::alloc::vec::Vec<EntryGroup>,
/// Pagination token to specify in the next call to retrieve the next page of
/// results. Empty if there are no more items.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateEntryRequest {
/// Required. The name of the entry group this entry belongs to.
///
/// Note: The entry itself and its child resources might not be stored in
/// the location specified in its name.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ID of the entry to create.
///
/// The ID must contain only letters (a-z, A-Z), numbers (0-9),
/// and underscores (_).
/// The maximum size is 64 bytes when encoded in UTF-8.
#[prost(string, tag = "3")]
pub entry_id: ::prost::alloc::string::String,
/// Required. The entry to create.
#[prost(message, optional, tag = "2")]
pub entry: ::core::option::Option<Entry>,
}
/// Request message for
/// [UpdateEntry][google.cloud.datacatalog.v1.DataCatalog.UpdateEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateEntryRequest {
/// Required. Updates for the entry. The `name` field must be set.
#[prost(message, optional, tag = "1")]
pub entry: ::core::option::Option<Entry>,
/// Names of fields whose values to overwrite on an entry.
///
/// If this parameter is absent or empty, all modifiable fields
/// are overwritten. If such fields are non-required and omitted in the
/// request body, their values are emptied.
///
/// You can modify only the fields listed below.
///
/// For entries with type `DATA_STREAM`:
///
/// * `schema`
///
/// For entries with type `FILESET`:
///
/// * `schema`
/// * `display_name`
/// * `description`
/// * `gcs_fileset_spec`
/// * `gcs_fileset_spec.file_patterns`
///
/// For entries with `user_specified_type`:
///
/// * `schema`
/// * `display_name`
/// * `description`
/// * `user_specified_type`
/// * `user_specified_system`
/// * `linked_resource`
/// * `source_system_timestamps`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DeleteEntry][google.cloud.datacatalog.v1.DataCatalog.DeleteEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteEntryRequest {
/// Required. The name of the entry to delete.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [GetEntry][google.cloud.datacatalog.v1.DataCatalog.GetEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetEntryRequest {
/// Required. The name of the entry to get.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [LookupEntry][google.cloud.datacatalog.v1.DataCatalog.LookupEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LookupEntryRequest {
/// Project where the lookup should be performed. Required to lookup
/// entry that is not a part of `DPMS` or `DATAPLEX` `integrated_system`
/// using its `fully_qualified_name`. Ignored in other cases.
#[prost(string, tag = "6")]
pub project: ::prost::alloc::string::String,
/// Location where the lookup should be performed. Required to lookup
/// entry that is not a part of `DPMS` or `DATAPLEX` `integrated_system`
/// using its `fully_qualified_name`. Ignored in other cases.
#[prost(string, tag = "7")]
pub location: ::prost::alloc::string::String,
/// Required. A full name, SQL name, or a fully qualified name of a
/// Google Cloud Platform resource.
#[prost(oneof = "lookup_entry_request::TargetName", tags = "1, 3, 5")]
pub target_name: ::core::option::Option<lookup_entry_request::TargetName>,
}
/// Nested message and enum types in `LookupEntryRequest`.
pub mod lookup_entry_request {
/// Required. A full name, SQL name, or a fully qualified name of a
/// Google Cloud Platform resource.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TargetName {
/// The full name of the Google Cloud Platform resource the Data Catalog
/// entry represents. For more information, see \[Full Resource Name\]
/// (<https://cloud.google.com/apis/design/resource_names#full_resource_name>).
///
/// Full names are case-sensitive. For example:
///
/// * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
/// * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
#[prost(string, tag = "1")]
LinkedResource(::prost::alloc::string::String),
/// The SQL name of the entry. SQL names are case-sensitive.
///
/// Examples:
///
/// * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`
/// * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\`
/// * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`
/// * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`
/// * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}`
///
/// Identifiers (`*_ID`) should comply with the
/// \[Lexical structure in Standard SQL\]
/// (<https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical>).
#[prost(string, tag = "3")]
SqlResource(::prost::alloc::string::String),
/// [Fully Qualified Name
/// (FQN)](<https://cloud.google.com//data-catalog/docs/fully-qualified-names>)
/// of the resource.
///
/// FQNs take two forms:
///
/// * For non-regionalized resources:
///
/// `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
///
/// * For regionalized resources:
///
/// `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`
///
/// Example for a DPMS table:
///
/// `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
#[prost(string, tag = "5")]
FullyQualifiedName(::prost::alloc::string::String),
}
}
/// Entry metadata.
/// A Data Catalog entry represents another resource in Google
/// Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or
/// outside of it. You can use the `linked_resource` field
/// in the entry resource to refer to the original resource ID of the source
/// system.
///
/// An entry resource contains resource details, for example, its schema.
/// Additionally, you can attach flexible metadata to an entry in the form of a
/// [Tag][google.cloud.datacatalog.v1.Tag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Entry {
/// Output only. The resource name of an entry in URL format.
///
/// Note: The entry itself and its child resources might not be
/// stored in the location specified in its name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The resource this metadata entry refers to.
///
/// For Google Cloud Platform resources, `linked_resource` is the
/// \[Full Resource Name\]
/// (<https://cloud.google.com/apis/design/resource_names#full_resource_name>).
/// For example, the `linked_resource` for a table resource from BigQuery is:
///
/// `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
///
/// Output only when the entry is one of the types in the `EntryType` enum.
///
/// For entries with a `user_specified_type`, this field is optional and
/// defaults to an empty string.
///
/// The resource string must contain only letters (a-z, A-Z), numbers (0-9),
/// underscores (_), periods (.), colons (:), slashes (/), dashes (-),
/// and hashes (#).
/// The maximum size is 200 bytes when encoded in UTF-8.
#[prost(string, tag = "9")]
pub linked_resource: ::prost::alloc::string::String,
/// [Fully Qualified Name
/// (FQN)](<https://cloud.google.com//data-catalog/docs/fully-qualified-names>)
/// of the resource. Set automatically for entries representing resources from
/// synced systems. Settable only during creation, and read-only later. Can
/// be used for search and lookup of the entries.
///
#[prost(string, tag = "29")]
pub fully_qualified_name: ::prost::alloc::string::String,
/// Display name of an entry.
///
/// The maximum size is 500 bytes when encoded in UTF-8.
/// Default value is an empty string.
#[prost(string, tag = "3")]
pub display_name: ::prost::alloc::string::String,
/// Entry description that can consist of several sentences or paragraphs
/// that describe entry contents.
///
/// The description must not contain Unicode non-characters as well as C0
/// and C1 control codes except tabs (HT), new lines (LF), carriage returns
/// (CR), and page breaks (FF).
/// The maximum size is 2000 bytes when encoded in UTF-8.
/// Default value is an empty string.
#[prost(string, tag = "4")]
pub description: ::prost::alloc::string::String,
/// Business Context of the entry. Not supported for BigQuery datasets
#[prost(message, optional, tag = "37")]
pub business_context: ::core::option::Option<BusinessContext>,
/// Schema of the entry. An entry might not have any schema attached to it.
#[prost(message, optional, tag = "5")]
pub schema: ::core::option::Option<Schema>,
/// Timestamps from the underlying resource, not from the Data Catalog
/// entry.
///
/// Output only when the entry has a system listed in the `IntegratedSystem`
/// enum. For entries with `user_specified_system`, this field is optional
/// and defaults to an empty timestamp.
#[prost(message, optional, tag = "7")]
pub source_system_timestamps: ::core::option::Option<SystemTimestamps>,
/// Resource usage statistics.
#[prost(message, optional, tag = "13")]
pub usage_signal: ::core::option::Option<UsageSignal>,
/// Cloud labels attached to the entry.
///
/// In Data Catalog, you can create and modify labels attached only to custom
/// entries. Synced entries have unmodifiable labels that come from the source
/// system.
#[prost(btree_map = "string, string", tag = "14")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Physical location of the entry.
#[prost(message, optional, tag = "20")]
pub data_source: ::core::option::Option<DataSource>,
/// Output only. Additional information related to the entry. Private to the
/// current user.
#[prost(message, optional, tag = "26")]
pub personal_details: ::core::option::Option<PersonalDetails>,
/// Required. Entry type.
#[prost(oneof = "entry::EntryType", tags = "2, 16")]
pub entry_type: ::core::option::Option<entry::EntryType>,
/// The source system of the entry.
#[prost(oneof = "entry::System", tags = "17, 18")]
pub system: ::core::option::Option<entry::System>,
/// System specification.
/// Can be used as a complement for `spec`, when some metadata is relevant for
/// all entries existing within given system
#[prost(oneof = "entry::SystemSpec", tags = "39, 40, 41")]
pub system_spec: ::core::option::Option<entry::SystemSpec>,
/// Type specification.
#[prost(oneof = "entry::TypeSpec", tags = "6, 12, 15")]
pub type_spec: ::core::option::Option<entry::TypeSpec>,
/// Type- and system-specific information. Specifications for types contain
/// fields common to all entries of a given type, and sub-specifications with
/// fields specific to a given source system.
///
/// When extending the API with new types and systems, use this field instead
/// of the legacy `type_spec`.
#[prost(oneof = "entry::Spec", tags = "24, 27, 28, 32, 33, 42, 43")]
pub spec: ::core::option::Option<entry::Spec>,
}
/// Nested message and enum types in `Entry`.
pub mod entry {
/// Required. Entry type.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum EntryType {
/// The type of the entry.
///
/// For details, see [`EntryType`](#entrytype).
#[prost(enumeration = "super::EntryType", tag = "2")]
Type(i32),
/// Custom entry type that doesn't match any of the values allowed for input
/// and listed in the `EntryType` enum.
///
/// When creating an entry, first check the type values in the enum.
/// If there are no appropriate types for the new entry,
/// provide a custom value, for example, `my_special_type`.
///
/// The `user_specified_type` string has the following limitations:
///
/// * Is case insensitive.
/// * Must begin with a letter or underscore.
/// * Can only contain letters, numbers, and underscores.
/// * Must be at least 1 character and at most 64 characters long.
#[prost(string, tag = "16")]
UserSpecifiedType(::prost::alloc::string::String),
}
/// The source system of the entry.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum System {
/// Output only. Indicates the entry's source system that Data Catalog
/// integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
#[prost(enumeration = "super::IntegratedSystem", tag = "17")]
IntegratedSystem(i32),
/// Indicates the entry's source system that Data Catalog doesn't
/// automatically integrate with.
///
/// The `user_specified_system` string has the following limitations:
///
/// * Is case insensitive.
/// * Must begin with a letter or underscore.
/// * Can only contain letters, numbers, and underscores.
/// * Must be at least 1 character and at most 64 characters long.
#[prost(string, tag = "18")]
UserSpecifiedSystem(::prost::alloc::string::String),
}
/// System specification.
/// Can be used as a complement for `spec`, when some metadata is relevant for
/// all entries existing within given system
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SystemSpec {
/// Specification that applies to a relational database system. Only settable
/// when `user_specified_system` is equal to `SQL_DATABASE`
#[prost(message, tag = "39")]
SqlDatabaseSystemSpec(super::SqlDatabaseSystemSpec),
/// Specification that applies to Looker sysstem. Only settable when
/// `user_specified_system` is equal to `LOOKER`
#[prost(message, tag = "40")]
LookerSystemSpec(super::LookerSystemSpec),
/// Specification that applies to Cloud Bigtable system. Only settable when
/// `integrated_system` is equal to `CLOUD_BIGTABLE`
#[prost(message, tag = "41")]
CloudBigtableSystemSpec(super::CloudBigtableSystemSpec),
}
/// Type specification.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TypeSpec {
/// Specification that applies to a Cloud Storage fileset. Valid only
/// for entries with the `FILESET` type.
#[prost(message, tag = "6")]
GcsFilesetSpec(super::GcsFilesetSpec),
/// Output only. Specification that applies to a BigQuery table. Valid only
/// for entries with the `TABLE` type.
#[prost(message, tag = "12")]
BigqueryTableSpec(super::BigQueryTableSpec),
/// Output only. Specification for a group of BigQuery tables with
/// the `\[prefix\]YYYYMMDD` name pattern.
///
/// For more information, see \[Introduction to partitioned tables\]
/// (<https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding>).
#[prost(message, tag = "15")]
BigqueryDateShardedSpec(super::BigQueryDateShardedSpec),
}
/// Type- and system-specific information. Specifications for types contain
/// fields common to all entries of a given type, and sub-specifications with
/// fields specific to a given source system.
///
/// When extending the API with new types and systems, use this field instead
/// of the legacy `type_spec`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Spec {
/// Specification that applies to a table resource. Valid only
/// for entries with the `TABLE` or `EXPLORE` type.
#[prost(message, tag = "24")]
DatabaseTableSpec(super::DatabaseTableSpec),
/// Specification that applies to a data source connection. Valid only
/// for entries with the `DATA_SOURCE_CONNECTION` type.
#[prost(message, tag = "27")]
DataSourceConnectionSpec(super::DataSourceConnectionSpec),
/// Specification that applies to a user-defined function or procedure. Valid
/// only for entries with the `ROUTINE` type.
#[prost(message, tag = "28")]
RoutineSpec(super::RoutineSpec),
/// Specification that applies to a dataset.
#[prost(message, tag = "32")]
DatasetSpec(super::DatasetSpec),
/// Specification that applies to a fileset resource. Valid only
/// for entries with the `FILESET` type.
#[prost(message, tag = "33")]
FilesetSpec(super::FilesetSpec),
/// Specification that applies to a Service resource.
#[prost(message, tag = "42")]
ServiceSpec(super::ServiceSpec),
/// Model specification.
#[prost(message, tag = "43")]
ModelSpec(super::ModelSpec),
}
}
/// Specification that applies to a table resource. Valid only
/// for entries with the `TABLE` type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DatabaseTableSpec {
/// Type of this table.
#[prost(enumeration = "database_table_spec::TableType", tag = "1")]
pub r#type: i32,
/// Output only. Fields specific to a Dataplex table and present only in the
/// Dataplex table entries.
#[prost(message, optional, tag = "2")]
pub dataplex_table: ::core::option::Option<DataplexTableSpec>,
/// Spec what aplies to tables that are actually views.
/// Not set for "real" tables.
#[prost(message, optional, tag = "3")]
pub database_view_spec: ::core::option::Option<
database_table_spec::DatabaseViewSpec,
>,
}
/// Nested message and enum types in `DatabaseTableSpec`.
pub mod database_table_spec {
/// Specification that applies to database view.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DatabaseViewSpec {
/// Type of this view.
#[prost(enumeration = "database_view_spec::ViewType", tag = "1")]
pub view_type: i32,
/// Definition of the view.
#[prost(oneof = "database_view_spec::SourceDefinition", tags = "2, 3")]
pub source_definition: ::core::option::Option<
database_view_spec::SourceDefinition,
>,
}
/// Nested message and enum types in `DatabaseViewSpec`.
pub mod database_view_spec {
/// Concrete type of the view.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ViewType {
/// Default unknown view type.
Unspecified = 0,
/// Standard view.
StandardView = 1,
/// Materialized view.
MaterializedView = 2,
}
impl ViewType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ViewType::Unspecified => "VIEW_TYPE_UNSPECIFIED",
ViewType::StandardView => "STANDARD_VIEW",
ViewType::MaterializedView => "MATERIALIZED_VIEW",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"VIEW_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"STANDARD_VIEW" => Some(Self::StandardView),
"MATERIALIZED_VIEW" => Some(Self::MaterializedView),
_ => None,
}
}
}
/// Definition of the view.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SourceDefinition {
/// Name of a singular table this view reflects one to one.
#[prost(string, tag = "2")]
BaseTable(::prost::alloc::string::String),
/// SQL query used to generate this view.
#[prost(string, tag = "3")]
SqlQuery(::prost::alloc::string::String),
}
}
/// Type of the table.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum TableType {
/// Default unknown table type.
Unspecified = 0,
/// Native table.
Native = 1,
/// External table.
External = 2,
}
impl TableType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
TableType::Unspecified => "TABLE_TYPE_UNSPECIFIED",
TableType::Native => "NATIVE",
TableType::External => "EXTERNAL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TABLE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"NATIVE" => Some(Self::Native),
"EXTERNAL" => Some(Self::External),
_ => None,
}
}
}
}
/// Specification that applies to a fileset. Valid only for entries with the
/// 'FILESET' type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FilesetSpec {
/// Fields specific to a Dataplex fileset and present only in the Dataplex
/// fileset entries.
#[prost(message, optional, tag = "1")]
pub dataplex_fileset: ::core::option::Option<DataplexFilesetSpec>,
}
/// Specification that applies to a data source connection. Valid only for
/// entries with the `DATA_SOURCE_CONNECTION` type.
/// Only one of internal specs can be set at the time, and cannot
/// be changed later.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataSourceConnectionSpec {
/// Output only. Fields specific to BigQuery connections.
#[prost(message, optional, tag = "1")]
pub bigquery_connection_spec: ::core::option::Option<BigQueryConnectionSpec>,
}
/// Specification that applies to a routine. Valid only for
/// entries with the `ROUTINE` type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RoutineSpec {
/// The type of the routine.
#[prost(enumeration = "routine_spec::RoutineType", tag = "1")]
pub routine_type: i32,
/// The language the routine is written in. The exact value depends on the
/// source system. For BigQuery routines, possible values are:
///
/// * `SQL`
/// * `JAVASCRIPT`
#[prost(string, tag = "2")]
pub language: ::prost::alloc::string::String,
/// Arguments of the routine.
#[prost(message, repeated, tag = "3")]
pub routine_arguments: ::prost::alloc::vec::Vec<routine_spec::Argument>,
/// Return type of the argument. The exact value depends on the source system
/// and the language.
#[prost(string, tag = "4")]
pub return_type: ::prost::alloc::string::String,
/// The body of the routine.
#[prost(string, tag = "5")]
pub definition_body: ::prost::alloc::string::String,
/// Contains fields specific to the source system.
#[prost(oneof = "routine_spec::SystemSpec", tags = "6")]
pub system_spec: ::core::option::Option<routine_spec::SystemSpec>,
}
/// Nested message and enum types in `RoutineSpec`.
pub mod routine_spec {
/// Input or output argument of a function or stored procedure.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Argument {
/// The name of the argument. A return argument of a function might not have
/// a name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Specifies whether the argument is input or output.
#[prost(enumeration = "argument::Mode", tag = "2")]
pub mode: i32,
/// Type of the argument. The exact value depends on the source system and
/// the language.
#[prost(string, tag = "3")]
pub r#type: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Argument`.
pub mod argument {
/// The input or output mode of the argument.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Mode {
/// Unspecified mode.
Unspecified = 0,
/// The argument is input-only.
In = 1,
/// The argument is output-only.
Out = 2,
/// The argument is both an input and an output.
Inout = 3,
}
impl Mode {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Mode::Unspecified => "MODE_UNSPECIFIED",
Mode::In => "IN",
Mode::Out => "OUT",
Mode::Inout => "INOUT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MODE_UNSPECIFIED" => Some(Self::Unspecified),
"IN" => Some(Self::In),
"OUT" => Some(Self::Out),
"INOUT" => Some(Self::Inout),
_ => None,
}
}
}
}
/// The fine-grained type of the routine.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum RoutineType {
/// Unspecified type.
Unspecified = 0,
/// Non-builtin permanent scalar function.
ScalarFunction = 1,
/// Stored procedure.
Procedure = 2,
}
impl RoutineType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
RoutineType::Unspecified => "ROUTINE_TYPE_UNSPECIFIED",
RoutineType::ScalarFunction => "SCALAR_FUNCTION",
RoutineType::Procedure => "PROCEDURE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ROUTINE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"SCALAR_FUNCTION" => Some(Self::ScalarFunction),
"PROCEDURE" => Some(Self::Procedure),
_ => None,
}
}
}
/// Contains fields specific to the source system.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SystemSpec {
/// Fields specific for BigQuery routines.
#[prost(message, tag = "6")]
BigqueryRoutineSpec(super::BigQueryRoutineSpec),
}
}
/// Specification that applies to a dataset. Valid only for
/// entries with the `DATASET` type.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DatasetSpec {
/// Fields specific to the source system.
#[prost(oneof = "dataset_spec::SystemSpec", tags = "2")]
pub system_spec: ::core::option::Option<dataset_spec::SystemSpec>,
}
/// Nested message and enum types in `DatasetSpec`.
pub mod dataset_spec {
/// Fields specific to the source system.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum SystemSpec {
/// Vertex AI Dataset specific fields
#[prost(message, tag = "2")]
VertexDatasetSpec(super::VertexDatasetSpec),
}
}
/// Specification that applies to
/// entries that are part `SQL_DATABASE` system
/// (user_specified_type)
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SqlDatabaseSystemSpec {
/// SQL Database Engine.
/// enum SqlEngine {
/// UNDEFINED = 0;
/// MY_SQL = 1;
/// POSTGRE_SQL = 2;
/// SQL_SERVER = 3;
/// }
/// Engine of the enclosing database instance.
#[prost(string, tag = "1")]
pub sql_engine: ::prost::alloc::string::String,
/// Version of the database engine.
#[prost(string, tag = "2")]
pub database_version: ::prost::alloc::string::String,
/// Host of the SQL database
/// enum InstanceHost {
/// UNDEFINED = 0;
/// SELF_HOSTED = 1;
/// CLOUD_SQL = 2;
/// AMAZON_RDS = 3;
/// AZURE_SQL = 4;
/// }
/// Host of the enclousing database instance.
#[prost(string, tag = "3")]
pub instance_host: ::prost::alloc::string::String,
}
/// Specification that applies to
/// entries that are part `LOOKER` system
/// (user_specified_type)
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LookerSystemSpec {
/// ID of the parent Looker Instance. Empty if it does not exist.
/// Example value: `someinstance.looker.com`
#[prost(string, tag = "1")]
pub parent_instance_id: ::prost::alloc::string::String,
/// Name of the parent Looker Instance. Empty if it does not exist.
#[prost(string, tag = "2")]
pub parent_instance_display_name: ::prost::alloc::string::String,
/// ID of the parent Model. Empty if it does not exist.
#[prost(string, tag = "3")]
pub parent_model_id: ::prost::alloc::string::String,
/// Name of the parent Model. Empty if it does not exist.
#[prost(string, tag = "4")]
pub parent_model_display_name: ::prost::alloc::string::String,
/// ID of the parent View. Empty if it does not exist.
#[prost(string, tag = "5")]
pub parent_view_id: ::prost::alloc::string::String,
/// Name of the parent View. Empty if it does not exist.
#[prost(string, tag = "6")]
pub parent_view_display_name: ::prost::alloc::string::String,
}
/// Specification that applies to
/// all entries that are part of `CLOUD_BIGTABLE` system
/// (user_specified_type)
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CloudBigtableSystemSpec {
/// Display name of the Instance. This is user specified and different from
/// the resource name.
#[prost(string, tag = "1")]
pub instance_display_name: ::prost::alloc::string::String,
}
/// Specification that applies to Instance
/// entries that are part of `CLOUD_BIGTABLE` system.
/// (user_specified_type)
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CloudBigtableInstanceSpec {
/// The list of clusters for the Instance.
#[prost(message, repeated, tag = "1")]
pub cloud_bigtable_cluster_specs: ::prost::alloc::vec::Vec<
cloud_bigtable_instance_spec::CloudBigtableClusterSpec,
>,
}
/// Nested message and enum types in `CloudBigtableInstanceSpec`.
pub mod cloud_bigtable_instance_spec {
/// Spec that applies to clusters of an Instance of Cloud Bigtable.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CloudBigtableClusterSpec {
/// Name of the cluster.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
/// Location of the cluster, typically a Cloud zone.
#[prost(string, tag = "2")]
pub location: ::prost::alloc::string::String,
/// Type of the resource. For a cluster this would be "CLUSTER".
#[prost(string, tag = "3")]
pub r#type: ::prost::alloc::string::String,
/// A link back to the parent resource, in this case Instance.
#[prost(string, tag = "4")]
pub linked_resource: ::prost::alloc::string::String,
}
}
/// Specification that applies to a Service resource. Valid only
/// for entries with the `SERVICE` type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ServiceSpec {
/// System spec
#[prost(oneof = "service_spec::SystemSpec", tags = "1")]
pub system_spec: ::core::option::Option<service_spec::SystemSpec>,
}
/// Nested message and enum types in `ServiceSpec`.
pub mod service_spec {
/// System spec
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SystemSpec {
/// Specification that applies to Instance entries of `CLOUD_BIGTABLE`
/// system.
#[prost(message, tag = "1")]
CloudBigtableInstanceSpec(super::CloudBigtableInstanceSpec),
}
}
/// Detail description of the source information of a Vertex model.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct VertexModelSourceInfo {
/// Type of the model source.
#[prost(enumeration = "vertex_model_source_info::ModelSourceType", tag = "1")]
pub source_type: i32,
/// If this Model is copy of another Model. If true then
/// [source_type][google.cloud.datacatalog.v1.VertexModelSourceInfo.source_type]
/// pertains to the original.
#[prost(bool, tag = "2")]
pub copy: bool,
}
/// Nested message and enum types in `VertexModelSourceInfo`.
pub mod vertex_model_source_info {
/// Source of the model.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ModelSourceType {
/// Should not be used.
Unspecified = 0,
/// The Model is uploaded by automl training pipeline.
Automl = 1,
/// The Model is uploaded by user or custom training pipeline.
Custom = 2,
/// The Model is registered and sync'ed from BigQuery ML.
Bqml = 3,
/// The Model is saved or tuned from Model Garden.
ModelGarden = 4,
}
impl ModelSourceType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ModelSourceType::Unspecified => "MODEL_SOURCE_TYPE_UNSPECIFIED",
ModelSourceType::Automl => "AUTOML",
ModelSourceType::Custom => "CUSTOM",
ModelSourceType::Bqml => "BQML",
ModelSourceType::ModelGarden => "MODEL_GARDEN",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MODEL_SOURCE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"AUTOML" => Some(Self::Automl),
"CUSTOM" => Some(Self::Custom),
"BQML" => Some(Self::Bqml),
"MODEL_GARDEN" => Some(Self::ModelGarden),
_ => None,
}
}
}
}
/// Specification for vertex model resources.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VertexModelSpec {
/// The version ID of the model.
#[prost(string, tag = "1")]
pub version_id: ::prost::alloc::string::String,
/// User provided version aliases so that a model version can be referenced via
/// alias
#[prost(string, repeated, tag = "2")]
pub version_aliases: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The description of this version.
#[prost(string, tag = "3")]
pub version_description: ::prost::alloc::string::String,
/// Source of a Vertex model.
#[prost(message, optional, tag = "4")]
pub vertex_model_source_info: ::core::option::Option<VertexModelSourceInfo>,
/// URI of the Docker image to be used as the custom container for serving
/// predictions.
#[prost(string, tag = "5")]
pub container_image_uri: ::prost::alloc::string::String,
}
/// Specification for vertex dataset resources.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct VertexDatasetSpec {
/// The number of DataItems in this Dataset. Only apply for non-structured
/// Dataset.
#[prost(int64, tag = "1")]
pub data_item_count: i64,
/// Type of the dataset.
#[prost(enumeration = "vertex_dataset_spec::DataType", tag = "2")]
pub data_type: i32,
}
/// Nested message and enum types in `VertexDatasetSpec`.
pub mod vertex_dataset_spec {
/// Type of data stored in the dataset.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DataType {
/// Should not be used.
Unspecified = 0,
/// Structured data dataset.
Table = 1,
/// Image dataset which supports ImageClassification, ImageObjectDetection
/// and ImageSegmentation problems.
Image = 2,
/// Document dataset which supports TextClassification, TextExtraction and
/// TextSentiment problems.
Text = 3,
/// Video dataset which supports VideoClassification, VideoObjectTracking and
/// VideoActionRecognition problems.
Video = 4,
/// Conversation dataset which supports conversation problems.
Conversation = 5,
/// TimeSeries dataset.
TimeSeries = 6,
/// Document dataset which supports DocumentAnnotation problems.
Document = 7,
/// TextToSpeech dataset which supports TextToSpeech problems.
TextToSpeech = 8,
/// Translation dataset which supports Translation problems.
Translation = 9,
/// Store Vision dataset which is used for HITL integration.
StoreVision = 10,
/// Enterprise Knowledge Graph dataset which is used for HITL labeling
/// integration.
EnterpriseKnowledgeGraph = 11,
/// Text prompt dataset which supports Large Language Models.
TextPrompt = 12,
}
impl DataType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
DataType::Unspecified => "DATA_TYPE_UNSPECIFIED",
DataType::Table => "TABLE",
DataType::Image => "IMAGE",
DataType::Text => "TEXT",
DataType::Video => "VIDEO",
DataType::Conversation => "CONVERSATION",
DataType::TimeSeries => "TIME_SERIES",
DataType::Document => "DOCUMENT",
DataType::TextToSpeech => "TEXT_TO_SPEECH",
DataType::Translation => "TRANSLATION",
DataType::StoreVision => "STORE_VISION",
DataType::EnterpriseKnowledgeGraph => "ENTERPRISE_KNOWLEDGE_GRAPH",
DataType::TextPrompt => "TEXT_PROMPT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DATA_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"TABLE" => Some(Self::Table),
"IMAGE" => Some(Self::Image),
"TEXT" => Some(Self::Text),
"VIDEO" => Some(Self::Video),
"CONVERSATION" => Some(Self::Conversation),
"TIME_SERIES" => Some(Self::TimeSeries),
"DOCUMENT" => Some(Self::Document),
"TEXT_TO_SPEECH" => Some(Self::TextToSpeech),
"TRANSLATION" => Some(Self::Translation),
"STORE_VISION" => Some(Self::StoreVision),
"ENTERPRISE_KNOWLEDGE_GRAPH" => Some(Self::EnterpriseKnowledgeGraph),
"TEXT_PROMPT" => Some(Self::TextPrompt),
_ => None,
}
}
}
}
/// Specification that applies to a model. Valid only for
/// entries with the `MODEL` type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelSpec {
/// System spec
#[prost(oneof = "model_spec::SystemSpec", tags = "1")]
pub system_spec: ::core::option::Option<model_spec::SystemSpec>,
}
/// Nested message and enum types in `ModelSpec`.
pub mod model_spec {
/// System spec
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SystemSpec {
/// Specification for vertex model resources.
#[prost(message, tag = "1")]
VertexModelSpec(super::VertexModelSpec),
}
}
/// Business Context of the entry.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BusinessContext {
/// Entry overview fields for rich text descriptions of entries.
#[prost(message, optional, tag = "1")]
pub entry_overview: ::core::option::Option<EntryOverview>,
/// Contact people for the entry.
#[prost(message, optional, tag = "2")]
pub contacts: ::core::option::Option<Contacts>,
}
/// Entry overview fields for rich text descriptions of entries.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EntryOverview {
/// Entry overview with support for rich text.
///
/// The overview must only contain Unicode characters, and should be
/// formatted using HTML.
/// The maximum length is 10 MiB as this value holds HTML descriptions
/// including encoded images. The maximum length of the text without images
/// is 100 KiB.
#[prost(string, tag = "1")]
pub overview: ::prost::alloc::string::String,
}
/// Contact people for the entry.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Contacts {
/// The list of contact people for the entry.
#[prost(message, repeated, tag = "1")]
pub people: ::prost::alloc::vec::Vec<contacts::Person>,
}
/// Nested message and enum types in `Contacts`.
pub mod contacts {
/// A contact person for the entry.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Person {
/// Designation of the person, for example, Data Steward.
#[prost(string, tag = "1")]
pub designation: ::prost::alloc::string::String,
/// Email of the person in the format of `john.doe@xyz`,
/// `<john.doe@xyz>`, or `John Doe<john.doe@xyz>`.
#[prost(string, tag = "2")]
pub email: ::prost::alloc::string::String,
}
}
/// Entry group metadata.
///
/// An `EntryGroup` resource represents a logical grouping of zero or more
/// Data Catalog [Entry][google.cloud.datacatalog.v1.Entry] resources.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EntryGroup {
/// The resource name of the entry group in URL format.
///
/// Note: The entry group itself and its child resources might not be
/// stored in the location specified in its name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// A short name to identify the entry group, for example,
/// "analytics data - jan 2011". Default value is an empty string.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Entry group description. Can consist of several sentences or
/// paragraphs that describe the entry group contents.
/// Default value is an empty string.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. Timestamps of the entry group. Default value is empty.
#[prost(message, optional, tag = "4")]
pub data_catalog_timestamps: ::core::option::Option<SystemTimestamps>,
}
/// Request message for
/// [CreateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTagTemplateRequest {
/// Required. The name of the project and the template location
/// [region](<https://cloud.google.com/data-catalog/docs/concepts/regions>).
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ID of the tag template to create.
///
/// The ID must contain only lowercase letters (a-z), numbers (0-9),
/// or underscores (_), and must start with a letter or underscore.
/// The maximum size is 64 bytes when encoded in UTF-8.
#[prost(string, tag = "3")]
pub tag_template_id: ::prost::alloc::string::String,
/// Required. The tag template to create.
#[prost(message, optional, tag = "2")]
pub tag_template: ::core::option::Option<TagTemplate>,
}
/// Request message for
/// [GetTagTemplate][google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTagTemplateRequest {
/// Required. The name of the tag template to get.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [UpdateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTagTemplateRequest {
/// Required. The template to update. The `name` field must be set.
#[prost(message, optional, tag = "1")]
pub tag_template: ::core::option::Option<TagTemplate>,
/// Names of fields whose values to overwrite on a tag template. Currently,
/// only `display_name` and `is_publicly_readable` can be overwritten.
///
/// If this parameter is absent or empty, all modifiable fields
/// are overwritten. If such fields are non-required and omitted in the
/// request body, their values are emptied.
///
/// Note: Updating the `is_publicly_readable` field may require up to 12
/// hours to take effect in search results.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DeleteTagTemplate][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTagTemplateRequest {
/// Required. The name of the tag template to delete.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. If true, deletes all tags that use this template.
///
/// Currently, `true` is the only supported value.
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [CreateTag][google.cloud.datacatalog.v1.DataCatalog.CreateTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTagRequest {
/// Required. The name of the resource to attach this tag to.
///
/// Tags can be attached to entries or entry groups. An entry can have up to
/// 1000 attached tags.
///
/// Note: The tag and its child resources might not be stored in
/// the location specified in its name.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The tag to create.
#[prost(message, optional, tag = "2")]
pub tag: ::core::option::Option<Tag>,
}
/// Request message for
/// [UpdateTag][google.cloud.datacatalog.v1.DataCatalog.UpdateTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTagRequest {
/// Required. The updated tag. The "name" field must be set.
#[prost(message, optional, tag = "1")]
pub tag: ::core::option::Option<Tag>,
/// Names of fields whose values to overwrite on a tag. Currently, a tag has
/// the only modifiable field with the name `fields`.
///
/// In general, if this parameter is absent or empty, all modifiable fields
/// are overwritten. If such fields are non-required and omitted in the
/// request body, their values are emptied.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DeleteTag][google.cloud.datacatalog.v1.DataCatalog.DeleteTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTagRequest {
/// Required. The name of the tag to delete.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [CreateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTagTemplateFieldRequest {
/// Required. The name of the project and the template location
/// [region](<https://cloud.google.com/data-catalog/docs/concepts/regions>).
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ID of the tag template field to create.
///
/// Note: Adding a required field to an existing template is *not* allowed.
///
/// Field IDs can contain letters (both uppercase and lowercase), numbers
/// (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
/// character long and at most 128 characters long. Field IDs must also be
/// unique within their template.
#[prost(string, tag = "2")]
pub tag_template_field_id: ::prost::alloc::string::String,
/// Required. The tag template field to create.
#[prost(message, optional, tag = "3")]
pub tag_template_field: ::core::option::Option<TagTemplateField>,
}
/// Request message for
/// [UpdateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTagTemplateFieldRequest {
/// Required. The name of the tag template field.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The template to update.
#[prost(message, optional, tag = "2")]
pub tag_template_field: ::core::option::Option<TagTemplateField>,
/// Optional. Names of fields whose values to overwrite on an individual field
/// of a tag template. The following fields are modifiable:
///
/// * `display_name`
/// * `type.enum_type`
/// * `is_required`
///
/// If this parameter is absent or empty, all modifiable fields
/// are overwritten. If such fields are non-required and omitted in the request
/// body, their values are emptied with one exception: when updating an enum
/// type, the provided values are merged with the existing values. Therefore,
/// enum values can only be added, existing enum values cannot be deleted or
/// renamed.
///
/// Additionally, updating a template field from optional to required is
/// *not* allowed.
#[prost(message, optional, tag = "3")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [RenameTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RenameTagTemplateFieldRequest {
/// Required. The name of the tag template field.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The new ID of this tag template field. For example,
/// `my_new_field`.
#[prost(string, tag = "2")]
pub new_tag_template_field_id: ::prost::alloc::string::String,
}
/// Request message for
/// [RenameTagTemplateFieldEnumValue][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RenameTagTemplateFieldEnumValueRequest {
/// Required. The name of the enum field value.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The new display name of the enum value. For example,
/// `my_new_enum_value`.
#[prost(string, tag = "2")]
pub new_enum_value_display_name: ::prost::alloc::string::String,
}
/// Request message for
/// [DeleteTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTagTemplateFieldRequest {
/// Required. The name of the tag template field to delete.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. If true, deletes this field from any tags that use it.
///
/// Currently, `true` is the only supported value.
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTagsRequest {
/// Required. The name of the Data Catalog resource to list the tags of.
///
/// The resource can be an [Entry][google.cloud.datacatalog.v1.Entry]
/// or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]
/// (without `/entries/{entries}` at the end).
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of tags to return. Default is 10. Maximum limit is 1000.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Pagination token that specifies the next page to return. If empty, the
/// first page is returned.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTagsResponse {
/// [Tag][google.cloud.datacatalog.v1.Tag] details.
#[prost(message, repeated, tag = "1")]
pub tags: ::prost::alloc::vec::Vec<Tag>,
/// Pagination token of the next results page. Empty if there are
/// no more items in results.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReconcileTagsRequest {
/// Required. Name of [Entry][google.cloud.datacatalog.v1.Entry] to be tagged.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The name of the tag template, which is used for reconciliation.
#[prost(string, tag = "2")]
pub tag_template: ::prost::alloc::string::String,
/// If set to `true`, deletes entry tags related to a tag template
/// not listed in the tags source from an entry. If set to `false`,
/// unlisted tags are retained.
#[prost(bool, tag = "3")]
pub force_delete_missing: bool,
/// A list of tags to apply to an entry. A tag can specify a
/// tag template, which must be the template specified in the
/// `ReconcileTagsRequest`.
/// The sole entry and each of its columns must be mentioned at most once.
#[prost(message, repeated, tag = "4")]
pub tags: ::prost::alloc::vec::Vec<Tag>,
}
/// [Long-running operation][google.longrunning.Operation]
/// response message returned by
/// [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ReconcileTagsResponse {
/// Number of tags created in the request.
#[prost(int64, tag = "1")]
pub created_tags_count: i64,
/// Number of tags updated in the request.
#[prost(int64, tag = "2")]
pub updated_tags_count: i64,
/// Number of tags deleted in the request.
#[prost(int64, tag = "3")]
pub deleted_tags_count: i64,
}
/// [Long-running operation][google.longrunning.Operation]
/// metadata message returned by the
/// [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReconcileTagsMetadata {
/// State of the reconciliation operation.
#[prost(enumeration = "reconcile_tags_metadata::ReconciliationState", tag = "1")]
pub state: i32,
/// Maps the name of each tagged column (or empty string for a
/// sole entry) to tagging operation [status][google.rpc.Status].
#[prost(btree_map = "string, message", tag = "2")]
pub errors: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
super::super::super::rpc::Status,
>,
}
/// Nested message and enum types in `ReconcileTagsMetadata`.
pub mod reconcile_tags_metadata {
/// Enum holding possible states of the reconciliation operation.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ReconciliationState {
/// Default value. This value is unused.
Unspecified = 0,
/// The reconciliation has been queued and awaits for execution.
ReconciliationQueued = 1,
/// The reconciliation is in progress.
ReconciliationInProgress = 2,
/// The reconciliation has been finished.
ReconciliationDone = 3,
}
impl ReconciliationState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ReconciliationState::Unspecified => "RECONCILIATION_STATE_UNSPECIFIED",
ReconciliationState::ReconciliationQueued => "RECONCILIATION_QUEUED",
ReconciliationState::ReconciliationInProgress => {
"RECONCILIATION_IN_PROGRESS"
}
ReconciliationState::ReconciliationDone => "RECONCILIATION_DONE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RECONCILIATION_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"RECONCILIATION_QUEUED" => Some(Self::ReconciliationQueued),
"RECONCILIATION_IN_PROGRESS" => Some(Self::ReconciliationInProgress),
"RECONCILIATION_DONE" => Some(Self::ReconciliationDone),
_ => None,
}
}
}
}
/// Request message for
/// [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntriesRequest {
/// Required. The name of the entry group that contains the entries to list.
///
/// Can be provided in URL format.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of items to return. Default is 10. Maximum limit is
/// 1000. Throws an invalid argument if `page_size` is more than 1000.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Pagination token that specifies the next page to return. If empty, the
/// first page is returned.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// The fields to return for each entry. If empty or omitted, all
/// fields are returned.
///
/// For example, to return a list of entries with only the `name` field,
/// set `read_mask` to only one path with the `name` value.
#[prost(message, optional, tag = "4")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntriesResponse {
/// Entry details.
#[prost(message, repeated, tag = "1")]
pub entries: ::prost::alloc::vec::Vec<Entry>,
/// Pagination token of the next results page. Empty if there are no more items
/// in results.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [StarEntry][google.cloud.datacatalog.v1.DataCatalog.StarEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StarEntryRequest {
/// Required. The name of the entry to mark as starred.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Response message for
/// [StarEntry][google.cloud.datacatalog.v1.DataCatalog.StarEntry].
/// Empty for now
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct StarEntryResponse {}
/// Request message for
/// [UnstarEntry][google.cloud.datacatalog.v1.DataCatalog.UnstarEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UnstarEntryRequest {
/// Required. The name of the entry to mark as **not** starred.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Response message for
/// [UnstarEntry][google.cloud.datacatalog.v1.DataCatalog.UnstarEntry].
/// Empty for now
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UnstarEntryResponse {}
/// Request message for
/// [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries]
/// method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportEntriesRequest {
/// Required. Target entry group for ingested entries.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. (Optional) Dataplex task job id, if specified will be used as
/// part of ImportEntries LRO ID
#[prost(string, tag = "3")]
pub job_id: ::prost::alloc::string::String,
/// Source of imported entries, e.g. dump stored in a Cloud Storage
#[prost(oneof = "import_entries_request::Source", tags = "2")]
pub source: ::core::option::Option<import_entries_request::Source>,
}
/// Nested message and enum types in `ImportEntriesRequest`.
pub mod import_entries_request {
/// Source of imported entries, e.g. dump stored in a Cloud Storage
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// Path to a Cloud Storage bucket that contains a dump ready for ingestion.
#[prost(string, tag = "2")]
GcsBucketPath(::prost::alloc::string::String),
}
}
/// Response message for [long-running operation][google.longrunning.Operation]
/// returned by the
/// [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ImportEntriesResponse {
/// Cumulative number of entries created and entries updated as a result of
/// import operation.
#[prost(int64, optional, tag = "5")]
pub upserted_entries_count: ::core::option::Option<i64>,
/// Number of entries deleted as a result of import operation.
#[prost(int64, optional, tag = "6")]
pub deleted_entries_count: ::core::option::Option<i64>,
}
/// Metadata message for [long-running operation][google.longrunning.Operation]
/// returned by the
/// [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportEntriesMetadata {
/// State of the import operation.
#[prost(enumeration = "import_entries_metadata::ImportState", tag = "1")]
pub state: i32,
/// Partial errors that are encountered during the ImportEntries operation.
/// There is no guarantee that all the encountered errors are reported.
/// However, if no errors are reported, it means that no errors were
/// encountered.
#[prost(message, repeated, tag = "2")]
pub errors: ::prost::alloc::vec::Vec<super::super::super::rpc::Status>,
}
/// Nested message and enum types in `ImportEntriesMetadata`.
pub mod import_entries_metadata {
/// Enum holding possible states of the import operation.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ImportState {
/// Default value. This value is unused.
Unspecified = 0,
/// The dump with entries has been queued for import.
ImportQueued = 1,
/// The import of entries is in progress.
ImportInProgress = 2,
/// The import of entries has been finished.
ImportDone = 3,
/// The import of entries has been abandoned in favor of a newer request.
ImportObsolete = 4,
}
impl ImportState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ImportState::Unspecified => "IMPORT_STATE_UNSPECIFIED",
ImportState::ImportQueued => "IMPORT_QUEUED",
ImportState::ImportInProgress => "IMPORT_IN_PROGRESS",
ImportState::ImportDone => "IMPORT_DONE",
ImportState::ImportObsolete => "IMPORT_OBSOLETE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"IMPORT_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"IMPORT_QUEUED" => Some(Self::ImportQueued),
"IMPORT_IN_PROGRESS" => Some(Self::ImportInProgress),
"IMPORT_DONE" => Some(Self::ImportDone),
"IMPORT_OBSOLETE" => Some(Self::ImportObsolete),
_ => None,
}
}
}
}
/// Request message for
/// [ModifyEntryOverview][google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverview].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyEntryOverviewRequest {
/// Required. The full resource name of the entry.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The new value for the Entry Overview.
#[prost(message, optional, tag = "2")]
pub entry_overview: ::core::option::Option<EntryOverview>,
}
/// Request message for
/// [ModifyEntryContacts][google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContacts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyEntryContactsRequest {
/// Required. The full resource name of the entry.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The new value for the Contacts.
#[prost(message, optional, tag = "2")]
pub contacts: ::core::option::Option<Contacts>,
}
/// Metadata automatically ingested from Google Cloud resources like BigQuery
/// tables or Pub/Sub topics always uses enum values from `EntryType` as the type
/// of entry.
///
/// Other sources of metadata like Hive or Oracle databases can identify the type
/// by either using one of the enum values from `EntryType` (for example,
/// `FILESET` for a Cloud Storage fileset) or specifying a custom value using
/// the [`Entry`](#resource:-entry) field `user_specified_type`. For more
/// information, see
/// [Surface files from Cloud Storage with fileset
/// entries](/data-catalog/docs/how-to/filesets) or [Create custom entries for
/// your data sources](/data-catalog/docs/how-to/custom-entries).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum EntryType {
/// Default unknown type.
Unspecified = 0,
/// The entry type that has a GoogleSQL schema, including
/// logical views.
Table = 2,
/// The type of models.
///
/// For more information, see [Supported models in BigQuery
/// ML](/bigquery/docs/bqml-introduction#supported_models).
Model = 5,
/// An entry type for streaming entries. For example, a Pub/Sub topic.
DataStream = 3,
/// An entry type for a set of files or objects. For example, a
/// Cloud Storage fileset.
Fileset = 4,
/// A group of servers that work together. For example, a Kafka cluster.
Cluster = 6,
/// A database.
Database = 7,
/// Connection to a data source. For example, a BigQuery
/// connection.
DataSourceConnection = 8,
/// Routine, for example, a BigQuery routine.
Routine = 9,
/// A Dataplex lake.
Lake = 10,
/// A Dataplex zone.
Zone = 11,
/// A service, for example, a Dataproc Metastore service.
Service = 14,
/// Schema within a relational database.
DatabaseSchema = 15,
/// A Dashboard, for example from Looker.
Dashboard = 16,
/// A Looker Explore.
///
/// For more information, see \[Looker Explore API\]
/// (<https://developers.looker.com/api/explorer/4.0/methods/LookmlModel/lookml_model_explore>).
Explore = 17,
/// A Looker Look.
///
/// For more information, see \[Looker Look API\]
/// (<https://developers.looker.com/api/explorer/4.0/methods/Look>).
Look = 18,
}
impl EntryType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
EntryType::Unspecified => "ENTRY_TYPE_UNSPECIFIED",
EntryType::Table => "TABLE",
EntryType::Model => "MODEL",
EntryType::DataStream => "DATA_STREAM",
EntryType::Fileset => "FILESET",
EntryType::Cluster => "CLUSTER",
EntryType::Database => "DATABASE",
EntryType::DataSourceConnection => "DATA_SOURCE_CONNECTION",
EntryType::Routine => "ROUTINE",
EntryType::Lake => "LAKE",
EntryType::Zone => "ZONE",
EntryType::Service => "SERVICE",
EntryType::DatabaseSchema => "DATABASE_SCHEMA",
EntryType::Dashboard => "DASHBOARD",
EntryType::Explore => "EXPLORE",
EntryType::Look => "LOOK",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ENTRY_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"TABLE" => Some(Self::Table),
"MODEL" => Some(Self::Model),
"DATA_STREAM" => Some(Self::DataStream),
"FILESET" => Some(Self::Fileset),
"CLUSTER" => Some(Self::Cluster),
"DATABASE" => Some(Self::Database),
"DATA_SOURCE_CONNECTION" => Some(Self::DataSourceConnection),
"ROUTINE" => Some(Self::Routine),
"LAKE" => Some(Self::Lake),
"ZONE" => Some(Self::Zone),
"SERVICE" => Some(Self::Service),
"DATABASE_SCHEMA" => Some(Self::DatabaseSchema),
"DASHBOARD" => Some(Self::Dashboard),
"EXPLORE" => Some(Self::Explore),
"LOOK" => Some(Self::Look),
_ => None,
}
}
}
/// Generated client implementations.
pub mod data_catalog_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Data Catalog API service allows you to discover, understand, and manage
/// your data.
#[derive(Debug, Clone)]
pub struct DataCatalogClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> DataCatalogClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> DataCatalogClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
DataCatalogClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Searches Data Catalog for multiple resources like entries and tags that
/// match a query.
///
/// This is a [Custom Method]
/// (https://cloud.google.com/apis/design/custom_methods) that doesn't return
/// all information on a resource, only its ID and high level fields. To get
/// more information, you can subsequently call specific get methods.
///
/// Note: Data Catalog search queries don't guarantee full recall. Results
/// that match your query might not be returned, even in subsequent
/// result pages. Additionally, returned (and not returned) results can vary
/// if you repeat search queries.
///
/// For more information, see [Data Catalog search syntax]
/// (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
pub async fn search_catalog(
&mut self,
request: impl tonic::IntoRequest<super::SearchCatalogRequest>,
) -> std::result::Result<
tonic::Response<super::SearchCatalogResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/SearchCatalog",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"SearchCatalog",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an entry group.
///
/// An entry group contains logically related entries together with [Cloud
/// Identity and Access Management](/data-catalog/docs/concepts/iam) policies.
/// These policies specify users who can create, edit, and view entries
/// within entry groups.
///
/// Data Catalog automatically creates entry groups with names that start with
/// the `@` symbol for the following resources:
///
/// * BigQuery entries (`@bigquery`)
/// * Pub/Sub topics (`@pubsub`)
/// * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`)
///
/// You can create your own entry groups for Cloud Storage fileset entries
/// and custom entries together with the corresponding IAM policies.
/// User-created entry groups can't contain the `@` symbol, it is reserved
/// for automatically created groups.
///
/// Entry groups, like entries, can be searched.
///
/// A maximum of 10,000 entry groups may be created per organization across all
/// locations.
///
/// You must enable the Data Catalog API in the project identified by
/// the `parent` parameter. For more information, see [Data Catalog resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn create_entry_group(
&mut self,
request: impl tonic::IntoRequest<super::CreateEntryGroupRequest>,
) -> std::result::Result<tonic::Response<super::EntryGroup>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/CreateEntryGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"CreateEntryGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets an entry group.
pub async fn get_entry_group(
&mut self,
request: impl tonic::IntoRequest<super::GetEntryGroupRequest>,
) -> std::result::Result<tonic::Response<super::EntryGroup>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/GetEntryGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"GetEntryGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an entry group.
///
/// You must enable the Data Catalog API in the project identified by
/// the `entry_group.name` parameter. For more information, see [Data Catalog
/// resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn update_entry_group(
&mut self,
request: impl tonic::IntoRequest<super::UpdateEntryGroupRequest>,
) -> std::result::Result<tonic::Response<super::EntryGroup>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/UpdateEntryGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"UpdateEntryGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an entry group.
///
/// You must enable the Data Catalog API in the project
/// identified by the `name` parameter. For more information, see [Data Catalog
/// resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn delete_entry_group(
&mut self,
request: impl tonic::IntoRequest<super::DeleteEntryGroupRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/DeleteEntryGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"DeleteEntryGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists entry groups.
pub async fn list_entry_groups(
&mut self,
request: impl tonic::IntoRequest<super::ListEntryGroupsRequest>,
) -> std::result::Result<
tonic::Response<super::ListEntryGroupsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/ListEntryGroups",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"ListEntryGroups",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an entry.
///
/// You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM',
/// or custom types. Data Catalog automatically creates entries with other
/// types during metadata ingestion from integrated systems.
///
/// You must enable the Data Catalog API in the project identified by
/// the `parent` parameter. For more information, see [Data Catalog resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
///
/// An entry group can have a maximum of 100,000 entries.
pub async fn create_entry(
&mut self,
request: impl tonic::IntoRequest<super::CreateEntryRequest>,
) -> std::result::Result<tonic::Response<super::Entry>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/CreateEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"CreateEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an existing entry.
///
/// You must enable the Data Catalog API in the project identified by
/// the `entry.name` parameter. For more information, see [Data Catalog
/// resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn update_entry(
&mut self,
request: impl tonic::IntoRequest<super::UpdateEntryRequest>,
) -> std::result::Result<tonic::Response<super::Entry>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/UpdateEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"UpdateEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an existing entry.
///
/// You can delete only the entries created by the
/// [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry]
/// method.
///
/// You must enable the Data Catalog API in the project identified by
/// the `name` parameter. For more information, see [Data Catalog
/// resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn delete_entry(
&mut self,
request: impl tonic::IntoRequest<super::DeleteEntryRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/DeleteEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"DeleteEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets an entry.
pub async fn get_entry(
&mut self,
request: impl tonic::IntoRequest<super::GetEntryRequest>,
) -> std::result::Result<tonic::Response<super::Entry>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/GetEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"GetEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets an entry by its target resource name.
///
/// The resource name comes from the source Google Cloud Platform service.
pub async fn lookup_entry(
&mut self,
request: impl tonic::IntoRequest<super::LookupEntryRequest>,
) -> std::result::Result<tonic::Response<super::Entry>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/LookupEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"LookupEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists entries.
///
/// Note: Currently, this method can list only custom entries.
/// To get a list of both custom and automatically created entries, use
/// [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
pub async fn list_entries(
&mut self,
request: impl tonic::IntoRequest<super::ListEntriesRequest>,
) -> std::result::Result<
tonic::Response<super::ListEntriesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/ListEntries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"ListEntries",
),
);
self.inner.unary(req, path, codec).await
}
/// Modifies entry overview, part of the business context of an
/// [Entry][google.cloud.datacatalog.v1.Entry].
///
/// To call this method, you must have the `datacatalog.entries.updateOverview`
/// IAM permission on the corresponding project.
pub async fn modify_entry_overview(
&mut self,
request: impl tonic::IntoRequest<super::ModifyEntryOverviewRequest>,
) -> std::result::Result<tonic::Response<super::EntryOverview>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/ModifyEntryOverview",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"ModifyEntryOverview",
),
);
self.inner.unary(req, path, codec).await
}
/// Modifies contacts, part of the business context of an
/// [Entry][google.cloud.datacatalog.v1.Entry].
///
/// To call this method, you must have the `datacatalog.entries.updateContacts`
/// IAM permission on the corresponding project.
pub async fn modify_entry_contacts(
&mut self,
request: impl tonic::IntoRequest<super::ModifyEntryContactsRequest>,
) -> std::result::Result<tonic::Response<super::Contacts>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/ModifyEntryContacts",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"ModifyEntryContacts",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a tag template.
///
/// You must enable the Data Catalog API in the project identified by the
/// `parent` parameter.
/// For more information, see [Data Catalog resource project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn create_tag_template(
&mut self,
request: impl tonic::IntoRequest<super::CreateTagTemplateRequest>,
) -> std::result::Result<tonic::Response<super::TagTemplate>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/CreateTagTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"CreateTagTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a tag template.
pub async fn get_tag_template(
&mut self,
request: impl tonic::IntoRequest<super::GetTagTemplateRequest>,
) -> std::result::Result<tonic::Response<super::TagTemplate>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/GetTagTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"GetTagTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a tag template.
///
/// You can't update template fields with this method. These fields are
/// separate resources with their own create, update, and delete methods.
///
/// You must enable the Data Catalog API in the project identified by
/// the `tag_template.name` parameter. For more information, see [Data Catalog
/// resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn update_tag_template(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTagTemplateRequest>,
) -> std::result::Result<tonic::Response<super::TagTemplate>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/UpdateTagTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"UpdateTagTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a tag template and all tags that use it.
///
/// You must enable the Data Catalog API in the project identified by
/// the `name` parameter. For more information, see [Data Catalog resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn delete_tag_template(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTagTemplateRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/DeleteTagTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"DeleteTagTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a field in a tag template.
///
/// You must enable the Data Catalog API in the project identified by
/// the `parent` parameter. For more information, see [Data Catalog resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn create_tag_template_field(
&mut self,
request: impl tonic::IntoRequest<super::CreateTagTemplateFieldRequest>,
) -> std::result::Result<
tonic::Response<super::TagTemplateField>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/CreateTagTemplateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"CreateTagTemplateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a field in a tag template.
///
/// You can't update the field type with this method.
///
/// You must enable the Data Catalog API in the project
/// identified by the `name` parameter. For more information, see [Data Catalog
/// resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn update_tag_template_field(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTagTemplateFieldRequest>,
) -> std::result::Result<
tonic::Response<super::TagTemplateField>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/UpdateTagTemplateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"UpdateTagTemplateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Renames a field in a tag template.
///
/// You must enable the Data Catalog API in the project identified by the
/// `name` parameter. For more information, see [Data Catalog resource project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn rename_tag_template_field(
&mut self,
request: impl tonic::IntoRequest<super::RenameTagTemplateFieldRequest>,
) -> std::result::Result<
tonic::Response<super::TagTemplateField>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/RenameTagTemplateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"RenameTagTemplateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Renames an enum value in a tag template.
///
/// Within a single enum field, enum values must be unique.
pub async fn rename_tag_template_field_enum_value(
&mut self,
request: impl tonic::IntoRequest<
super::RenameTagTemplateFieldEnumValueRequest,
>,
) -> std::result::Result<
tonic::Response<super::TagTemplateField>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/RenameTagTemplateFieldEnumValue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"RenameTagTemplateFieldEnumValue",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a field in a tag template and all uses of this field from the tags
/// based on this template.
///
/// You must enable the Data Catalog API in the project identified by
/// the `name` parameter. For more information, see [Data Catalog resource
/// project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
pub async fn delete_tag_template_field(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTagTemplateFieldRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/DeleteTagTemplateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"DeleteTagTemplateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a tag and assigns it to:
///
/// * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
/// `projects.locations.entryGroups.entries.tags.create`.
/// * Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method
/// name is `projects.locations.entryGroups.tags.create`.
///
/// Note: The project identified by the `parent` parameter for the [tag]
/// (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
/// and the [tag template]
/// (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
/// used to create the tag must be in the same organization.
pub async fn create_tag(
&mut self,
request: impl tonic::IntoRequest<super::CreateTagRequest>,
) -> std::result::Result<tonic::Response<super::Tag>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/CreateTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"CreateTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an existing tag.
pub async fn update_tag(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTagRequest>,
) -> std::result::Result<tonic::Response<super::Tag>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/UpdateTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"UpdateTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a tag.
pub async fn delete_tag(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTagRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/DeleteTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"DeleteTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
/// The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are
/// lowercased.
pub async fn list_tags(
&mut self,
request: impl tonic::IntoRequest<super::ListTagsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTagsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/ListTags",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"ListTags",
),
);
self.inner.unary(req, path, codec).await
}
/// `ReconcileTags` creates or updates a list of tags on the entry.
/// If the
/// [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing]
/// parameter is set, the operation deletes tags not included in the input tag
/// list.
///
/// `ReconcileTags` returns a [long-running operation]
/// [google.longrunning.Operation] resource that can be queried with
/// [Operations.GetOperation][google.longrunning.Operations.GetOperation]
/// to return [ReconcileTagsMetadata]
/// [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and
/// a [ReconcileTagsResponse]
/// [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
pub async fn reconcile_tags(
&mut self,
request: impl tonic::IntoRequest<super::ReconcileTagsRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/ReconcileTags",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"ReconcileTags",
),
);
self.inner.unary(req, path, codec).await
}
/// Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by
/// the current user. Starring information is private to each user.
pub async fn star_entry(
&mut self,
request: impl tonic::IntoRequest<super::StarEntryRequest>,
) -> std::result::Result<
tonic::Response<super::StarEntryResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/StarEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"StarEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by
/// the current user. Starring information is private to each user.
pub async fn unstar_entry(
&mut self,
request: impl tonic::IntoRequest<super::UnstarEntryRequest>,
) -> std::result::Result<
tonic::Response<super::UnstarEntryResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/UnstarEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"UnstarEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Sets an access control policy for a resource. Replaces any existing
/// policy.
///
/// Supported resources are:
///
/// - Tag templates
/// - Entry groups
///
/// Note: This method sets policies only within Data Catalog and can't be
/// used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any
/// external Google Cloud Platform resources synced with the Data Catalog.
///
/// To call this method, you must have the following Google IAM permissions:
///
/// - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
/// templates.
/// - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
pub async fn set_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::SetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::iam::v1::Policy>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/SetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"SetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the access control policy for a resource.
///
/// May return:
///
/// * A`NOT_FOUND` error if the resource doesn't exist or you don't have the
/// permission to view it.
/// * An empty policy if the resource exists but doesn't have a set policy.
///
/// Supported resources are:
///
/// - Tag templates
/// - Entry groups
///
/// Note: This method doesn't get policies from Google Cloud Platform
/// resources ingested into Data Catalog.
///
/// To call this method, you must have the following Google IAM permissions:
///
/// - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
/// templates.
/// - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
pub async fn get_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::GetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::iam::v1::Policy>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/GetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"GetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets your permissions on a resource.
///
/// Returns an empty set of permissions if the resource doesn't exist.
///
/// Supported resources are:
///
/// - Tag templates
/// - Entry groups
///
/// Note: This method gets policies only within Data Catalog and can't be
/// used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any
/// external Google Cloud Platform resources ingested into Data Catalog.
///
/// No Google IAM permissions are required to call this method.
pub async fn test_iam_permissions(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::TestIamPermissionsRequest,
>,
) -> std::result::Result<
tonic::Response<
super::super::super::super::iam::v1::TestIamPermissionsResponse,
>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/TestIamPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"TestIamPermissions",
),
);
self.inner.unary(req, path, codec).await
}
/// Imports entries from a source, such as data previously dumped into a
/// Cloud Storage bucket, into Data Catalog. Import of entries
/// is a sync operation that reconciles the state of the third-party system
/// with the Data Catalog.
///
/// `ImportEntries` accepts source data snapshots of a third-party system.
/// Snapshot should be delivered as a .wire or base65-encoded .txt file
/// containing a sequence of Protocol Buffer messages of
/// [DumpItem][google.cloud.datacatalog.v1.DumpItem] type.
///
/// `ImportEntries` returns a [long-running operation]
/// [google.longrunning.Operation] resource that can be queried with
/// [Operations.GetOperation][google.longrunning.Operations.GetOperation]
/// to return
/// [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata]
/// and an
/// [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse]
/// message.
pub async fn import_entries(
&mut self,
request: impl tonic::IntoRequest<super::ImportEntriesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.DataCatalog/ImportEntries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.DataCatalog",
"ImportEntries",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Wrapper containing Entry and information about Tags
/// that should and should not be attached to it.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TaggedEntry {
/// Optional. Tags that should be ingested into the Data Catalog.
/// Caller should populate template name, column and fields.
#[prost(message, repeated, tag = "2")]
pub present_tags: ::prost::alloc::vec::Vec<Tag>,
/// Optional. Tags that should be deleted from the Data Catalog.
/// Caller should populate template name and column only.
#[prost(message, repeated, tag = "3")]
pub absent_tags: ::prost::alloc::vec::Vec<Tag>,
/// Required. Entry to be ingested.
#[prost(oneof = "tagged_entry::Entry", tags = "1")]
pub entry: ::core::option::Option<tagged_entry::Entry>,
}
/// Nested message and enum types in `TaggedEntry`.
pub mod tagged_entry {
/// Required. Entry to be ingested.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Entry {
/// Non-encrypted Data Catalog v1 Entry.
#[prost(message, tag = "1")]
V1Entry(super::Entry),
}
}
/// Wrapper for any item that can be contained in the dump.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DumpItem {
#[prost(oneof = "dump_item::Item", tags = "1")]
pub item: ::core::option::Option<dump_item::Item>,
}
/// Nested message and enum types in `DumpItem`.
pub mod dump_item {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Item {
/// Entry and its tags.
#[prost(message, tag = "1")]
TaggedEntry(super::TaggedEntry),
}
}
/// A taxonomy is a collection of hierarchical policy tags that classify data
/// along a common axis.
///
/// For example, a "data sensitivity" taxonomy might contain the following policy
/// tags:
///
/// ```
/// + PII
/// + Account number
/// + Age
/// + SSN
/// + Zipcode
/// + Financials
/// + Revenue
/// ```
///
/// A "data origin" taxonomy might contain the following policy tags:
///
/// ```
/// + User data
/// + Employee data
/// + Partner data
/// + Public data
/// ```
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Taxonomy {
/// Identifier. Resource name of this taxonomy in URL format.
///
/// Note: Policy tag manager generates unique taxonomy IDs.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. User-defined name of this taxonomy.
///
/// The name can't start or end with spaces, must contain only Unicode letters,
/// numbers, underscores, dashes, and spaces, and be at most 200 bytes long
/// when encoded in UTF-8.
///
/// The taxonomy display name must be unique within an organization.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Optional. Description of this taxonomy. If not set, defaults to empty.
///
/// The description must contain only Unicode characters, tabs, newlines,
/// carriage returns, and page breaks, and be at most 2000 bytes long when
/// encoded in UTF-8.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. Number of policy tags in this taxonomy.
#[prost(int32, tag = "4")]
pub policy_tag_count: i32,
/// Output only. Creation and modification timestamps of this taxonomy.
#[prost(message, optional, tag = "5")]
pub taxonomy_timestamps: ::core::option::Option<SystemTimestamps>,
/// Optional. A list of policy types that are activated for this taxonomy. If
/// not set, defaults to an empty list.
#[prost(enumeration = "taxonomy::PolicyType", repeated, packed = "false", tag = "6")]
pub activated_policy_types: ::prost::alloc::vec::Vec<i32>,
/// Output only. Identity of the service which owns the Taxonomy. This field is
/// only populated when the taxonomy is created by a Google Cloud service.
/// Currently only 'DATAPLEX' is supported.
#[prost(message, optional, tag = "7")]
pub service: ::core::option::Option<taxonomy::Service>,
}
/// Nested message and enum types in `Taxonomy`.
pub mod taxonomy {
/// The source system of the Taxonomy.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Service {
/// The Google Cloud service name.
#[prost(enumeration = "super::ManagingSystem", tag = "1")]
pub name: i32,
/// The service agent for the service.
#[prost(string, tag = "2")]
pub identity: ::prost::alloc::string::String,
}
/// Defines policy types where the policy tags can be used for.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum PolicyType {
/// Unspecified policy type.
Unspecified = 0,
/// Fine-grained access control policy that enables access control on
/// tagged sub-resources.
FineGrainedAccessControl = 1,
}
impl PolicyType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PolicyType::Unspecified => "POLICY_TYPE_UNSPECIFIED",
PolicyType::FineGrainedAccessControl => "FINE_GRAINED_ACCESS_CONTROL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"POLICY_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"FINE_GRAINED_ACCESS_CONTROL" => Some(Self::FineGrainedAccessControl),
_ => None,
}
}
}
}
/// Denotes one policy tag in a taxonomy, for example, SSN.
///
/// Policy tags can be defined in a hierarchy. For example:
///
/// ```
/// + Geolocation
/// + LatLong
/// + City
/// + ZipCode
/// ```
///
/// Where the "Geolocation" policy tag contains three children.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PolicyTag {
/// Identifier. Resource name of this policy tag in the URL format.
///
/// The policy tag manager generates unique taxonomy IDs and policy tag IDs.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. User-defined name of this policy tag.
///
/// The name can't start or end with spaces and must be unique within the
/// parent taxonomy, contain only Unicode letters, numbers, underscores, dashes
/// and spaces, and be at most 200 bytes long when encoded in UTF-8.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Description of this policy tag. If not set, defaults to empty.
///
/// The description must contain only Unicode characters,
/// tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes
/// long when encoded in UTF-8.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Resource name of this policy tag's parent policy tag. If empty, this is a
/// top level tag. If not set, defaults to an empty string.
///
/// For example, for the "LatLong" policy tag in the example above, this field
/// contains the resource name of the "Geolocation" policy tag, and, for
/// "Geolocation", this field is empty.
#[prost(string, tag = "4")]
pub parent_policy_tag: ::prost::alloc::string::String,
/// Output only. Resource names of child policy tags of this policy tag.
#[prost(string, repeated, tag = "5")]
pub child_policy_tags: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request message for
/// [CreateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTaxonomyRequest {
/// Required. Resource name of the project that the taxonomy will belong to.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The taxonomy to create.
#[prost(message, optional, tag = "2")]
pub taxonomy: ::core::option::Option<Taxonomy>,
}
/// Request message for
/// [DeleteTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTaxonomyRequest {
/// Required. Resource name of the taxonomy to delete.
///
/// Note: All policy tags in this taxonomy are also deleted.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [UpdateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTaxonomyRequest {
/// The taxonomy to update. You can update only its description, display name,
/// and activated policy types.
#[prost(message, optional, tag = "1")]
pub taxonomy: ::core::option::Option<Taxonomy>,
/// Specifies fields to update. If not set, defaults to all fields you can
/// update.
///
/// For more information, see \[FieldMask\]
/// (<https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask>).
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTaxonomiesRequest {
/// Required. Resource name of the project to list the taxonomies of.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of items to return. Must be a value between 1 and 1000
/// inclusively. If not set, defaults to 50.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The pagination token of the next results page. If not set,
/// the first page is returned.
///
/// The token is returned in the response to a previous list request.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Supported field for filter is 'service' and value is 'dataplex'.
/// Eg: service=dataplex.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
}
/// Response message for
/// [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTaxonomiesResponse {
/// Taxonomies that the project contains.
#[prost(message, repeated, tag = "1")]
pub taxonomies: ::prost::alloc::vec::Vec<Taxonomy>,
/// Pagination token of the next results page. Empty if there are no
/// more results in the list.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [GetTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTaxonomyRequest {
/// Required. Resource name of the taxonomy to get.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [CreatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreatePolicyTagRequest {
/// Required. Resource name of the taxonomy that the policy tag will belong to.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The policy tag to create.
#[prost(message, optional, tag = "2")]
pub policy_tag: ::core::option::Option<PolicyTag>,
}
/// Request message for
/// [DeletePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeletePolicyTagRequest {
/// Required. Resource name of the policy tag to delete.
///
/// Note: All of its descendant policy tags are also deleted.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [UpdatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdatePolicyTagRequest {
/// The policy tag to update. You can update only its description, display
/// name, and parent policy tag fields.
#[prost(message, optional, tag = "1")]
pub policy_tag: ::core::option::Option<PolicyTag>,
/// Specifies the fields to update.
///
/// You can update only display name, description, and parent policy tag.
/// If not set, defaults to all updatable fields.
/// For more information, see \[FieldMask\]
/// (<https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask>).
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPolicyTagsRequest {
/// Required. Resource name of the taxonomy to list the policy tags of.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of items to return. Must be a value between 1 and 1000
/// inclusively.
/// If not set, defaults to 50.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The pagination token of the next results page. If not set, returns the
/// first page.
///
/// The token is returned in the response to a previous list request.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPolicyTagsResponse {
/// The policy tags that belong to the taxonomy.
#[prost(message, repeated, tag = "1")]
pub policy_tags: ::prost::alloc::vec::Vec<PolicyTag>,
/// Pagination token of the next results page. Empty if there are no
/// more results in the list.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [GetPolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPolicyTagRequest {
/// Required. Resource name of the policy tag.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod policy_tag_manager_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Policy Tag Manager API service allows you to manage your policy tags and
/// taxonomies.
///
/// Policy tags are used to tag BigQuery columns and apply additional access
/// control policies. A taxonomy is a hierarchical grouping of policy tags that
/// classify data along a common axis.
#[derive(Debug, Clone)]
pub struct PolicyTagManagerClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> PolicyTagManagerClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> PolicyTagManagerClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
PolicyTagManagerClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Creates a taxonomy in a specified project.
///
/// The taxonomy is initially empty, that is, it doesn't contain policy tags.
pub async fn create_taxonomy(
&mut self,
request: impl tonic::IntoRequest<super::CreateTaxonomyRequest>,
) -> std::result::Result<tonic::Response<super::Taxonomy>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/CreateTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"CreateTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a taxonomy, including all policy tags in this
/// taxonomy, their associated policies, and the policy tags references from
/// BigQuery columns.
pub async fn delete_taxonomy(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTaxonomyRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/DeleteTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"DeleteTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a taxonomy, including its display name,
/// description, and activated policy types.
pub async fn update_taxonomy(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTaxonomyRequest>,
) -> std::result::Result<tonic::Response<super::Taxonomy>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/UpdateTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"UpdateTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all taxonomies in a project in a particular location that you
/// have a permission to view.
pub async fn list_taxonomies(
&mut self,
request: impl tonic::IntoRequest<super::ListTaxonomiesRequest>,
) -> std::result::Result<
tonic::Response<super::ListTaxonomiesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/ListTaxonomies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"ListTaxonomies",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a taxonomy.
pub async fn get_taxonomy(
&mut self,
request: impl tonic::IntoRequest<super::GetTaxonomyRequest>,
) -> std::result::Result<tonic::Response<super::Taxonomy>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/GetTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"GetTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a policy tag in a taxonomy.
pub async fn create_policy_tag(
&mut self,
request: impl tonic::IntoRequest<super::CreatePolicyTagRequest>,
) -> std::result::Result<tonic::Response<super::PolicyTag>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/CreatePolicyTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"CreatePolicyTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a policy tag together with the following:
///
/// * All of its descendant policy tags, if any
/// * Policies associated with the policy tag and its descendants
/// * References from BigQuery table schema of the policy tag and its
/// descendants
pub async fn delete_policy_tag(
&mut self,
request: impl tonic::IntoRequest<super::DeletePolicyTagRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/DeletePolicyTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"DeletePolicyTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a policy tag, including its display
/// name, description, and parent policy tag.
pub async fn update_policy_tag(
&mut self,
request: impl tonic::IntoRequest<super::UpdatePolicyTagRequest>,
) -> std::result::Result<tonic::Response<super::PolicyTag>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/UpdatePolicyTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"UpdatePolicyTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all policy tags in a taxonomy.
pub async fn list_policy_tags(
&mut self,
request: impl tonic::IntoRequest<super::ListPolicyTagsRequest>,
) -> std::result::Result<
tonic::Response<super::ListPolicyTagsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/ListPolicyTags",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"ListPolicyTags",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a policy tag.
pub async fn get_policy_tag(
&mut self,
request: impl tonic::IntoRequest<super::GetPolicyTagRequest>,
) -> std::result::Result<tonic::Response<super::PolicyTag>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/GetPolicyTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"GetPolicyTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the IAM policy for a policy tag or a taxonomy.
pub async fn get_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::GetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::iam::v1::Policy>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/GetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"GetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Sets the IAM policy for a policy tag or a taxonomy.
pub async fn set_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::SetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::iam::v1::Policy>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/SetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"SetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns your permissions on a specified policy tag or
/// taxonomy.
pub async fn test_iam_permissions(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::TestIamPermissionsRequest,
>,
) -> std::result::Result<
tonic::Response<
super::super::super::super::iam::v1::TestIamPermissionsResponse,
>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManager/TestIamPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManager",
"TestIamPermissions",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// A nested protocol buffer that represents a taxonomy and the hierarchy of its
/// policy tags. Used for taxonomy replacement, import, and
/// export.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SerializedTaxonomy {
/// Required. Display name of the taxonomy. At most 200 bytes when encoded in
/// UTF-8.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
/// Description of the serialized taxonomy. At most 2000 bytes when
/// encoded in UTF-8. If not set, defaults to an empty description.
#[prost(string, tag = "2")]
pub description: ::prost::alloc::string::String,
/// Top level policy tags associated with the taxonomy, if any.
#[prost(message, repeated, tag = "3")]
pub policy_tags: ::prost::alloc::vec::Vec<SerializedPolicyTag>,
/// A list of policy types that are activated per taxonomy.
#[prost(enumeration = "taxonomy::PolicyType", repeated, tag = "4")]
pub activated_policy_types: ::prost::alloc::vec::Vec<i32>,
}
/// A nested protocol buffer that represents a policy tag and all its
/// descendants.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SerializedPolicyTag {
/// Resource name of the policy tag.
///
/// This field is ignored when calling `ImportTaxonomies`.
#[prost(string, tag = "1")]
pub policy_tag: ::prost::alloc::string::String,
/// Required. Display name of the policy tag. At most 200 bytes when encoded
/// in UTF-8.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Description of the serialized policy tag. At most
/// 2000 bytes when encoded in UTF-8. If not set, defaults to an
/// empty description.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Children of the policy tag, if any.
#[prost(message, repeated, tag = "4")]
pub child_policy_tags: ::prost::alloc::vec::Vec<SerializedPolicyTag>,
}
/// Request message for
/// [ReplaceTaxonomy][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReplaceTaxonomyRequest {
/// Required. Resource name of the taxonomy to update.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. Taxonomy to update along with its child policy tags.
#[prost(message, optional, tag = "2")]
pub serialized_taxonomy: ::core::option::Option<SerializedTaxonomy>,
}
/// Request message for
/// [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportTaxonomiesRequest {
/// Required. Resource name of project that the imported taxonomies will belong
/// to.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Source taxonomies to import.
#[prost(oneof = "import_taxonomies_request::Source", tags = "2, 3")]
pub source: ::core::option::Option<import_taxonomies_request::Source>,
}
/// Nested message and enum types in `ImportTaxonomiesRequest`.
pub mod import_taxonomies_request {
/// Source taxonomies to import.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// Inline source taxonomy to import.
#[prost(message, tag = "2")]
InlineSource(super::InlineSource),
/// Cross-regional source taxonomy to import.
#[prost(message, tag = "3")]
CrossRegionalSource(super::CrossRegionalSource),
}
}
/// Inline source containing taxonomies to import.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InlineSource {
/// Required. Taxonomies to import.
#[prost(message, repeated, tag = "1")]
pub taxonomies: ::prost::alloc::vec::Vec<SerializedTaxonomy>,
}
/// Cross-regional source used to import an existing taxonomy into a different
/// region.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CrossRegionalSource {
/// Required. The resource name of the source taxonomy to import.
#[prost(string, tag = "1")]
pub taxonomy: ::prost::alloc::string::String,
}
/// Response message for
/// [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportTaxonomiesResponse {
/// Imported taxonomies.
#[prost(message, repeated, tag = "1")]
pub taxonomies: ::prost::alloc::vec::Vec<Taxonomy>,
}
/// Request message for
/// [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportTaxonomiesRequest {
/// Required. Resource name of the project that the exported taxonomies belong
/// to.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Resource names of the taxonomies to export.
#[prost(string, repeated, tag = "2")]
pub taxonomies: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Required. Export destination for taxonomies.
#[prost(oneof = "export_taxonomies_request::Destination", tags = "3")]
pub destination: ::core::option::Option<export_taxonomies_request::Destination>,
}
/// Nested message and enum types in `ExportTaxonomiesRequest`.
pub mod export_taxonomies_request {
/// Required. Export destination for taxonomies.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Destination {
/// Serialized export taxonomies that contain all the policy
/// tags as nested protocol buffers.
#[prost(bool, tag = "3")]
SerializedTaxonomies(bool),
}
}
/// Response message for
/// [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportTaxonomiesResponse {
/// List of taxonomies and policy tags as nested protocol buffers.
#[prost(message, repeated, tag = "1")]
pub taxonomies: ::prost::alloc::vec::Vec<SerializedTaxonomy>,
}
/// Generated client implementations.
pub mod policy_tag_manager_serialization_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Policy Tag Manager Serialization API service allows you to manipulate
/// your policy tags and taxonomies in a serialized format.
///
/// Taxonomy is a hierarchical group of policy tags.
#[derive(Debug, Clone)]
pub struct PolicyTagManagerSerializationClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> PolicyTagManagerSerializationClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> PolicyTagManagerSerializationClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
PolicyTagManagerSerializationClient::new(
InterceptedService::new(inner, interceptor),
)
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Replaces (updates) a taxonomy and all its policy tags.
///
/// The taxonomy and its entire hierarchy of policy tags must be
/// represented literally by `SerializedTaxonomy` and the nested
/// `SerializedPolicyTag` messages.
///
/// This operation automatically does the following:
///
/// - Deletes the existing policy tags that are missing from the
/// `SerializedPolicyTag`.
/// - Creates policy tags that don't have resource names. They are considered
/// new.
/// - Updates policy tags with valid resources names accordingly.
pub async fn replace_taxonomy(
&mut self,
request: impl tonic::IntoRequest<super::ReplaceTaxonomyRequest>,
) -> std::result::Result<tonic::Response<super::Taxonomy>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManagerSerialization/ReplaceTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManagerSerialization",
"ReplaceTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates new taxonomies (including their policy tags) in a given project
/// by importing from inlined or cross-regional sources.
///
/// For a cross-regional source, new taxonomies are created by copying
/// from a source in another region.
///
/// For an inlined source, taxonomies and policy tags are created in bulk using
/// nested protocol buffer structures.
pub async fn import_taxonomies(
&mut self,
request: impl tonic::IntoRequest<super::ImportTaxonomiesRequest>,
) -> std::result::Result<
tonic::Response<super::ImportTaxonomiesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManagerSerialization/ImportTaxonomies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManagerSerialization",
"ImportTaxonomies",
),
);
self.inner.unary(req, path, codec).await
}
/// Exports taxonomies in the requested type and returns them,
/// including their policy tags. The requested taxonomies must belong to the
/// same project.
///
/// This method generates `SerializedTaxonomy` protocol buffers with nested
/// policy tags that can be used as input for `ImportTaxonomies` calls.
pub async fn export_taxonomies(
&mut self,
request: impl tonic::IntoRequest<super::ExportTaxonomiesRequest>,
) -> std::result::Result<
tonic::Response<super::ExportTaxonomiesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.datacatalog.v1.PolicyTagManagerSerialization/ExportTaxonomies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1.PolicyTagManagerSerialization",
"ExportTaxonomies",
),
);
self.inner.unary(req, path, codec).await
}
}
}