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
// This file is @generated by prost-build.
/// Detailed counts on the entry's usage.
/// Caveats:
/// - Only BigQuery tables have usage stats
/// - The usage stats only include BigQuery query jobs
/// - The usage stats might be underestimated, e.g. wildcard table references
/// are not yet counted in usage computation
/// <https://cloud.google.com/bigquery/docs/querying-wildcard-tables>
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UsageStats {
/// The number of times that the underlying entry was successfully used.
#[prost(float, tag = "1")]
pub total_completions: f32,
/// The number of times that the underlying entry was attempted to be used
/// but failed.
#[prost(float, tag = "2")]
pub total_failures: f32,
/// The number of times that the underlying entry was attempted to be used
/// but was cancelled by the user.
#[prost(float, tag = "3")]
pub total_cancellations: f32,
/// Total time spent (in milliseconds) during uses the resulted in completions.
#[prost(float, tag = "4")]
pub total_execution_time_for_completions_millis: f32,
}
/// The set of all usage signals that we store in Data Catalog.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UsageSignal {
/// The timestamp of the end of the usage statistics duration.
#[prost(message, optional, tag = "1")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Usage statistics over each of the pre-defined time ranges, supported
/// strings for 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,
>,
}
/// This enum describes all the possible 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,
}
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",
}
}
/// 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),
_ => 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,
}
}
}
/// Timestamps about this resource according to a particular system.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SystemTimestamps {
/// The creation time of the resource within the given system.
#[prost(message, optional, tag = "1")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// The last-modified time of the resource within the given system.
#[prost(message, optional, tag = "2")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The expiration time of the resource within the given system.
/// Currently only apllicable 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.
/// See [Cloud Storage
/// documentation](<https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames>)
/// for more information. Note that bucket wildcards are currently not
/// supported.
///
/// Examples of valid file_patterns:
///
/// * `gs://bucket_name/dir/*`: matches all files within `bucket_name/dir`
/// directory.
/// * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir`
/// spanning 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
/// `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 provide more powerful matches, 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>,
}
/// Specifications of a single file in Cloud Storage.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GcsFileSpec {
/// Required. The full file path. Example: `gs://bucket_name/a/b.txt`.
#[prost(string, tag = "1")]
pub file_path: ::prost::alloc::string::String,
/// Output only. Timestamps about the Cloud Storage file.
#[prost(message, optional, tag = "2")]
pub gcs_timestamps: ::core::option::Option<SystemTimestamps>,
/// Output only. The size of the file, in bytes.
#[prost(int64, tag = "4")]
pub size_bytes: i64,
}
/// Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Schema {
/// Required. Schema of columns. A maximum of 10,000 columns and sub-columns
/// can be specified.
#[prost(message, repeated, tag = "2")]
pub columns: ::prost::alloc::vec::Vec<ColumnSchema>,
}
/// Representation of a column within a schema. Columns could be nested inside
/// other columns.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ColumnSchema {
/// Required. Name of the column.
#[prost(string, tag = "6")]
pub column: ::prost::alloc::string::String,
/// Required. Type of the column.
#[prost(string, tag = "1")]
pub r#type: ::prost::alloc::string::String,
/// Optional. Description of the column. Default value is an empty string.
#[prost(string, tag = "2")]
pub description: ::prost::alloc::string::String,
/// Optional. A column's mode indicates whether the values in this column are
/// required, nullable, etc. Only `NULLABLE`, `REQUIRED` and `REPEATED` are
/// supported. Default mode is `NULLABLE`.
#[prost(string, tag = "3")]
pub mode: ::prost::alloc::string::String,
/// 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>,
}
/// A result that appears in the response of 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. This field can be used 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. This is a dot-delimited description of the
/// resource's full type, and is the same as the value callers would provide in
/// the "type" search facet. Examples: `entry.table`, `entry.dataStream`,
/// `tagTemplate`.
#[prost(string, tag = "2")]
pub search_result_subtype: ::prost::alloc::string::String,
/// The relative resource 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 cloud resource the entry belongs to. See:
/// <https://cloud.google.com/apis/design/resource_names#full_resource_name.>
/// Example:
///
/// * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId`
#[prost(string, tag = "4")]
pub linked_resource: ::prost::alloc::string::String,
/// Last-modified timestamp of the entry from the managing system.
#[prost(message, optional, tag = "7")]
pub modify_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// The different types of resources that can be returned in search.
#[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.v1beta1.Entry].
Entry = 1,
/// A [TagTemplate][google.cloud.datacatalog.v1beta1.TagTemplate].
TagTemplate = 2,
/// An [EntryGroup][google.cloud.datacatalog.v1beta1.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. This field should only be populated if
/// `table_source_type` is `BIGQUERY_VIEW`.
#[prost(message, tag = "2")]
ViewSpec(super::ViewSpec),
/// Spec of a BigQuery table. This field should only be populated if
/// `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 spec.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TableSpec {
/// Output only. If the table is a dated shard, i.e., with name pattern
/// `\[prefix\]YYYYMMDD`, `grouped_entry` 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,
}
/// Spec for a group of BigQuery tables with name pattern `\[prefix\]YYYYMMDD`.
/// Context:
/// <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 shard `MyTable20180101`, 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,
}
/// 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 are used to attach custom metadata to Data Catalog resources. Tags
/// conform to the specifications within 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 {
/// Identifier. The resource name of the tag in URL format. Example:
///
/// * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
///
/// where `tag_id` is a system-generated identifier.
/// Note that this Tag may not actually be stored in the location in this name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The resource name of the tag template that 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. This maps the ID of a tag field to the value of and additional
/// information about that field. Valid field IDs are defined by the tag's
/// template. 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 will delete 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 will delete 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 users to attach tags to an individual column based on that schema.
///
/// For attaching a tag to a nested column, use `.` to separate the column
/// names. Example:
///
/// * `outer_column.inner_column`
#[prost(string, tag = "4")]
Column(::prost::alloc::string::String),
}
}
/// Contains the value and supporting information for a field within
/// a [Tag][google.cloud.datacatalog.v1beta1.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. It can be set in
/// [Tag][google.cloud.datacatalog.v1beta1.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 do not 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")]
pub kind: ::core::option::Option<tag_field::Kind>,
}
/// Nested message and enum types in `TagField`.
pub mod tag_field {
/// Holds 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 {
/// Holds the value for a tag field with double type.
#[prost(double, tag = "2")]
DoubleValue(f64),
/// Holds the value for a tag field with string type.
#[prost(string, tag = "3")]
StringValue(::prost::alloc::string::String),
/// Holds the value for a tag field with boolean type.
#[prost(bool, tag = "4")]
BoolValue(bool),
/// Holds the value for a tag field with timestamp type.
#[prost(message, tag = "5")]
TimestampValue(::prost_types::Timestamp),
/// Holds the value for a tag field with enum type. This value must be
/// one of the allowed values in the definition of this enum.
#[prost(message, tag = "6")]
EnumValue(EnumValue),
}
}
/// A tag template defines a tag, which can have one or more typed fields.
/// The template is used to create and attach the tag 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. See, for example,
/// the [TagTemplate
/// User](<https://cloud.google.com/data-catalog/docs/how-to/template-user>) role,
/// which includes permission to use the tag template to tag resources.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TagTemplate {
/// Identifier. The resource name of the tag template in URL format. Example:
///
/// * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
///
/// Note that this TagTemplate and its child resources may not actually be
/// stored in the location in this name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The display name for this template. Defaults to an empty string.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. Map of tag template field IDs to the settings for the field.
/// This map is an exhaustive list of the allowed fields. This map must contain
/// at least one field and at most 500 fields.
///
/// The keys to this map are tag template field IDs. Field IDs can contain
/// letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
/// Field IDs must be at least 1 character long and at most
/// 64 characters long. Field IDs 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,
>,
/// Output only. Transfer status of the TagTemplate
#[prost(enumeration = "tag_template::DataplexTransferStatus", tag = "7")]
pub dataplex_transfer_status: i32,
}
/// Nested message and enum types in `TagTemplate`.
pub mod tag_template {
/// This enum describes TagTemplate transfer status to Dataplex service.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DataplexTransferStatus {
/// Default value. TagTemplate and its tags are only visible and editable in
/// DataCatalog.
Unspecified = 0,
/// TagTemplate and its tags are auto-copied to Dataplex service.
/// Visible in both services. Editable in DataCatalog, read-only in Dataplex.
/// Deprecated: Individual TagTemplate migration is deprecated in favor of
/// organization or project wide TagTemplate migration opt-in.
Migrated = 1,
}
impl DataplexTransferStatus {
/// 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 {
DataplexTransferStatus::Unspecified => {
"DATAPLEX_TRANSFER_STATUS_UNSPECIFIED"
}
DataplexTransferStatus::Migrated => "MIGRATED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DATAPLEX_TRANSFER_STATUS_UNSPECIFIED" => Some(Self::Unspecified),
"MIGRATED" => Some(Self::Migrated),
_ => None,
}
}
}
}
/// The template for an individual field within a tag template.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TagTemplateField {
/// Output only. Identifier. The resource name of the tag template field in URL
/// format. Example:
///
/// * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}
///
/// Note that this TagTemplateField may not actually be stored in the location
/// in this name.
#[prost(string, tag = "6")]
pub name: ::prost::alloc::string::String,
/// The display name for this field. Defaults to an empty string.
#[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>,
/// Whether this is a required field. 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. A higher value indicates a more important field. The value can
/// be negative. Multiple fields can have the same order, and field orders
/// within a tag do not 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 {
#[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.
#[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 {
/// This is 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,
}
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",
}
}
/// 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),
_ => None,
}
}
}
/// Required.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TypeDecl {
/// Represents primitive types - string, bool etc.
#[prost(enumeration = "PrimitiveType", tag = "1")]
PrimitiveType(i32),
/// Represents an enum type.
#[prost(message, tag = "2")]
EnumType(EnumType),
}
}
/// Request message for
/// [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchCatalogRequest {
/// Required. The scope of this search request. A `scope` that has empty
/// `include_org_ids`, `include_project_ids` AND false
/// `include_gcp_public_datasets` is considered invalid. Data Catalog will
/// return an error in such a case.
#[prost(message, optional, tag = "6")]
pub scope: ::core::option::Option<search_catalog_request::Scope>,
/// Optional. The query string in search query syntax. An empty query string
/// will result in all data assets (in the specified scope) that the user has
/// access to. Query strings can be simple as "x" or more qualified as:
///
/// * name:x
/// * column:x
/// * description:y
///
/// Note: Query tokens need to have a minimum of 3 characters for substring
/// matching to work correctly. See [Data Catalog Search
/// Syntax](<https://cloud.google.com/data-catalog/docs/how-to/search-reference>)
/// for more information.
#[prost(string, tag = "1")]
pub query: ::prost::alloc::string::String,
/// Number of results in the search page. If <=0 then defaults to 10. Max limit
/// for page_size is 1000. Throws an invalid argument for page_size > 1000.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. Pagination token returned in an earlier
/// [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token],
/// which indicates that this is a continuation of a prior
/// [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
/// call, and that the system should return the next page of data. If empty,
/// the first page is returned.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Specifies the ordering of results, currently supported case-sensitive
/// choices are:
///
/// * `relevance`, only supports descending
/// * `last_modified_timestamp \[asc|desc\]`, defaults to descending if not
/// specified
/// * `default` that can only be descending
///
/// If not specified, defaults to `relevance` descending.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// 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 instructions in
/// <https://cloud.google.com/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. To learn more about the
/// distinction between project names/IDs/numbers, go to
/// <https://cloud.google.com/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 the
/// search results. Info on Google Cloud public datasets is available at
/// <https://cloud.google.com/public-datasets/.> By default, Google Cloud
/// public datasets are excluded.
#[prost(bool, tag = "7")]
pub include_gcp_public_datasets: bool,
/// Optional. The list of locations to search within.
/// 1. If empty, search will be performed in all locations;
/// 2. If any of the locations are NOT in the valid locations list, error
/// will be returned;
/// 3. Otherwise, search only the given locations for matching results.
/// Typical usage is to leave this field empty. When a location is
/// unreachable as returned in the `SearchCatalogResponse.unreachable` field,
/// users can repeat the search request with this parameter set to get
/// additional information on the error.
///
/// Valid locations:
/// * asia-east1
/// * asia-east2
/// * asia-northeast1
/// * asia-northeast2
/// * asia-northeast3
/// * asia-south1
/// * asia-southeast1
/// * australia-southeast1
/// * eu
/// * europe-north1
/// * europe-west1
/// * europe-west2
/// * europe-west3
/// * europe-west4
/// * europe-west6
/// * global
/// * northamerica-northeast1
/// * southamerica-east1
/// * us
/// * us-central1
/// * us-east1
/// * us-east4
/// * us-west1
/// * us-west2
#[prost(string, repeated, tag = "16")]
pub restricted_locations: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
}
/// Response message for
/// [SearchCatalog][google.cloud.datacatalog.v1beta1.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,
/// The token that can be used to retrieve the next page of results.
#[prost(string, tag = "3")]
pub next_page_token: ::prost::alloc::string::String,
/// Unreachable locations. Search result does not include data from those
/// locations. Users can get additional information on the error by repeating
/// the search request with a more restrictive parameter -- setting the value
/// for `SearchDataCatalogRequest.scope.restricted_locations`.
#[prost(string, repeated, tag = "6")]
pub unreachable: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request message for
/// [CreateEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntryGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateEntryGroupRequest {
/// Required. The name of the project this entry group is in. Example:
///
/// * projects/{project_id}/locations/{location}
///
/// Note that this EntryGroup and its child resources may not actually be
/// stored in the location in this name.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The id of the entry group to create.
/// The id must begin with a letter or underscore, contain only English
/// letters, numbers and underscores, and be at most 64 characters.
#[prost(string, tag = "3")]
pub entry_group_id: ::prost::alloc::string::String,
/// The entry group to create. Defaults to an empty entry group.
#[prost(message, optional, tag = "2")]
pub entry_group: ::core::option::Option<EntryGroup>,
}
/// Request message for
/// [UpdateEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntryGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateEntryGroupRequest {
/// Required. The updated entry group. "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.v1beta1.DataCatalog.GetEntryGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetEntryGroupRequest {
/// Required. The name of the entry group. For example,
/// `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The fields to return. If not set or empty, 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.v1beta1.DataCatalog.DeleteEntryGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteEntryGroupRequest {
/// Required. The name of the entry group. For example,
/// `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
#[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.v1beta1.DataCatalog.ListEntryGroups].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntryGroupsRequest {
/// Required. The name of the location that contains the entry groups, which
/// can be provided in URL format. Example:
///
/// * projects/{project_id}/locations/{location}
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The maximum number of items to return. Default is 10. Max limit
/// is 1000. Throws an invalid argument for `page_size > 1000`.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. Token that specifies which page is requested. If empty, the first
/// page is returned.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [ListEntryGroups][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntryGroups].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntryGroupsResponse {
/// EntryGroup details.
#[prost(message, repeated, tag = "1")]
pub entry_groups: ::prost::alloc::vec::Vec<EntryGroup>,
/// Token to retrieve the next page of results. It is set to empty if no items
/// remain in results.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateEntryRequest {
/// Required. The name of the entry group this entry is in. Example:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
///
/// Note that this Entry and its child resources may not actually be stored in
/// the location in this name.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The id of the entry to create.
#[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.v1beta1.DataCatalog.UpdateEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateEntryRequest {
/// Required. The updated 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.
///
/// The following fields are modifiable:
///
/// * 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.v1beta1.DataCatalog.DeleteEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteEntryRequest {
/// Required. The name of the entry. Example:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [GetEntry][google.cloud.datacatalog.v1beta1.DataCatalog.GetEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetEntryRequest {
/// Required. The name of the entry. Example:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [LookupEntry][google.cloud.datacatalog.v1beta1.DataCatalog.LookupEntry].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LookupEntryRequest {
/// Required. Represents either the Google Cloud Platform resource or SQL name
/// for a Google Cloud Platform resource.
#[prost(oneof = "lookup_entry_request::TargetName", tags = "1, 3")]
pub target_name: ::core::option::Option<lookup_entry_request::TargetName>,
}
/// Nested message and enum types in `LookupEntryRequest`.
pub mod lookup_entry_request {
/// Required. Represents either the Google Cloud Platform resource or SQL name
/// for 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. See:
/// <https://cloud.google.com/apis/design/resource_names#full_resource_name.>
/// Full names are case-sensitive.
///
/// Examples:
///
/// * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
/// * //pubsub.googleapis.com/projects/projectId/topics/topicId
#[prost(string, tag = "1")]
LinkedResource(::prost::alloc::string::String),
/// The SQL name of the entry. SQL names are case-sensitive.
///
/// Examples:
///
/// * `pubsub.project_id.topic_id`
/// * ``pubsub.project_id.`topic.id.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`
///
/// `*_id`s should satisfy the standard SQL rules for identifiers.
/// <https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.>
#[prost(string, tag = "3")]
SqlResource(::prost::alloc::string::String),
}
}
/// Entry Metadata.
/// A Data Catalog Entry resource represents another resource in Google
/// Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or
/// outside of Google Cloud Platform. Clients 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, such as its schema. An Entry can
/// also be used to attach flexible metadata, such as a
/// [Tag][google.cloud.datacatalog.v1beta1.Tag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Entry {
/// Output only. Identifier. The Data Catalog resource name of the entry in URL
/// format. Example:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
///
/// Note that this Entry and its child resources may not actually be stored in
/// the location in this 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 name of
/// the
/// resource](<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/projectId/datasets/datasetId/tables/tableId
///
/// Output only when Entry is of type in the EntryType enum. For entries with
/// user_specified_type, this field is optional and defaults to an empty
/// string.
#[prost(string, tag = "9")]
pub linked_resource: ::prost::alloc::string::String,
/// Display information such as title and description. A short name to identify
/// the entry, for example, "Analytics Data - Jan 2011". Default value is an
/// empty string.
#[prost(string, tag = "3")]
pub display_name: ::prost::alloc::string::String,
/// Entry description, which can consist of several sentences or paragraphs
/// that describe entry contents. Default value is an empty string.
#[prost(string, tag = "4")]
pub description: ::prost::alloc::string::String,
/// 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>,
/// Output only. Timestamps about the underlying resource, not about this Data
/// Catalog entry. Output only when Entry is of type in the EntryType enum. For
/// entries with user_specified_type, this field is optional and defaults to an
/// empty timestamp.
#[prost(message, optional, tag = "7")]
pub source_system_timestamps: ::core::option::Option<SystemTimestamps>,
/// Output only. Statistics on the usage level of the resource.
#[prost(message, optional, tag = "13")]
pub usage_signal: ::core::option::Option<UsageSignal>,
/// 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>,
/// Type specification information.
#[prost(oneof = "entry::TypeSpec", tags = "6, 12, 15")]
pub type_spec: ::core::option::Option<entry::TypeSpec>,
}
/// 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.
/// Only used for Entries with types in the EntryType enum.
#[prost(enumeration = "super::EntryType", tag = "2")]
Type(i32),
/// Entry type if it does not fit any of the input-allowed values listed in
/// `EntryType` enum above. When creating an entry, users should check the
/// enum values first, if nothing matches the entry to be created, then
/// provide a custom value, for example "my_special_type".
/// `user_specified_type` strings must begin with a letter or underscore and
/// can only contain letters, numbers, and underscores; are case insensitive;
/// must be at least 1 character and at most 64 characters long.
///
/// Currently, only FILESET enum value is allowed. All other entries created
/// through Data Catalog must use `user_specified_type`.
#[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. This field indicates the entry's source system that Data
/// Catalog integrates with, such as BigQuery or Pub/Sub.
#[prost(enumeration = "super::IntegratedSystem", tag = "17")]
IntegratedSystem(i32),
/// This field indicates the entry's source system that Data Catalog does not
/// integrate with. `user_specified_system` strings must begin with a letter
/// or underscore and can only contain letters, numbers, and underscores; are
/// case insensitive; must be at least 1 character and at most 64 characters
/// long.
#[prost(string, tag = "18")]
UserSpecifiedSystem(::prost::alloc::string::String),
}
/// Type specification information.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TypeSpec {
/// Specification that applies to a Cloud Storage fileset. This is only valid
/// on entries of type FILESET.
#[prost(message, tag = "6")]
GcsFilesetSpec(super::GcsFilesetSpec),
/// Specification that applies to a BigQuery table. This is only valid on
/// entries of type `TABLE`.
#[prost(message, tag = "12")]
BigqueryTableSpec(super::BigQueryTableSpec),
/// Specification for a group of BigQuery tables with name pattern
/// `\[prefix\]YYYYMMDD`. Context:
/// <https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.>
#[prost(message, tag = "15")]
BigqueryDateShardedSpec(super::BigQueryDateShardedSpec),
}
}
/// EntryGroup Metadata.
/// An EntryGroup resource represents a logical grouping of zero or more
/// Data Catalog [Entry][google.cloud.datacatalog.v1beta1.Entry] resources.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EntryGroup {
/// Identifier. The resource name of the entry group in URL format. Example:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
///
/// Note that this EntryGroup and its child resources may not actually be
/// stored in the location in this 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, which can consist of several sentences or
/// paragraphs that describe entry group contents. Default value is an empty
/// string.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. Timestamps about this EntryGroup. Default value is empty
/// timestamps.
#[prost(message, optional, tag = "4")]
pub data_catalog_timestamps: ::core::option::Option<SystemTimestamps>,
}
/// Request message for
/// [CreateTagTemplate][google.cloud.datacatalog.v1beta1.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.>
///
/// Example:
///
/// * projects/{project_id}/locations/us-central1
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The id of the tag template to create.
#[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.v1beta1.DataCatalog.GetTagTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTagTemplateRequest {
/// Required. The name of the tag template. Example:
///
/// * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [UpdateTagTemplate][google.cloud.datacatalog.v1beta1.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` can be overwritten.
///
/// 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
/// [DeleteTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTagTemplateRequest {
/// Required. The name of the tag template to delete. Example:
///
/// * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. Currently, this field must always be set to `true`.
/// This confirms the deletion of any possible tags using this template.
/// `force = false` will be supported in the future.
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [CreateTag][google.cloud.datacatalog.v1beta1.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. Example:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
///
/// Note that this Tag and its child resources may not actually be stored in
/// the location in this 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.v1beta1.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>,
/// Note: Currently, this parameter can only take `"fields"` as value.
///
/// 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.v1beta1.DataCatalog.DeleteTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTagRequest {
/// Required. The name of the tag to delete. Example:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [CreateTagTemplateField][google.cloud.datacatalog.v1beta1.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>).
///
/// Example:
///
/// * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id}
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ID of the tag template field to create.
/// 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.v1beta1.DataCatalog.UpdateTagTemplateField].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTagTemplateFieldRequest {
/// Required. The name of the tag template field. Example:
///
/// * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
#[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.v1beta1.DataCatalog.RenameTagTemplateField].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RenameTagTemplateFieldRequest {
/// Required. The name of the tag template. Example:
///
/// * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
#[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. Example:
///
/// * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}
#[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.v1beta1.DataCatalog.DeleteTagTemplateField].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTagTemplateFieldRequest {
/// Required. The name of the tag template field to delete. Example:
///
/// * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. Currently, this field must always be set to `true`.
/// This confirms the deletion of this field from any tags using this field.
/// `force = false` will be supported in the future.
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [ListTags][google.cloud.datacatalog.v1beta1.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 could be an [Entry][google.cloud.datacatalog.v1beta1.Entry] or an
/// [EntryGroup][google.cloud.datacatalog.v1beta1.EntryGroup].
///
/// Examples:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of tags to return. Default is 10. Max limit is 1000.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Token that specifies which page is requested. 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.v1beta1.DataCatalog.ListTags].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTagsResponse {
/// [Tag][google.cloud.datacatalog.v1beta1.Tag] details.
#[prost(message, repeated, tag = "1")]
pub tags: ::prost::alloc::vec::Vec<Tag>,
/// Token to retrieve the next page of results. It is set to empty if no items
/// remain in results.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [ListEntries][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntriesRequest {
/// Required. The name of the entry group that contains the entries, which can
/// be provided in URL format. Example:
///
/// * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of items to return. Default is 10. Max limit is 1000.
/// Throws an invalid argument for `page_size > 1000`.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Token that specifies which page is requested. 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 not set or empty, all
/// fields are returned.
/// For example, setting read_mask to contain only one path "name" will cause
/// ListEntries to return a list of Entries with only "name" field.
#[prost(message, optional, tag = "4")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [ListEntries][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntriesResponse {
/// Entry details.
#[prost(message, repeated, tag = "1")]
pub entries: ::prost::alloc::vec::Vec<Entry>,
/// Token to retrieve the next page of results. It is set to empty if no items
/// remain in results.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Entry resources in Data Catalog can be of different types e.g. a BigQuery
/// Table entry is of type `TABLE`. This enum describes all the possible types
/// Data Catalog contains.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum EntryType {
/// Default unknown type.
Unspecified = 0,
/// Output only. The type of entry that has a GoogleSQL schema, including
/// logical views.
Table = 2,
/// Output only. The type of models.
/// <https://cloud.google.com/bigquery-ml/docs/bigqueryml-intro>
Model = 5,
/// Output only. An entry type which is used for streaming entries. Example:
/// Pub/Sub topic.
DataStream = 3,
/// An entry type which is a set of files or objects. Example:
/// Cloud Storage fileset.
Fileset = 4,
}
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",
}
}
/// 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),
_ => 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 clients to discover, understand, and manage
/// their 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, tags that
/// match a query.
///
/// This is a custom method
/// (https://cloud.google.com/apis/design/custom_methods) and does not return
/// the complete resource, only the resource identifier and high level
/// fields. Clients can subsequently call `Get` methods.
///
/// Note that Data Catalog search queries do not guarantee full recall. Query
/// results that match your query may not be returned, even in subsequent
/// result pages. Also note that results returned (and not returned) can vary
/// across repeated search queries.
///
/// See [Data Catalog Search
/// Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
/// for more information.
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.v1beta1.DataCatalog/SearchCatalog",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"SearchCatalog",
),
);
self.inner.unary(req, path, codec).await
}
/// A maximum of 10,000 entry groups may be created per organization across all
/// locations.
///
/// Users should enable the Data Catalog API in the project identified by
/// the `parent` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/CreateEntryGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"CreateEntryGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an EntryGroup. The user should enable the Data Catalog API in the
/// project identified by the `entry_group.name` parameter (see [Data Catalog
/// Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/UpdateEntryGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"UpdateEntryGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets an EntryGroup.
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.v1beta1.DataCatalog/GetEntryGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"GetEntryGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an EntryGroup. Only entry groups that do not contain entries can be
/// deleted. Users should enable the Data Catalog API in the project
/// identified by the `name` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/DeleteEntryGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.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.v1beta1.DataCatalog/ListEntryGroups",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"ListEntryGroups",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an entry. Only entries of 'FILESET' type or user-specified type can
/// be created.
///
/// Users should enable the Data Catalog API in the project identified by
/// the `parent` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
///
/// A maximum of 100,000 entries may be created per entry group.
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.v1beta1.DataCatalog/CreateEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"CreateEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an existing entry.
/// Users should enable the Data Catalog API in the project identified by
/// the `entry.name` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/UpdateEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"UpdateEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an existing entry. Only entries created through
/// [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry]
/// method can be deleted.
/// Users should enable the Data Catalog API in the project identified by
/// the `name` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/DeleteEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.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.v1beta1.DataCatalog/GetEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"GetEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Get an entry by target resource name. This method allows clients to use
/// the resource name from the source Google Cloud Platform service to get the
/// Data Catalog Entry.
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.v1beta1.DataCatalog/LookupEntry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"LookupEntry",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists entries.
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.v1beta1.DataCatalog/ListEntries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"ListEntries",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a tag template. The user should enable the Data Catalog API in
/// the project identified by the `parent` parameter (see [Data Catalog
/// Resource
/// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
/// for more information).
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.v1beta1.DataCatalog/CreateTagTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.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.v1beta1.DataCatalog/GetTagTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"GetTagTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a tag template. This method cannot be used to update the fields of
/// a template. The tag template fields are represented as separate resources
/// and should be updated using their own create/update/delete methods.
/// Users should enable the Data Catalog API in the project identified by
/// the `tag_template.name` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/UpdateTagTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"UpdateTagTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a tag template and all tags using the template.
/// Users should enable the Data Catalog API in the project identified by
/// the `name` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/DeleteTagTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"DeleteTagTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a field in a tag template. The user should enable the Data Catalog
/// API in the project identified by the `parent` parameter (see
/// [Data Catalog Resource
/// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
/// for more information).
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.v1beta1.DataCatalog/CreateTagTemplateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"CreateTagTemplateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a field in a tag template. This method cannot be used to update the
/// field type. Users should enable the Data Catalog API in the project
/// identified by the `name` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/UpdateTagTemplateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"UpdateTagTemplateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Renames a field in a tag template. The user should enable the Data Catalog
/// API in the project identified by the `name` parameter (see [Data Catalog
/// Resource
/// Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
/// for more information).
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.v1beta1.DataCatalog/RenameTagTemplateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"RenameTagTemplateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Renames an enum value in a tag template. The enum values have to be unique
/// within one enum field. Thus, an enum value cannot be renamed with a name
/// used in any other enum value within the same enum field.
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.v1beta1.DataCatalog/RenameTagTemplateFieldEnumValue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"RenameTagTemplateFieldEnumValue",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a field in a tag template and all uses of that field.
/// Users should enable the Data Catalog API in the project identified by
/// the `name` parameter (see [Data Catalog Resource Project]
/// (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
/// more information).
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.v1beta1.DataCatalog/DeleteTagTemplateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"DeleteTagTemplateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
/// Note: The project identified by the `parent` parameter for the
/// [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters)
/// and the
/// [tag
/// template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
/// used to create the tag must be from 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.v1beta1.DataCatalog/CreateTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.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.v1beta1.DataCatalog/UpdateTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.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.v1beta1.DataCatalog/DeleteTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"DeleteTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists tags assigned to an [Entry][google.cloud.datacatalog.v1beta1.Entry].
/// The [columns][google.cloud.datacatalog.v1beta1.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.v1beta1.DataCatalog/ListTags",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"ListTags",
),
);
self.inner.unary(req, path, codec).await
}
/// Sets the access control policy for a resource. Replaces any existing
/// policy.
/// Supported resources are:
/// - Tag templates.
/// - Entries.
/// - Entry groups.
/// Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
/// and any external Google Cloud Platform resources synced to Data Catalog.
///
/// Callers must have following Google IAM permission
/// - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
/// templates.
/// - `datacatalog.entries.setIamPolicy` to set policies on entries.
/// - `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.v1beta1.DataCatalog/SetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"SetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the access control policy for a resource. A `NOT_FOUND` error
/// is returned if the resource does not exist. An empty policy is returned
/// if the resource exists but does not have a policy set on it.
///
/// Supported resources are:
/// - Tag templates.
/// - Entries.
/// - Entry groups.
/// Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
/// and any external Google Cloud Platform resources synced to Data Catalog.
///
/// Callers must have following Google IAM permission
/// - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
/// templates.
/// - `datacatalog.entries.getIamPolicy` to get policies on entries.
/// - `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.v1beta1.DataCatalog/GetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"GetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns the caller's permissions on a resource.
/// If the resource does not exist, an empty set of permissions is returned
/// (We don't return a `NOT_FOUND` error).
///
/// Supported resources are:
/// - Tag templates.
/// - Entries.
/// - Entry groups.
/// Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
/// and any external Google Cloud Platform resources synced to Data Catalog.
///
/// A caller is not required to have Google IAM permission to make this
/// request.
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.v1beta1.DataCatalog/TestIamPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.DataCatalog",
"TestIamPermissions",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// A taxonomy is a collection of policy tags that classify data along a common
/// axis. For instance a data *sensitivity* taxonomy could contain policy tags
/// denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could
/// contain policy tags to distinguish user data, employee data, partner data,
/// public data.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Taxonomy {
/// Identifier. Resource name of this taxonomy, whose format is:
/// "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. User defined name of this taxonomy. It must: contain only unicode
/// letters, numbers, underscores, dashes and spaces; not start or end with
/// 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. It must: contain only unicode
/// characters, tabs, newlines, carriage returns and page breaks; and be at
/// most 2000 bytes long when encoded in UTF-8. If not set, defaults to an
/// empty description.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. Number of policy tags contained in this taxonomy.
#[prost(int32, tag = "4")]
pub policy_tag_count: i32,
/// Output only. Timestamps about this taxonomy. Only create_time and
/// update_time are used.
#[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 policy tag 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, which enables access control on
/// tagged 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 (e.g. ssn). Policy Tags can be defined
/// in a hierarchy. For example, consider the following hierarchy:
/// Geolocation -> (LatLong, City, ZipCode). PolicyTag "Geolocation"
/// contains three child policy tags: "LatLong", "City", and "ZipCode".
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PolicyTag {
/// Identifier. Resource name of this policy tag, whose format is:
/// "projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{id}".
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. User defined name of this policy tag. It must: be unique within
/// the parent taxonomy; contain only unicode letters, numbers, underscores,
/// dashes and spaces; not start or end with 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. It must: contain only unicode characters,
/// tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes
/// long when encoded in UTF-8. If not set, defaults to an empty description.
/// If not set, defaults to an empty description.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Resource name of this policy tag's parent policy tag (e.g. for the
/// "LatLong" policy tag in the example above, this field contains the
/// resource name of the "Geolocation" policy tag). If empty, it means this
/// policy tag is a top level policy tag (e.g. this field is empty for the
/// "Geolocation" policy tag in the example above). If not set, defaults to an
/// empty string.
#[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.v1beta1.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 be created.
#[prost(message, optional, tag = "2")]
pub taxonomy: ::core::option::Option<Taxonomy>,
}
/// Request message for
/// [DeleteTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.DeleteTaxonomy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTaxonomyRequest {
/// Required. Resource name of the taxonomy to be deleted. All policy tags in
/// this taxonomy will also be deleted.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [UpdateTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdateTaxonomy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTaxonomyRequest {
/// The taxonomy to update. Only description, display_name, and activated
/// policy types can be updated.
#[prost(message, optional, tag = "1")]
pub taxonomy: ::core::option::Option<Taxonomy>,
/// The update mask applies to the resource. For the `FieldMask` definition,
/// see
/// <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask>
/// If not set, defaults to all of the fields that are allowed to update.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [ListTaxonomies][google.cloud.datacatalog.v1beta1.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.
/// If not set, defaults to 50.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The next_page_token value returned from a previous list request, if any. If
/// not set, defaults to an empty string.
#[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.v1beta1.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>,
/// Token used to retrieve the next page of results, or 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.v1beta1.PolicyTagManager.GetTaxonomy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTaxonomyRequest {
/// Required. Resource name of the requested taxonomy.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [CreatePolicyTag][google.cloud.datacatalog.v1beta1.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 be created.
#[prost(message, optional, tag = "2")]
pub policy_tag: ::core::option::Option<PolicyTag>,
}
/// Request message for
/// [DeletePolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.DeletePolicyTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeletePolicyTagRequest {
/// Required. Resource name of the policy tag to be deleted. All of its
/// descendant policy tags will also be deleted.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [UpdatePolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdatePolicyTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdatePolicyTagRequest {
/// The policy tag to update. Only the description, display_name, and
/// parent_policy_tag fields can be updated.
#[prost(message, optional, tag = "1")]
pub policy_tag: ::core::option::Option<PolicyTag>,
/// The update mask applies to the resource. Only display_name, description and
/// parent_policy_tag can be updated and thus can be listed in the mask. If
/// update_mask is not provided, all allowed fields (i.e. display_name,
/// description and parent) will be updated. For more information including the
/// `FieldMask` definition, see
/// <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask>
/// If not set, defaults to all of the fields that are allowed to update.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [ListPolicyTags][google.cloud.datacatalog.v1beta1.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.
/// If not set, defaults to 50.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The next_page_token value returned from a previous List request, if any. If
/// not set, defaults to an empty string.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [ListPolicyTags][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPolicyTagsResponse {
/// The policy tags that are in the requested taxonomy.
#[prost(message, repeated, tag = "1")]
pub policy_tags: ::prost::alloc::vec::Vec<PolicyTag>,
/// Token used to retrieve the next page of results, or 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.v1beta1.PolicyTagManager.GetPolicyTag].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPolicyTagRequest {
/// Required. Resource name of the requested 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;
/// The policy tag manager API service allows clients to manage their taxonomies
/// and policy tags.
#[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 the specified project.
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.v1beta1.PolicyTagManager/CreateTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"CreateTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a taxonomy. This operation will also delete all
/// policy tags in this taxonomy along with their associated policies.
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.v1beta1.PolicyTagManager/DeleteTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"DeleteTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a taxonomy.
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.v1beta1.PolicyTagManager/UpdateTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"UpdateTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all taxonomies in a project in a particular location that the caller
/// has 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.v1beta1.PolicyTagManager/ListTaxonomies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.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.v1beta1.PolicyTagManager/GetTaxonomy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"GetTaxonomy",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a policy tag in the specified 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.v1beta1.PolicyTagManager/CreatePolicyTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"CreatePolicyTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a policy tag. Also deletes all of its descendant policy tags.
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.v1beta1.PolicyTagManager/DeletePolicyTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"DeletePolicyTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a 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.v1beta1.PolicyTagManager/UpdatePolicyTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.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.v1beta1.PolicyTagManager/ListPolicyTags",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.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.v1beta1.PolicyTagManager/GetPolicyTag",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"GetPolicyTag",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the IAM policy for a taxonomy or a policy tag.
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.v1beta1.PolicyTagManager/GetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"GetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Sets the IAM policy for a taxonomy or a policy tag.
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.v1beta1.PolicyTagManager/SetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"SetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns the permissions that a caller has on the specified taxonomy or
/// policy tag.
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.v1beta1.PolicyTagManager/TestIamPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManager",
"TestIamPermissions",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Message capturing a taxonomy and its policy tag hierarchy as a nested proto.
/// Used for taxonomy import/export and mutation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SerializedTaxonomy {
/// Required. Display name of the taxonomy. Max 200 bytes when encoded in
/// UTF-8.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
/// Description of the serialized taxonomy. The length of the
/// description is limited to 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 for a taxonomy.
#[prost(enumeration = "taxonomy::PolicyType", repeated, tag = "4")]
pub activated_policy_types: ::prost::alloc::vec::Vec<i32>,
}
/// Message representing one policy tag when exported as a nested proto.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SerializedPolicyTag {
/// Resource name of the policy tag.
///
/// This field will be ignored when calling ImportTaxonomies.
#[prost(string, tag = "1")]
pub policy_tag: ::prost::alloc::string::String,
/// Required. Display name of the policy tag. Max 200 bytes when encoded in
/// UTF-8.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Description of the serialized policy tag. The length of the
/// description is limited to 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
/// [ImportTaxonomies][google.cloud.datacatalog.v1beta1.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 be imported.
#[prost(oneof = "import_taxonomies_request::Source", tags = "2")]
pub source: ::core::option::Option<import_taxonomies_request::Source>,
}
/// Nested message and enum types in `ImportTaxonomiesRequest`.
pub mod import_taxonomies_request {
/// Source taxonomies to be imported.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// Inline source used for taxonomies to be imported.
#[prost(message, tag = "2")]
InlineSource(super::InlineSource),
}
}
/// Inline source used for taxonomies import.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InlineSource {
/// Required. Taxonomies to be imported.
#[prost(message, repeated, tag = "1")]
pub taxonomies: ::prost::alloc::vec::Vec<SerializedTaxonomy>,
}
/// Response message for
/// [ImportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportTaxonomiesResponse {
/// Taxonomies that were imported.
#[prost(message, repeated, tag = "1")]
pub taxonomies: ::prost::alloc::vec::Vec<Taxonomy>,
}
/// Request message for
/// [ExportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportTaxonomiesRequest {
/// Required. Resource name of the project that taxonomies to be exported
/// will share.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Resource names of the taxonomies to be exported.
#[prost(string, repeated, tag = "2")]
pub taxonomies: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Required. Taxonomies export destination.
#[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. Taxonomies export destination.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Destination {
/// Export taxonomies as serialized taxonomies.
#[prost(bool, tag = "3")]
SerializedTaxonomies(bool),
}
}
/// Response message for
/// [ExportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportTaxonomiesResponse {
/// List of taxonomies and policy tags in a tree structure.
#[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 clients to manipulate
/// their taxonomies and policy tags data with serialized format.
#[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
}
/// Imports all taxonomies and their policy tags to a project as new
/// taxonomies.
///
/// This method provides a bulk taxonomy / policy tag creation using nested
/// proto structure.
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.v1beta1.PolicyTagManagerSerialization/ImportTaxonomies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization",
"ImportTaxonomies",
),
);
self.inner.unary(req, path, codec).await
}
/// Exports all taxonomies and their policy tags in a project.
///
/// This method generates SerializedTaxonomy protos with nested policy tags
/// that can be used as an input for future 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.v1beta1.PolicyTagManagerSerialization/ExportTaxonomies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization",
"ExportTaxonomies",
),
);
self.inner.unary(req, path, codec).await
}
}
}