1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146 15147 15148 15149 15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403 15404 15405 15406 15407 15408 15409 15410 15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447 15448 15449 15450 15451 15452 15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548 15549 15550 15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667 15668 15669 15670 15671 15672 15673 15674 15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719 15720 15721 15722 15723 15724 15725 15726 15727 15728 15729 15730 15731 15732 15733 15734 15735 15736 15737 15738 15739 15740 15741 15742 15743 15744 15745 15746 15747 15748 15749 15750 15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845 15846 15847 15848 15849 15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899 15900 15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 15923 15924 15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968 15969 15970 15971 15972 15973 15974 15975 15976 15977 15978 15979 15980 15981 15982 15983 15984 15985 15986 15987 15988 15989 15990 15991 15992 15993 15994 15995 15996 15997 15998 15999 16000 16001 16002 16003 16004 16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061 16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073 16074 16075 16076 16077 16078 16079 16080 16081 16082 16083 16084 16085 16086 16087 16088 16089 16090 16091 16092 16093 16094 16095 16096 16097 16098 16099 16100 16101 16102 16103 16104 16105 16106 16107 16108 16109 16110 16111 16112 16113 16114 16115 16116 16117 16118 16119 16120 16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 16141 16142 16143 16144 16145 16146 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157 16158 16159 16160 16161 16162 16163 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204 16205 16206 16207 16208 16209 16210 16211 16212 16213 16214 16215 16216 16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263 16264 16265 16266 16267 16268 16269 16270 16271 16272 16273 16274 16275 16276 16277 16278 16279 16280 16281 16282 16283 16284 16285 16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 16323 16324 16325 16326 16327 16328 16329 16330 16331 16332 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342 16343 16344 16345 16346 16347 16348 16349 16350 16351 16352 16353 16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389 16390 16391 16392 16393 16394 16395 16396 16397 16398 16399 16400 16401 16402 16403 16404 16405 16406 16407 16408 16409 16410 16411 16412 16413 16414 16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435 16436 16437 16438 16439 16440 16441 16442 16443 16444 16445 16446 16447 16448 16449 16450 16451 16452 16453 16454 16455 16456 16457 16458 16459 16460 16461 16462 16463 16464 16465 16466 16467 16468 16469 16470 16471 16472 16473 16474 16475 16476 16477 16478 16479 16480 16481 16482 16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522 16523 16524 16525 16526 16527 16528 16529 16530 16531 16532 16533 16534 16535 16536 16537 16538 16539 16540 16541 16542 16543 16544 16545 16546 16547 16548 16549 16550 16551 16552 16553 16554 16555 16556 16557 16558 16559 16560 16561 16562 16563 16564 16565 16566 16567 16568 16569 16570 16571 16572 16573 16574 16575 16576 16577 16578 16579 16580 16581 16582 16583 16584 16585 16586 16587 16588 16589 16590 16591 16592 16593 16594 16595 16596 16597 16598 16599 16600 16601 16602 16603 16604 16605 16606 16607 16608 16609 16610 16611 16612 16613 16614 16615 16616 16617 16618 16619 16620 16621 16622 16623 16624 16625 16626 16627 16628 16629 16630 16631 16632 16633 16634 16635 16636 16637 16638 16639 16640 16641 16642 16643 16644 16645 16646 16647 16648 16649 16650 16651 16652 16653 16654 16655 16656 16657 16658 16659 16660 16661 16662 16663 16664 16665 16666 16667 16668 16669 16670 16671 16672 16673 16674 16675 16676 16677 16678 16679 16680 16681 16682 16683 16684 16685 16686 16687 16688 16689 16690 16691 16692 16693 16694 16695 16696 16697 16698 16699 16700 16701 16702 16703 16704 16705 16706 16707 16708 16709 16710 16711 16712 16713 16714 16715 16716 16717 16718 16719 16720 16721 16722 16723 16724 16725 16726 16727 16728 16729 16730 16731 16732 16733 16734 16735 16736 16737 16738 16739 16740 16741 16742 16743 16744 16745 16746 16747 16748 16749 16750 16751 16752 16753 16754 16755 16756 16757 16758 16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769 16770 16771 16772 16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 16787 16788 16789 16790 16791 16792 16793 16794 16795 16796 16797 16798 16799 16800 16801 16802 16803 16804 16805 16806 16807 16808 16809 16810 16811 16812 16813 16814 16815 16816 16817 16818 16819 16820 16821 16822 16823 16824 16825 16826 16827 16828 16829 16830 16831 16832 16833 16834 16835 16836 16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850 16851 16852 16853 16854 16855 16856 16857 16858 16859 16860 16861 16862 16863 16864 16865 16866 16867 16868 16869 16870 16871 16872 16873 16874 16875 16876 16877 16878 16879 16880 16881 16882 16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942 16943 16944 16945 16946 16947 16948 16949 16950 16951 16952 16953 16954 16955 16956 16957 16958 16959 16960 16961 16962 16963 16964 16965 16966 16967 16968 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980 16981 16982 16983 16984 16985 16986 16987 16988 16989 16990 16991 16992 16993 16994 16995 16996 16997 16998 16999 17000 17001 17002 17003 17004 17005 17006 17007 17008 17009 17010 17011 17012 17013 17014 17015 17016 17017 17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051 17052 17053 17054 17055 17056 17057 17058 17059 17060 17061 17062 17063 17064 17065 17066 17067 17068 17069 17070 17071 17072 17073 17074 17075 17076 17077 17078 17079 17080 17081 17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095 17096 17097 17098 17099 17100 17101 17102 17103 17104 17105 17106 17107 17108 17109 17110 17111 17112 17113 17114 17115 17116 17117 17118 17119 17120 17121 17122 17123 17124 17125 17126 17127 17128 17129 17130 17131 17132 17133 17134 17135 17136 17137 17138 17139 17140 17141 17142 17143 17144 17145 17146 17147 17148 17149 17150 17151 17152 17153 17154 17155 17156 17157 17158 17159 17160 17161 17162 17163 17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 17174 17175 17176 17177 17178 17179 17180 17181 17182 17183 17184 17185 17186 17187 17188 17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200 17201 17202 17203 17204 17205 17206 17207 17208 17209 17210 17211 17212 17213 17214 17215 17216 17217 17218 17219 17220 17221 17222 17223 17224 17225 17226 17227 17228 17229 17230 17231 17232 17233 17234 17235 17236 17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 17253 17254 17255 17256 17257 17258 17259 17260 17261 17262 17263 17264 17265 17266 17267 17268 17269 17270 17271 17272 17273 17274 17275 17276 17277 17278 17279 17280 17281 17282 17283 17284 17285 17286 17287 17288 17289 17290 17291 17292 17293 17294 17295 17296 17297 17298 17299 17300 17301 17302 17303 17304 17305 17306 17307 17308 17309 17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 17325 17326 17327 17328 17329 17330 17331 17332 17333 17334 17335 17336 17337 17338 17339 17340 17341 17342 17343 17344 17345 17346 17347 17348 17349 17350 17351 17352 17353 17354 17355 17356 17357 17358 17359 17360 17361 17362 17363 17364 17365 17366 17367 17368 17369 17370 17371 17372 17373 17374 17375 17376 17377 17378 17379 17380 17381 17382 17383 17384 17385 17386 17387 17388 17389 17390 17391 17392 17393 17394 17395 17396 17397 17398 17399 17400 17401 17402 17403 17404 17405 17406 17407 17408 17409 17410 17411 17412 17413 17414 17415 17416 17417 17418 17419 17420 17421 17422 17423 17424 17425 17426 17427 17428 17429 17430 17431 17432 17433 17434 17435 17436 17437 17438 17439 17440 17441 17442 17443 17444 17445 17446 17447 17448 17449 17450 17451 17452 17453 17454 17455 17456 17457 17458 17459 17460 17461 17462 17463 17464 17465 17466 17467 17468 17469 17470 17471 17472 17473 17474 17475 17476 17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489 17490 17491 17492 17493 17494 17495 17496 17497 17498 17499 17500 17501 17502 17503 17504 17505 17506 17507 17508 17509 17510 17511 17512 17513 17514 17515 17516 17517 17518 17519 17520 17521 17522 17523 17524 17525 17526 17527 17528 17529 17530 17531 17532 17533 17534 17535 17536 17537 17538 17539 17540 17541 17542 17543 17544 17545 17546 17547 17548 17549 17550 17551 17552 17553 17554 17555 17556 17557 17558 17559 17560 17561 17562 17563 17564 17565 17566 17567 17568 17569 17570 17571 17572 17573 17574 17575 17576 17577 17578 17579 17580 17581 17582 17583 17584 17585 17586 17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 17603 17604 17605 17606 17607 17608 17609 17610 17611 17612 17613 17614 17615 17616 17617 17618 17619 17620 17621 17622 17623 17624 17625 17626 17627 17628 17629 17630 17631 17632 17633 17634 17635 17636 17637 17638 17639 17640 17641 17642 17643 17644 17645 17646 17647 17648 17649 17650 17651 17652 17653 17654 17655 17656 17657 17658 17659 17660 17661 17662 17663 17664 17665 17666 17667 17668 17669 17670 17671 17672 17673 17674 17675 17676 17677 17678 17679 17680 17681 17682 17683 17684 17685 17686 17687 17688 17689 17690 17691 17692 17693 17694 17695 17696 17697 17698 17699 17700 17701 17702 17703 17704 17705 17706 17707 17708 17709 17710 17711 17712 17713 17714 17715 17716 17717 17718 17719 17720 17721 17722 17723 17724 17725 17726 17727 17728 17729 17730 17731 17732 17733 17734 17735 17736 17737 17738 17739 17740 17741 17742 17743 17744 17745 17746 17747 17748 17749 17750 17751 17752 17753 17754 17755 17756 17757 17758 17759 17760 17761 17762 17763 17764 17765 17766 17767 17768 17769 17770 17771 17772 17773 17774 17775 17776 17777 17778 17779 17780 17781 17782 17783 17784 17785 17786 17787 17788 17789 17790 17791 17792 17793 17794 17795 17796 17797 17798 17799 17800 17801 17802 17803 17804 17805 17806 17807 17808 17809 17810 17811 17812 17813 17814 17815 17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 17844 17845 17846 17847 17848 17849 17850 17851 17852 17853 17854 17855 17856 17857 17858 17859 17860 17861 17862 17863 17864 17865 17866 17867 17868 17869 17870 17871 17872 17873 17874 17875 17876 17877 17878 17879 17880 17881 17882 17883 17884 17885 17886 17887 17888 17889 17890 17891 17892 17893 17894 17895 17896 17897 17898 17899 17900 17901 17902 17903 17904 17905 17906 17907 17908 17909 17910 17911 17912 17913 17914 17915 17916 17917 17918 17919 17920 17921 17922 17923 17924 17925 17926 17927 17928 17929 17930 17931 17932 17933 17934 17935 17936 17937 17938 17939 17940 17941 17942 17943 17944 17945 17946 17947 17948 17949 17950 17951 17952 17953 17954 17955 17956 17957 17958 17959 17960 17961 17962 17963 17964 17965 17966 17967 17968 17969 17970 17971 17972 17973 17974 17975 17976 17977 17978 17979 17980 17981 17982 17983 17984 17985 17986 17987 17988 17989 17990 17991 17992 17993 17994 17995 17996 17997 17998 17999 18000 18001 18002 18003 18004 18005 18006 18007 18008 18009 18010 18011 18012 18013 18014 18015 18016 18017 18018 18019 18020 18021 18022 18023 18024 18025 18026 18027 18028 18029 18030 18031 18032 18033 18034 18035 18036 18037 18038 18039 18040 18041 18042 18043 18044 18045 18046 18047 18048 18049 18050 18051 18052 18053 18054 18055 18056 18057 18058 18059 18060 18061 18062 18063 18064 18065 18066 18067 18068 18069 18070 18071 18072 18073 18074 18075 18076 18077 18078 18079 18080 18081 18082 18083 18084 18085 18086 18087 18088 18089 18090 18091 18092 18093 18094 18095 18096 18097 18098 18099 18100 18101 18102 18103 18104 18105 18106 18107 18108 18109 18110 18111 18112 18113 18114 18115 18116 18117 18118 18119 18120 18121 18122 18123 18124 18125 18126 18127 18128 18129 18130 18131 18132 18133 18134 18135 18136 18137 18138 18139 18140 18141 18142 18143 18144 18145 18146 18147 18148 18149 18150 18151 18152 18153 18154 18155 18156 18157 18158 18159 18160 18161 18162 18163 18164 18165 18166 18167 18168 18169 18170 18171 18172 18173 18174 18175 18176 18177 18178 18179 18180 18181 18182 18183 18184 18185 18186 18187 18188 18189 18190 18191 18192 18193 18194 18195 18196 18197 18198 18199 18200 18201 18202 18203 18204 18205 18206 18207 18208 18209 18210 18211 18212 18213 18214 18215 18216 18217 18218 18219 18220 18221 18222 18223 18224 18225 18226 18227 18228 18229 18230 18231 18232 18233 18234 18235 18236 18237 18238 18239 18240 18241 18242 18243 18244 18245 18246 18247 18248 18249 18250 18251 18252 18253 18254 18255 18256 18257 18258 18259 18260 18261 18262 18263 18264 18265 18266 18267 18268 18269 18270 18271 18272 18273 18274 18275 18276 18277 18278 18279 18280 18281 18282 18283 18284 18285 18286 18287 18288 18289 18290 18291 18292 18293 18294 18295 18296 18297 18298 18299 18300 18301 18302 18303 18304 18305 18306 18307 18308 18309 18310 18311 18312 18313 18314 18315 18316 18317 18318 18319 18320 18321 18322 18323 18324 18325 18326 18327 18328 18329 18330 18331 18332 18333 18334 18335 18336 18337 18338 18339 18340 18341 18342 18343 18344 18345 18346 18347 18348 18349 18350 18351 18352 18353 18354 18355 18356 18357 18358 18359 18360 18361 18362 18363 18364 18365 18366 18367 18368 18369 18370 18371 18372 18373 18374 18375 18376 18377 18378 18379 18380 18381 18382 18383 18384 18385 18386 18387 18388 18389 18390 18391 18392 18393 18394 18395 18396 18397 18398 18399 18400 18401 18402 18403 18404 18405 18406 18407 18408 18409 18410 18411 18412 18413 18414 18415 18416 18417 18418 18419 18420 18421 18422 18423 18424 18425 18426 18427 18428 18429 18430 18431 18432 18433 18434 18435 18436 18437 18438 18439 18440 18441 18442 18443 18444 18445 18446 18447 18448 18449 18450 18451 18452 18453 18454 18455 18456 18457 18458 18459 18460 18461 18462 18463 18464 18465 18466 18467 18468 18469 18470 18471 18472 18473 18474 18475 18476 18477 18478 18479 18480 18481 18482 18483 18484 18485 18486 18487 18488 18489 18490 18491 18492 18493 18494 18495 18496 18497 18498 18499 18500 18501 18502 18503 18504 18505 18506 18507 18508 18509 18510 18511 18512 18513 18514 18515 18516 18517 18518 18519 18520 18521 18522 18523 18524 18525 18526 18527 18528 18529 18530 18531 18532 18533 18534 18535 18536 18537 18538 18539 18540 18541 18542 18543 18544 18545 18546 18547 18548 18549 18550 18551 18552 18553 18554 18555 18556 18557 18558 18559 18560 18561 18562 18563 18564 18565 18566 18567 18568 18569 18570 18571 18572 18573 18574 18575 18576 18577 18578 18579 18580 18581 18582 18583 18584 18585 18586 18587 18588 18589 18590 18591 18592 18593 18594 18595 18596 18597 18598 18599 18600 18601 18602 18603 18604 18605 18606 18607 18608 18609 18610 18611 18612 18613 18614 18615 18616 18617 18618 18619 18620 18621 18622 18623 18624 18625 18626 18627 18628 18629 18630 18631 18632 18633 18634 18635 18636 18637 18638 18639 18640 18641 18642 18643 18644 18645 18646 18647 18648 18649 18650 18651 18652 18653 18654 18655 18656 18657 18658 18659 18660 18661 18662 18663 18664 18665 18666 18667 18668 18669 18670 18671 18672 18673 18674 18675 18676 18677 18678 18679 18680 18681 18682 18683 18684 18685 18686 18687 18688 18689 18690 18691 18692 18693 18694 18695 18696 18697 18698 18699 18700 18701 18702 18703 18704 18705 18706 18707 18708 18709 18710 18711 18712 18713 18714 18715 18716 18717 18718 18719 18720 18721 18722 18723 18724 18725 18726 18727 18728 18729 18730 18731 18732 18733 18734 18735 18736 18737 18738 18739 18740 18741 18742 18743 18744 18745 18746 18747 18748 18749 18750 18751 18752 18753 18754 18755 18756 18757 18758 18759 18760 18761 18762 18763 18764 18765 18766 18767 18768 18769 18770 18771 18772 18773 18774 18775 18776 18777 18778 18779 18780 18781 18782 18783 18784 18785 18786 18787 18788 18789 18790 18791 18792 18793 18794 18795 18796 18797 18798 18799 18800 18801 18802 18803 18804 18805 18806 18807 18808 18809 18810 18811 18812 18813 18814 18815 18816 18817 18818 18819 18820 18821 18822 18823 18824 18825 18826 18827 18828 18829 18830 18831 18832 18833 18834 18835 18836 18837 18838 18839 18840 18841 18842 18843 18844 18845 18846 18847 18848 18849 18850 18851 18852 18853 18854 18855 18856 18857 18858 18859 18860 18861 18862 18863 18864 18865 18866 18867 18868 18869 18870 18871 18872 18873 18874 18875 18876 18877 18878 18879 18880 18881 18882 18883 18884 18885 18886 18887 18888 18889 18890 18891 18892 18893 18894 18895 18896 18897 18898 18899 18900 18901 18902 18903 18904 18905 18906 18907 18908 18909 18910 18911 18912 18913 18914 18915 18916 18917 18918 18919 18920 18921 18922 18923 18924 18925 18926 18927 18928 18929 18930 18931 18932 18933 18934 18935 18936 18937 18938 18939 18940 18941 18942 18943 18944 18945 18946 18947 18948 18949 18950 18951 18952 18953 18954 18955 18956 18957 18958 18959 18960 18961 18962 18963 18964 18965 18966 18967 18968 18969 18970 18971 18972 18973 18974 18975 18976 18977 18978 18979 18980 18981 18982 18983 18984 18985 18986 18987 18988 18989 18990 18991 18992 18993 18994 18995 18996 18997 18998 18999 19000 19001 19002 19003 19004 19005 19006 19007 19008 19009 19010 19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 19031 19032 19033 19034 19035 19036 19037 19038 19039 19040 19041 19042 19043 19044 19045 19046 19047 19048 19049 19050 19051 19052 19053 19054 19055 19056 19057 19058 19059 19060 19061 19062 19063 19064 19065 19066 19067 19068 19069 19070 19071 19072 19073 19074 19075 19076 19077 19078 19079 19080 19081 19082 19083 19084 19085 19086 19087 19088 19089 19090 19091 19092 19093 19094 19095 19096 19097 19098 19099 19100 19101 19102 19103 19104 19105 19106 19107 19108 19109 19110 19111 19112 19113 19114 19115 19116 19117 19118 19119 19120 19121 19122 19123 19124 19125 19126 19127 19128 19129 19130 19131 19132 19133 19134 19135 19136 19137 19138 19139 19140 19141 19142 19143 19144 19145 19146 19147 19148 19149 19150 19151 19152 19153 19154 19155 19156 19157 19158 19159 19160 19161 19162 19163 19164 19165 19166 19167 19168 19169 19170 19171 19172 19173 19174 19175 19176 19177 19178 19179 19180 19181 19182 19183 19184 19185 19186 19187 19188 19189 19190 19191 19192 19193 19194 19195 19196 19197 19198 19199 19200 19201 19202 19203 19204 19205 19206 19207 19208 19209 19210 19211 19212 19213 19214 19215 19216 19217 19218 19219 19220 19221 19222 19223 19224 19225 19226 19227 19228 19229 19230 19231 19232 19233 19234 19235 19236 19237 19238 19239 19240 19241 19242 19243 19244 19245 19246 19247 19248 19249 19250 19251 19252 19253 19254 19255 19256 19257 19258 19259 19260 19261 19262 19263 19264 19265 19266 19267 19268 19269 19270 19271 19272 19273 19274 19275 19276 19277 19278 19279 19280 19281 19282 19283 19284 19285 19286 19287 19288 19289 19290 19291 19292 19293 19294 19295 19296 19297 19298 19299 19300 19301 19302 19303 19304 19305 19306 19307 19308 19309 19310 19311 19312 19313 19314 19315 19316 19317 19318 19319 19320 19321 19322 19323 19324 19325 19326 19327 19328 19329 19330 19331 19332 19333 19334 19335 19336 19337 19338 19339 19340 19341 19342 19343 19344 19345 19346 19347 19348 19349 19350 19351 19352 19353 19354 19355 19356 19357 19358 19359 19360 19361 19362 19363 19364 19365 19366 19367 19368 19369 19370 19371 19372 19373 19374 19375 19376 19377 19378 19379 19380 19381 19382 19383 19384 19385 19386 19387 19388 19389 19390 19391 19392 19393 19394 19395 19396 19397 19398 19399 19400 19401 19402 19403 19404 19405 19406 19407 19408 19409 19410 19411 19412 19413 19414 19415 19416 19417 19418 19419 19420 19421 19422 19423 19424 19425 19426 19427 19428 19429 19430 19431 19432 19433 19434 19435 19436 19437 19438 19439 19440 19441 19442 19443 19444 19445 19446 19447 19448 19449 19450 19451 19452 19453 19454 19455 19456 19457 19458 19459 19460 19461 19462 19463 19464 19465 19466 19467 19468 19469 19470 19471 19472 19473 19474 19475 19476 19477 19478 19479 19480 19481 19482 19483 19484 19485 19486 19487 19488 19489 19490 19491 19492 19493 19494 19495 19496 19497 19498 19499 19500 19501 19502 19503 19504 19505 19506 19507 19508 19509 19510 19511 19512 19513 19514 19515 19516 19517 19518 19519 19520 19521 19522 19523 19524 19525 19526 19527 19528 19529 19530 19531 19532 19533 19534 19535 19536 19537 19538 19539 19540 19541 19542 19543 19544 19545 19546 19547 19548 19549 19550 19551 19552 19553 19554 19555 19556 19557 19558 19559 19560 19561 19562 19563 19564 19565 19566 19567 19568 19569 19570 19571 19572 19573 19574 19575 19576 19577 19578 19579 19580 19581 19582 19583 19584 19585 19586 19587 19588 19589 19590 19591 19592 19593 19594 19595 19596 19597 19598 19599 19600 19601 19602 19603 19604 19605 19606 19607 19608 19609 19610 19611 19612 19613 19614 19615 19616 19617 19618 19619 19620 19621 19622 19623 19624 19625 19626 19627 19628 19629 19630 19631 19632 19633 19634 19635 19636 19637 19638 19639 19640 19641 19642 19643 19644 19645 19646 19647 19648 19649 19650 19651 19652 19653 19654 19655 19656 19657 19658 19659 19660 19661 19662 19663 19664 19665 19666 19667 19668 19669 19670 19671 19672 19673 19674 19675 19676 19677 19678 19679 19680 19681 19682 19683 19684 19685 19686 19687 19688 19689 19690 19691 19692 19693 19694 19695 19696 19697 19698 19699 19700 19701 19702 19703 19704 19705 19706 19707 19708 19709 19710 19711 19712 19713 19714 19715 19716 19717 19718 19719 19720 19721 19722 19723 19724 19725 19726 19727 19728 19729 19730 19731 19732 19733 19734 19735 19736 19737 19738 19739 19740 19741 19742 19743 19744 19745 19746 19747 19748 19749 19750 19751 19752 19753 19754 19755 19756 19757 19758 19759 19760 19761 19762 19763 19764 19765 19766 19767 19768 19769 19770 19771 19772 19773 19774 19775 19776 19777 19778 19779 19780 19781 19782 19783 19784 19785 19786 19787 19788 19789 19790 19791 19792 19793 19794 19795 19796 19797 19798 19799 19800 19801 19802 19803 19804 19805 19806 19807 19808 19809 19810 19811 19812 19813 19814 19815 19816 19817 19818 19819 19820 19821 19822 19823 19824 19825 19826 19827 19828 19829 19830 19831 19832 19833 19834 19835 19836 19837 19838 19839 19840 19841 19842 19843 19844 19845 19846 19847 19848 19849 19850 19851 19852 19853 19854 19855 19856 19857 19858 19859 19860 19861 19862 19863 19864 19865 19866 19867 19868 19869 19870 19871 19872 19873 19874 19875 19876 19877 19878 19879 19880 19881 19882 19883 19884 19885 19886 19887 19888 19889 19890 19891 19892 19893 19894 19895 19896 19897 19898 19899 19900 19901 19902 19903 19904 19905 19906 19907 19908 19909 19910 19911 19912 19913 19914 19915 19916 19917 19918 19919 19920 19921 19922 19923 19924 19925 19926 19927 19928 19929 19930 19931 19932 19933 19934 19935 19936 19937 19938 19939 19940 19941 19942 19943 19944 19945 19946 19947 19948 19949 19950 19951 19952 19953 19954 19955 19956 19957 19958 19959 19960 19961 19962 19963 19964 19965 19966 19967 19968 19969 19970 19971 19972 19973 19974 19975 19976 19977 19978 19979 19980 19981 19982 19983 19984 19985 19986 19987 19988 19989 19990 19991 19992 19993 19994 19995 19996 19997 19998 19999 20000 20001 20002 20003 20004 20005 20006 20007 20008 20009 20010 20011 20012 20013 20014 20015 20016 20017 20018 20019 20020 20021 20022 20023 20024 20025 20026 20027 20028 20029 20030 20031 20032 20033 20034 20035 20036 20037 20038 20039 20040 20041 20042 20043 20044 20045 20046 20047 20048 20049 20050 20051 20052 20053 20054 20055 20056 20057 20058 20059 20060 20061 20062 20063 20064 20065 20066 20067 20068 20069 20070 20071 20072 20073 20074 20075 20076 20077 20078 20079 20080 20081 20082 20083 20084 20085 20086 20087 20088 20089 20090 20091 20092 20093 20094 20095 20096 20097 20098 20099 20100 20101 20102 20103 20104 20105 20106 20107 20108 20109 20110 20111 20112 20113 20114 20115 20116 20117 20118 20119 20120 20121 20122 20123 20124 20125 20126 20127 20128 20129 20130 20131 20132 20133 20134 20135 20136 20137 20138 20139 20140 20141 20142 20143 20144 20145 20146 20147 20148 20149 20150 20151 20152 20153 20154 20155 20156 20157 20158 20159 20160 20161 20162 20163 20164 20165 20166 20167 20168 20169 20170 20171 20172 20173 20174 20175 20176 20177 20178 20179 20180 20181 20182 20183 20184 20185 20186 20187 20188 20189 20190 20191 20192 20193 20194 20195 20196 20197 20198 20199 20200 20201 20202 20203 20204 20205 20206 20207 20208 20209 20210 20211 20212 20213 20214 20215 20216 20217 20218 20219 20220 20221 20222 20223 20224 20225 20226 20227 20228 20229 20230 20231 20232 20233 20234 20235 20236 20237 20238 20239 20240 20241 20242 20243 20244 20245 20246 20247 20248 20249 20250 20251 20252 20253 20254 20255 20256 20257 20258 20259 20260 20261 20262 20263 20264 20265 20266 20267 20268 20269 20270 20271 20272 20273 20274 20275 20276 20277 20278 20279 20280 20281 20282 20283 20284 20285 20286 20287 20288 20289 20290 20291 20292 20293 20294 20295 20296 20297 20298 20299 20300 20301 20302 20303 20304 20305 20306 20307 20308 20309 20310 20311 20312 20313 20314 20315 20316 20317 20318 20319 20320 20321 20322 20323 20324 20325 20326 20327 20328 20329 20330 20331 20332 20333 20334 20335 20336 20337 20338 20339 20340 20341 20342 20343 20344 20345 20346 20347 20348 20349 20350 20351 20352 20353 20354 20355 20356 20357 20358 20359 20360 20361 20362 20363 20364 20365 20366 20367 20368 20369 20370 20371 20372 20373 20374 20375 20376 20377 20378 20379 20380 20381 20382 20383 20384 20385 20386 20387 20388 20389 20390 20391 20392 20393 20394 20395 20396 20397 20398 20399 20400 20401 20402 20403 20404 20405 20406 20407 20408 20409 20410 20411 20412 20413 20414 20415 20416 20417 20418 20419 20420 20421 20422 20423 20424 20425 20426 20427 20428 20429 20430 20431 20432 20433 20434 20435 20436 20437 20438 20439 20440 20441 20442 20443 20444 20445 20446 20447 20448 20449 20450 20451 20452 20453 20454 20455 20456 20457 20458 20459 20460 20461 20462 20463 20464 20465 20466 20467 20468 20469 20470 20471 20472 20473 20474 20475 20476 20477 20478 20479 20480 20481 20482 20483 20484 20485 20486 20487 20488 20489 20490 20491 20492 20493 20494 20495 20496 20497 20498 20499 20500 20501 20502 20503 20504 20505 20506 20507 20508 20509 20510 20511 20512 20513 20514 20515 20516 20517 20518 20519 20520 20521 20522 20523 20524 20525 20526 20527 20528 20529 20530 20531 20532 20533 20534 20535 20536 20537 20538 20539 20540 20541 20542 20543 20544 20545 20546 20547 20548 20549 20550 20551 20552 20553 20554 20555 20556 20557 20558 20559 20560 20561 20562 20563 20564 20565 20566 20567 20568 20569 20570 20571 20572 20573 20574 20575 20576 20577 20578 20579 20580 20581 20582 20583 20584 20585 20586 20587 20588 20589 20590 20591 20592 20593 20594 20595 20596 20597 20598 20599 20600 20601 20602 20603 20604 20605 20606 20607 20608 20609 20610 20611 20612 20613 20614 20615 20616 20617 20618 20619 20620 20621 20622 20623 20624 20625 20626 20627 20628 20629 20630 20631 20632 20633 20634 20635 20636 20637 20638 20639 20640 20641 20642 20643 20644 20645 20646 20647 20648 20649 20650 20651 20652 20653 20654 20655 20656 20657 20658 20659 20660 20661 20662 20663 20664 20665 20666 20667 20668 20669 20670 20671 20672 20673 20674 20675 20676 20677 20678 20679 20680 20681 20682 20683 20684 20685 20686 20687 20688 20689 20690 20691 20692 20693 20694 20695 20696 20697 20698 20699 20700 20701 20702 20703 20704 20705 20706 20707 20708 20709 20710 20711 20712 20713 20714 20715 20716 20717 20718 20719 20720 20721 20722 20723 20724 20725 20726 20727 20728 20729 20730 20731 20732 20733 20734 20735 20736 20737 20738 20739 20740 20741 20742 20743 20744 20745 20746 20747 20748 20749 20750 20751 20752 20753 20754 20755 20756 20757 20758 20759 20760 20761 20762 20763 20764 20765 20766 20767 20768 20769 20770 20771 20772 20773 20774 20775 20776 20777 20778 20779 20780 20781 20782 20783 20784 20785 20786 20787 20788 20789 20790 20791 20792 20793 20794 20795 20796 20797 20798 20799 20800 20801 20802 20803 20804 20805 20806 20807 20808 20809 20810 20811 20812 20813 20814 20815 20816 20817 20818 20819 20820 20821 20822 20823 20824 20825 20826 20827 20828 20829 20830 20831 20832 20833 20834 20835 20836 20837 20838 20839 20840 20841 20842 20843 20844 20845 20846 20847 20848 20849 20850 20851 20852 20853 20854 20855 20856 20857 20858 20859 20860 20861 20862 20863 20864 20865 20866 20867 20868 20869 20870 20871 20872 20873 20874 20875 20876 20877 20878 20879 20880 20881 20882 20883 20884 20885 20886 20887 20888 20889 20890 20891 20892 20893 20894 20895 20896 20897 20898 20899 20900 20901 20902 20903 20904 20905 20906 20907 20908 20909 20910 20911 20912 20913 20914 20915 20916 20917 20918 20919 20920 20921 20922 20923 20924 20925 20926 20927 20928 20929 20930 20931 20932 20933 20934 20935 20936 20937 20938 20939 20940 20941 20942 20943 20944 20945 20946 20947 20948 20949 20950 20951 20952 20953 20954 20955 20956 20957 20958 20959 20960 20961 20962 20963 20964 20965 20966 20967 20968 20969 20970 20971 20972 20973 20974 20975 20976 20977 20978 20979 20980 20981 20982 20983 20984 20985 20986 20987 20988 20989 20990 20991 20992 20993 20994 20995 20996 20997 20998 20999 21000 21001 21002 21003 21004 21005 21006 21007 21008 21009 21010 21011 21012 21013 21014 21015 21016 21017 21018 21019 21020 21021 21022 21023 21024 21025 21026 21027 21028 21029 21030 21031 21032 21033 21034 21035 21036 21037 21038 21039 21040 21041 21042 21043 21044 21045 21046 21047 21048 21049 21050 21051 21052 21053 21054 21055 21056 21057 21058 21059 21060 21061 21062 21063 21064 21065 21066 21067 21068 21069 21070 21071 21072 21073 21074 21075 21076 21077 21078 21079 21080 21081 21082 21083 21084 21085 21086 21087 21088 21089 21090 21091 21092 21093 21094 21095 21096 21097 21098 21099 21100 21101 21102 21103 21104 21105 21106 21107 21108 21109 21110 21111 21112 21113 21114 21115 21116 21117 21118 21119 21120 21121 21122 21123 21124 21125 21126 21127 21128 21129 21130 21131 21132 21133 21134 21135 21136 21137 21138 21139 21140 21141 21142 21143 21144 21145 21146 21147 21148 21149 21150 21151 21152 21153 21154 21155 21156 21157 21158 21159 21160 21161 21162 21163 21164 21165 21166 21167 21168 21169 21170 21171 21172 21173 21174 21175 21176 21177 21178 21179 21180 21181 21182 21183 21184 21185 21186 21187 21188 21189 21190 21191 21192 21193 21194 21195 21196 21197 21198 21199 21200 21201 21202 21203 21204 21205 21206 21207 21208 21209 21210 21211 21212 21213 21214 21215 21216 21217 21218 21219 21220 21221 21222 21223 21224 21225 21226 21227 21228 21229 21230 21231 21232 21233 21234 21235 21236 21237 21238 21239 21240 21241 21242 21243 21244 21245 21246 21247 21248 21249 21250 21251 21252 21253 21254 21255 21256 21257 21258 21259 21260 21261 21262 21263 21264 21265 21266 21267 21268 21269 21270 21271 21272 21273 21274 21275 21276 21277 21278 21279 21280 21281 21282 21283 21284 21285 21286 21287 21288 21289 21290 21291 21292 21293 21294 21295 21296 21297 21298 21299 21300 21301 21302 21303 21304 21305 21306 21307 21308 21309 21310 21311 21312 21313 21314 21315 21316 21317 21318 21319 21320 21321 21322 21323 21324 21325 21326 21327 21328 21329 21330 21331 21332 21333 21334 21335 21336 21337 21338 21339 21340 21341 21342 21343 21344 21345 21346 21347 21348 21349 21350 21351 21352 21353 21354 21355 21356 21357 21358 21359 21360 21361 21362 21363 21364 21365 21366 21367 21368 21369 21370 21371 21372 21373 21374 21375 21376 21377 21378 21379 21380 21381 21382 21383 21384 21385 21386 21387 21388 21389 21390 21391 21392 21393 21394 21395 21396 21397 21398 21399 21400 21401 21402 21403 21404 21405 21406 21407 21408 21409 21410 21411 21412 21413 21414 21415 21416 21417 21418 21419 21420 21421 21422 21423 21424 21425 21426 21427 21428 21429 21430 21431 21432 21433 21434 21435 21436 21437 21438 21439 21440 21441 21442 21443 21444 21445 21446 21447 21448 21449 21450 21451 21452 21453 21454 21455 21456 21457 21458 21459 21460 21461 21462 21463 21464 21465 21466 21467 21468 21469 21470 21471 21472 21473 21474 21475 21476 21477 21478 21479 21480 21481 21482 21483 21484 21485 21486 21487 21488 21489 21490 21491 21492 21493 21494 21495 21496 21497 21498 21499 21500 21501 21502 21503 21504 21505 21506 21507 21508 21509 21510 21511 21512 21513 21514 21515 21516 21517 21518 21519 21520 21521 21522 21523 21524 21525 21526 21527 21528 21529 21530 21531 21532 21533 21534 21535 21536 21537 21538 21539 21540 21541 21542 21543 21544 21545 21546 21547 21548 21549 21550 21551 21552 21553 21554 21555 21556 21557 21558 21559 21560 21561 21562 21563 21564 21565 21566 21567 21568 21569 21570 21571 21572 21573 21574 21575 21576 21577 21578 21579 21580 21581 21582 21583 21584 21585 21586 21587 21588 21589 21590 21591 21592 21593 21594 21595 21596 21597 21598 21599 21600 21601 21602 21603 21604 21605 21606 21607 21608 21609 21610 21611 21612 21613 21614 21615 21616 21617 21618 21619 21620 21621 21622 21623 21624 21625 21626 21627 21628 21629 21630 21631 21632 21633 21634 21635 21636 21637 21638 21639 21640 21641 21642 21643 21644 21645 21646 21647 21648 21649 21650 21651 21652 21653 21654 21655 21656 21657 21658 21659 21660 21661 21662 21663 21664 21665 21666 21667 21668 21669 21670 21671 21672 21673 21674 21675 21676 21677 21678 21679 21680 21681 21682 21683 21684 21685 21686 21687 21688 21689 21690 21691 21692 21693 21694 21695 21696 21697 21698 21699 21700 21701 21702 21703 21704 21705 21706 21707 21708 21709 21710 21711 21712 21713 21714 21715 21716 21717 21718 21719 21720 21721 21722 21723 21724 21725 21726 21727 21728 21729 21730 21731 21732 21733 21734 21735 21736 21737 21738 21739 21740 21741 21742 21743 21744 21745 21746 21747 21748 21749 21750 21751 21752 21753 21754 21755 21756 21757 21758 21759 21760 21761 21762 21763 21764 21765 21766 21767 21768 21769 21770 21771 21772 21773 21774 21775 21776 21777 21778 21779 21780 21781 21782 21783 21784 21785 21786 21787 21788 21789 21790 21791 21792 21793 21794 21795 21796 21797 21798 21799 21800 21801 21802 21803 21804 21805 21806 21807 21808 21809 21810 21811 21812 21813 21814 21815 21816 21817 21818 21819 21820 21821 21822 21823 21824 21825 21826 21827 21828 21829 21830 21831 21832 21833 21834 21835 21836 21837 21838 21839 21840 21841 21842 21843 21844 21845 21846 21847 21848 21849 21850 21851 21852 21853 21854 21855 21856 21857 21858 21859 21860 21861 21862 21863 21864 21865 21866 21867 21868 21869 21870 21871 21872 21873 21874 21875 21876 21877 21878 21879 21880 21881 21882 21883 21884 21885 21886 21887 21888 21889 21890 21891 21892 21893 21894 21895 21896 21897 21898 21899 21900 21901 21902 21903 21904 21905 21906 21907 21908 21909 21910 21911 21912 21913 21914 21915 21916 21917 21918 21919 21920 21921 21922 21923 21924 21925 21926 21927 21928 21929 21930 21931 21932 21933 21934 21935 21936 21937 21938 21939 21940 21941 21942 21943 21944 21945 21946 21947 21948 21949 21950 21951 21952 21953 21954 21955 21956 21957 21958 21959 21960 21961 21962 21963 21964 21965 21966 21967 21968 21969 21970 21971 21972 21973 21974 21975 21976 21977 21978 21979 21980 21981 21982 21983 21984 21985 21986 21987 21988 21989 21990 21991 21992 21993 21994 21995 21996 21997 21998 21999 22000 22001 22002 22003 22004 22005 22006 22007 22008 22009 22010 22011 22012 22013 22014 22015 22016 22017 22018 22019 22020 22021 22022 22023 22024 22025 22026 22027 22028 22029 22030 22031 22032 22033 22034 22035 22036 22037 22038 22039 22040 22041 22042 22043 22044 22045 22046 22047 22048 22049 22050 22051 22052 22053 22054 22055 22056 22057 22058 22059 22060 22061 22062 22063 22064 22065 22066 22067 22068 22069 22070 22071 22072 22073 22074 22075 22076 22077 22078 22079 22080 22081 22082 22083 22084 22085 22086 22087 22088 22089 22090 22091 22092 22093 22094 22095 22096 22097 22098 22099 22100 22101 22102 22103 22104 22105 22106 22107 22108 22109 22110 22111 22112 22113 22114 22115 22116 22117 22118 22119 22120 22121 22122 22123 22124 22125 22126 22127 22128 22129 22130 22131 22132 22133 22134 22135 22136 22137 22138 22139 22140 22141 22142 22143 22144 22145 22146 22147 22148 22149 22150 22151 22152 22153 22154 22155 22156 22157 22158 22159 22160 22161 22162 22163 22164 22165 22166 22167 22168 22169 22170 22171 22172 22173 22174 22175 22176 22177 22178 22179 22180 22181 22182 22183 22184 22185 22186 22187 22188 22189 22190 22191 22192 22193 22194 22195 22196 22197 22198 22199 22200 22201 22202 22203 22204 22205 22206 22207 22208 22209 22210 22211 22212 22213 22214 22215 22216 22217 22218 22219 22220 22221 22222 22223 22224 22225 22226 22227 22228 22229 22230 22231 22232 22233 22234 22235 22236 22237 22238 22239 22240 22241 22242 22243 22244 22245 22246 22247 22248 22249 22250 22251 22252 22253 22254 22255 22256 22257 22258 22259 22260 22261 22262 22263 22264 22265 22266 22267 22268 22269 22270 22271 22272 22273 22274 22275 22276 22277 22278 22279 22280 22281 22282 22283 22284 22285 22286 22287 22288 22289 22290 22291 22292 22293 22294 22295 22296 22297 22298 22299 22300 22301 22302 22303 22304 22305 22306 22307 22308 22309 22310 22311 22312 22313 22314 22315 22316 22317 22318 22319 22320 22321 22322 22323 22324 22325 22326 22327 22328 22329 22330 22331 22332 22333 22334 22335 22336 22337 22338 22339 22340 22341 22342 22343 22344 22345 22346 22347 22348 22349 22350 22351 22352 22353 22354 22355 22356 22357 22358 22359 22360 22361 22362 22363 22364 22365 22366 22367 22368 22369 22370 22371 22372 22373 22374 22375 22376 22377 22378 22379 22380 22381 22382 22383 22384 22385 22386 22387 22388 22389 22390 22391 22392 22393 22394 22395 22396 22397 22398 22399 22400 22401 22402 22403 22404 22405 22406 22407 22408 22409 22410 22411 22412 22413 22414 22415 22416 22417 22418 22419 22420 22421 22422 22423 22424 22425 22426 22427 22428 22429 22430 22431 22432 22433 22434 22435 22436 22437 22438 22439 22440 22441 22442 22443 22444 22445 22446 22447 22448 22449 22450 22451 22452 22453 22454 22455 22456 22457 22458 22459 22460 22461 22462 22463 22464 22465 22466 22467 22468 22469 22470 22471 22472 22473 22474 22475 22476 22477 22478 22479 22480 22481 22482 22483 22484 22485 22486 22487 22488 22489 22490 22491 22492 22493 22494 22495 22496 22497 22498 22499 22500 22501 22502 22503 22504 22505 22506 22507 22508 22509 22510 22511 22512 22513 22514 22515 22516 22517 22518 22519 22520 22521 22522 22523 22524 22525 22526 22527 22528 22529 22530 22531 22532 22533 22534 22535 22536 22537 22538 22539 22540 22541 22542 22543 22544 22545 22546 22547 22548 22549 22550 22551 22552 22553 22554 22555 22556 22557 22558 22559 22560 22561 22562 22563 22564 22565 22566 22567 22568 22569 22570 22571 22572 22573 22574 22575 22576 22577 22578 22579 22580 22581 22582 22583 22584 22585 22586 22587 22588 22589 22590 22591 22592 22593 22594 22595 22596 22597 22598 22599 22600 22601 22602 22603 22604 22605 22606 22607 22608 22609 22610 22611 22612 22613 22614 22615 22616 22617 22618 22619 22620 22621 22622 22623 22624 22625 22626 22627 22628 22629 22630 22631 22632 22633 22634 22635 22636 22637 22638 22639 22640 22641 22642 22643 22644 22645 22646 22647 22648 22649 22650 22651 22652 22653 22654 22655 22656 22657 22658 22659 22660 22661 22662 22663 22664 22665 22666 22667 22668 22669 22670 22671 22672 22673 22674 22675 22676 22677 22678 22679 22680 22681 22682 22683 22684 22685 22686 22687 22688 22689 22690 22691 22692 22693 22694 22695 22696 22697 22698 22699 22700 22701 22702 22703 22704 22705 22706 22707 22708 22709 22710 22711 22712 22713 22714 22715 22716 22717 22718 22719 22720 22721 22722 22723 22724 22725 22726 22727 22728 22729 22730 22731 22732 22733 22734 22735 22736 22737 22738 22739 22740 22741 22742 22743 22744 22745 22746 22747 22748 22749 22750 22751 22752 22753 22754 22755 22756 22757 22758 22759 22760 22761 22762 22763 22764 22765 22766 22767 22768 22769 22770 22771 22772 22773 22774 22775 22776 22777 22778 22779 22780 22781 22782 22783 22784 22785 22786 22787 22788 22789 22790 22791 22792 22793 22794 22795 22796 22797 22798 22799 22800 22801 22802 22803 22804 22805 22806 22807 22808 22809 22810 22811 22812 22813 22814 22815 22816 22817 22818 22819 22820 22821 22822 22823 22824 22825 22826 22827 22828 22829 22830 22831 22832 22833 22834 22835 22836 22837 22838 22839 22840 22841 22842 22843 22844 22845 22846 22847 22848 22849 22850 22851 22852 22853 22854 22855 22856 22857 22858 22859 22860 22861 22862 22863 22864 22865 22866 22867 22868 22869 22870 22871 22872 22873 22874 22875 22876 22877 22878 22879 22880 22881 22882 22883 22884 22885 22886 22887 22888 22889 22890 22891 22892 22893 22894 22895 22896 22897 22898 22899 22900 22901 22902 22903 22904 22905 22906 22907 22908 22909 22910 22911 22912 22913 22914 22915 22916 22917 22918 22919 22920 22921 22922 22923 22924 22925 22926 22927 22928 22929 22930 22931 22932 22933 22934 22935 22936 22937 22938 22939 22940 22941 22942 22943 22944 22945 22946 22947 22948 22949 22950 22951 22952 22953 22954 22955 22956 22957 22958 22959 22960 22961 22962 22963 22964 22965 22966 22967 22968 22969 22970 22971 22972 22973 22974 22975 22976 22977 22978 22979 22980 22981 22982 22983 22984 22985 22986 22987 22988 22989 22990 22991 22992 22993 22994 22995 22996 22997 22998 22999 23000 23001 23002 23003 23004 23005 23006 23007 23008 23009 23010 23011 23012 23013 23014 23015 23016 23017 23018 23019 23020 23021 23022 23023 23024 23025 23026 23027 23028 23029 23030 23031 23032 23033 23034 23035 23036 23037 23038 23039 23040 23041 23042 23043 23044 23045 23046 23047 23048 23049 23050 23051 23052 23053 23054 23055 23056 23057 23058 23059 23060 23061 23062 23063 23064 23065 23066 23067 23068 23069 23070 23071 23072 23073 23074 23075 23076 23077 23078 23079 23080 23081 23082 23083 23084 23085 23086 23087 23088 23089 23090 23091 23092 23093 23094 23095 23096 23097 23098 23099 23100 23101 23102 23103 23104 23105 23106 23107 23108 23109 23110 23111 23112 23113 23114 23115 23116 23117 23118 23119 23120 23121 23122 23123 23124 23125 23126 23127 23128 23129 23130 23131 23132 23133 23134 23135 23136 23137 23138 23139 23140 23141 23142 23143 23144 23145 23146 23147 23148 23149 23150 23151 23152 23153 23154 23155 23156 23157 23158 23159 23160 23161 23162 23163 23164 23165 23166 23167 23168 23169 23170 23171 23172 23173 23174 23175 23176 23177 23178 23179 23180 23181 23182 23183 23184 23185 23186 23187 23188 23189 23190 23191 23192 23193 23194 23195 23196 23197 23198 23199 23200 23201 23202 23203 23204 23205 23206 23207 23208 23209 23210 23211 23212 23213 23214 23215 23216 23217 23218 23219 23220 23221 23222 23223 23224 23225 23226 23227 23228 23229 23230 23231 23232 23233 23234 23235 23236 23237 23238 23239 23240 23241 23242 23243 23244 23245 23246 23247 23248 23249 23250 23251 23252 23253 23254 23255 23256 23257 23258 23259 23260 23261 23262 23263 23264 23265 23266 23267 23268 23269 23270 23271 23272 23273 23274 23275 23276 23277 23278 23279 23280 23281 23282 23283 23284 23285 23286 23287 23288 23289 23290 23291 23292 23293 23294 23295 23296 23297 23298 23299 23300 23301 23302 23303 23304 23305 23306 23307 23308 23309 23310 23311 23312 23313 23314 23315 23316 23317 23318 23319 23320 23321 23322 23323 23324 23325 23326 23327 23328 23329 23330 23331 23332 23333 23334 23335 23336 23337 23338 23339 23340 23341 23342 23343 23344 23345 23346 23347 23348 23349 23350 23351 23352 23353 23354 23355 23356 23357 23358 23359 23360 23361 23362 23363 23364 23365 23366 23367 23368 23369 23370 23371 23372 23373 23374 23375 23376 23377 23378 23379 23380 23381 23382 23383 23384 23385 23386 23387 23388 23389 23390 23391 23392 23393 23394 23395 23396 23397 23398 23399 23400 23401 23402 23403 23404 23405 23406 23407 23408 23409 23410 23411 23412 23413 23414 23415 23416 23417 23418 23419 23420 23421 23422 23423 23424 23425 23426 23427 23428 23429 23430 23431 23432 23433 23434 23435 23436 23437 23438 23439 23440 23441 23442 23443 23444 23445 23446 23447 23448 23449 23450 23451 23452 23453 23454 23455 23456 23457 23458 23459 23460 23461 23462 23463 23464 23465 23466 23467 23468 23469 23470 23471 23472 23473 23474 23475 23476 23477 23478 23479 23480 23481 23482 23483 23484 23485 23486 23487 23488 23489 23490 23491 23492 23493 23494 23495 23496 23497 23498 23499 23500 23501 23502 23503 23504 23505 23506 23507 23508 23509 23510 23511 23512 23513 23514 23515 23516 23517 23518 23519 23520 23521 23522 23523 23524 23525 23526 23527 23528 23529 23530 23531 23532 23533 23534 23535 23536 23537 23538 23539 23540 23541 23542 23543 23544 23545 23546 23547 23548 23549 23550 23551 23552 23553 23554 23555 23556 23557 23558 23559 23560 23561 23562 23563 23564 23565 23566 23567 23568 23569 23570 23571 23572 23573 23574 23575 23576 23577 23578 23579 23580 23581 23582 23583 23584 23585 23586 23587 23588 23589 23590 23591 23592 23593 23594 23595 23596 23597 23598 23599 23600 23601 23602 23603 23604 23605 23606 23607 23608 23609 23610 23611 23612 23613 23614 23615 23616 23617 23618 23619 23620 23621 23622 23623 23624 23625 23626 23627 23628 23629 23630 23631 23632 23633 23634 23635 23636 23637 23638 23639 23640 23641 23642 23643 23644 23645 23646 23647 23648 23649 23650 23651 23652 23653 23654 23655 23656 23657 23658 23659 23660 23661 23662 23663 23664 23665 23666 23667 23668 23669 23670 23671 23672 23673 23674 23675 23676 23677 23678 23679 23680 23681 23682 23683 23684 23685 23686 23687 23688 23689 23690 23691 23692 23693 23694 23695 23696 23697 23698 23699 23700 23701 23702 23703 23704 23705 23706 23707 23708 23709 23710 23711 23712 23713 23714 23715 23716 23717 23718 23719 23720 23721 23722 23723 23724 23725 23726 23727 23728 23729 23730 23731 23732 23733 23734 23735 23736 23737 23738 23739 23740 23741 23742 23743 23744 23745 23746 23747 23748 23749 23750 23751 23752 23753 23754 23755 23756 23757 23758 23759 23760 23761 23762 23763 23764 23765 23766 23767 23768 23769 23770 23771 23772 23773 23774 23775 23776 23777 23778 23779 23780 23781 23782 23783 23784 23785 23786 23787 23788 23789 23790 23791 23792 23793 23794 23795 23796 23797 23798 23799 23800 23801 23802 23803 23804 23805 23806 23807 23808 23809 23810 23811 23812 23813 23814 23815 23816 23817 23818 23819 23820 23821 23822 23823 23824 23825 23826 23827 23828 23829 23830 23831 23832 23833 23834 23835 23836 23837 23838 23839 23840 23841 23842 23843 23844 23845 23846 23847 23848 23849 23850 23851 23852 23853 23854 23855 23856 23857 23858 23859 23860 23861 23862 23863 23864 23865 23866 23867 23868 23869 23870 23871 23872 23873 23874 23875 23876 23877 23878 23879 23880 23881 23882 23883 23884 23885 23886 23887 23888 23889 23890 23891 23892 23893 23894 23895 23896 23897 23898 23899 23900 23901 23902 23903 23904 23905 23906 23907 23908 23909 23910 23911 23912 23913 23914 23915 23916 23917 23918 23919 23920 23921 23922 23923 23924 23925 23926 23927 23928 23929 23930 23931 23932 23933 23934 23935 23936 23937 23938 23939 23940 23941 23942 23943 23944 23945 23946 23947 23948 23949 23950 23951 23952 23953 23954 23955 23956 23957 23958 23959 23960 23961 23962 23963 23964 23965 23966 23967 23968 23969 23970 23971 23972 23973 23974 23975 23976 23977 23978 23979 23980 23981 23982 23983 23984 23985 23986 23987 23988 23989 23990 23991 23992 23993 23994 23995 23996 23997 23998 23999 24000 24001 24002 24003 24004 24005 24006 24007 24008 24009 24010 24011 24012 24013 24014 24015 24016 24017 24018 24019 24020 24021 24022 24023 24024 24025 24026 24027 24028 24029 24030 24031 24032 24033 24034 24035 24036 24037 24038 24039 24040 24041 24042 24043 24044 24045 24046 24047 24048 24049 24050 24051 24052 24053 24054 24055 24056 24057 24058 24059 24060 24061 24062 24063 24064 24065 24066 24067 24068 24069 24070 24071 24072 24073 24074 24075 24076 24077 24078 24079 24080 24081 24082 24083 24084 24085 24086 24087 24088 24089 24090 24091 24092 24093 24094 24095 24096 24097 24098 24099 24100 24101 24102 24103 24104 24105 24106 24107 24108 24109 24110 24111 24112 24113 24114 24115 24116 24117 24118 24119 24120 24121 24122 24123 24124 24125 24126 24127 24128 24129 24130 24131 24132 24133 24134 24135 24136 24137 24138 24139 24140 24141 24142 24143 24144 24145 24146 24147 24148 24149 24150 24151 24152 24153 24154 24155 24156 24157 24158 24159 24160 24161 24162 24163 24164 24165 24166 24167 24168 24169 24170 24171 24172 24173 24174 24175 24176 24177 24178 24179 24180 24181 24182 24183 24184 24185 24186 24187 24188 24189 24190 24191 24192 24193 24194 24195 24196 24197 24198 24199 24200 24201 24202 24203 24204 24205 24206 24207 24208 24209 24210 24211 24212 24213 24214 24215 24216 24217 24218 24219 24220 24221 24222 24223 24224 24225 24226 24227 24228 24229 24230 24231 24232 24233 24234 24235 24236 24237 24238 24239 24240 24241 24242 24243 24244 24245 24246 24247 24248 24249 24250 24251 24252 24253 24254 24255 24256 24257 24258 24259 24260 24261 24262 24263 24264 24265 24266 24267 24268 24269 24270 24271 24272 24273 24274 24275 24276 24277 24278 24279 24280 24281 24282 24283 24284 24285 24286 24287 24288 24289 24290 24291 24292 24293 24294 24295 24296 24297 24298 24299 24300 24301 24302 24303 24304 24305 24306 24307 24308 24309 24310 24311 24312 24313 24314 24315 24316 24317 24318 24319 24320 24321 24322 24323 24324 24325 24326 24327 24328 24329 24330 24331 24332 24333 24334 24335 24336 24337 24338 24339 24340 24341 24342 24343 24344 24345 24346 24347 24348 24349 24350 24351 24352 24353 24354 24355 24356 24357 24358 24359 24360 24361 24362 24363 24364 24365 24366 24367 24368 24369 24370 24371 24372 24373 24374 24375 24376 24377 24378 24379 24380 24381 24382 24383 24384 24385 24386 24387 24388 24389 24390 24391 24392 24393 24394 24395 24396 24397 24398 24399 24400 24401 24402 24403 24404 24405 24406 24407 24408 24409 24410 24411 24412 24413 24414 24415 24416 24417 24418 24419 24420 24421 24422 24423 24424 24425 24426 24427 24428 24429 24430 24431 24432 24433 24434 24435 24436 24437 24438 24439 24440 24441 24442 24443 24444 24445 24446 24447 24448 24449 24450 24451 24452 24453 24454 24455 24456 24457 24458 24459 24460 24461 24462 24463 24464 24465 24466 24467 24468 24469 24470 24471 24472 24473 24474 24475 24476 24477 24478 24479 24480 24481 24482 24483 24484 24485 24486 24487 24488 24489 24490 24491 24492 24493 24494 24495 24496 24497 24498 24499 24500 24501 24502 24503 24504 24505 24506 24507 24508 24509 24510 24511 24512 24513 24514 24515 24516 24517 24518 24519 24520 24521 24522 24523 24524 24525 24526 24527 24528 24529 24530 24531 24532 24533 24534 24535 24536 24537 24538 24539 24540 24541 24542 24543 24544 24545 24546 24547 24548 24549 24550 24551 24552 24553 24554 24555 24556 24557 24558 24559 24560 24561 24562 24563 24564 24565 24566 24567 24568 24569 24570 24571 24572 24573 24574 24575 24576 24577 24578 24579 24580 24581 24582 24583 24584 24585 24586 24587 24588 24589 24590 24591 24592 24593 24594 24595 24596 24597 24598 24599 24600 24601 24602 24603 24604 24605 24606 24607 24608 24609 24610 24611 24612 24613 24614 24615 24616 24617 24618 24619 24620 24621 24622 24623 24624 24625 24626 24627 24628 24629 24630 24631 24632 24633 24634 24635 24636 24637 24638 24639 24640 24641 24642 24643 24644 24645 24646 24647 24648 24649 24650 24651 24652 24653 24654 24655 24656 24657 24658 24659 24660 24661 24662 24663 24664 24665 24666 24667 24668 24669 24670 24671 24672 24673 24674 24675 24676 24677 24678 24679 24680 24681 24682 24683 24684 24685 24686 24687 24688 24689 24690 24691 24692 24693 24694 24695 24696 24697 24698 24699 24700 24701 24702 24703 24704 24705 24706 24707 24708 24709 24710 24711 24712 24713 24714 24715 24716 24717 24718 24719 24720 24721 24722 24723 24724 24725 24726 24727 24728 24729 24730 24731 24732 24733 24734 24735 24736 24737 24738 24739 24740 24741 24742 24743 24744 24745 24746 24747 24748 24749 24750 24751 24752 24753 24754 24755 24756 24757 24758 24759 24760 24761 24762 24763 24764 24765 24766 24767 24768 24769 24770 24771 24772 24773 24774 24775 24776 24777 24778 24779 24780 24781 24782 24783 24784 24785 24786 24787 24788 24789 24790 24791 24792 24793 24794 24795 24796 24797 24798 24799 24800 24801 24802 24803 24804 24805 24806 24807 24808 24809 24810 24811 24812 24813 24814 24815 24816 24817 24818 24819 24820 24821 24822 24823 24824 24825 24826 24827 24828 24829 24830 24831 24832 24833 24834 24835 24836 24837 24838 24839 24840 24841 24842 24843 24844 24845 24846 24847 24848 24849 24850 24851 24852 24853 24854 24855 24856 24857 24858 24859 24860 24861 24862 24863 24864 24865 24866 24867 24868 24869 24870 24871 24872 24873 24874 24875 24876 24877 24878 24879 24880 24881 24882 24883 24884 24885 24886 24887 24888 24889 24890 24891 24892 24893 24894 24895 24896 24897 24898 24899 24900 24901 24902 24903 24904 24905 24906 24907 24908 24909 24910 24911 24912 24913 24914 24915 24916 24917 24918 24919 24920 24921 24922 24923 24924 24925 24926 24927 24928 24929 24930 24931 24932 24933 24934 24935 24936 24937 24938 24939 24940 24941 24942 24943 24944 24945 24946 24947 24948 24949 24950 24951 24952 24953 24954 24955 24956 24957 24958 24959 24960 24961 24962 24963 24964 24965 24966 24967 24968 24969 24970 24971 24972 24973 24974 24975 24976 24977 24978 24979 24980 24981 24982 24983 24984 24985 24986 24987 24988 24989 24990 24991 24992 24993 24994 24995 24996 24997 24998 24999 25000 25001 25002 25003 25004 25005 25006 25007 25008 25009 25010 25011 25012 25013 25014 25015 25016 25017 25018 25019 25020 25021 25022 25023 25024 25025 25026 25027 25028 25029 25030 25031 25032 25033 25034 25035 25036 25037 25038 25039 25040 25041 25042 25043 25044 25045 25046 25047 25048 25049 25050 25051 25052 25053 25054 25055 25056 25057 25058 25059 25060 25061 25062 25063 25064 25065 25066 25067 25068 25069 25070 25071 25072 25073 25074 25075 25076 25077 25078 25079 25080 25081 25082 25083 25084 25085 25086 25087 25088 25089 25090 25091 25092 25093 25094 25095 25096 25097 25098 25099 25100 25101 25102 25103 25104 25105 25106 25107 25108 25109 25110 25111 25112 25113 25114 25115 25116 25117 25118 25119 25120 25121 25122 25123 25124 25125 25126 25127 25128 25129 25130 25131 25132 25133 25134 25135 25136 25137 25138 25139 25140 25141 25142 25143 25144 25145 25146 25147 25148 25149 25150 25151 25152 25153 25154 25155 25156 25157 25158 25159 25160 25161 25162 25163 25164 25165 25166 25167 25168 25169 25170 25171 25172 25173 25174 25175 25176 25177 25178 25179 25180 25181 25182 25183 25184 25185 25186 25187 25188 25189 25190 25191 25192 25193 25194 25195 25196 25197 25198 25199 25200 25201 25202 25203 25204 25205 25206 25207 25208 25209 25210 25211 25212 25213 25214 25215 25216 25217 25218 25219 25220 25221 25222 25223 25224 25225 25226 25227 25228 25229 25230 25231 25232 25233 25234 25235 25236 25237 25238 25239 25240 25241 25242 25243 25244 25245 25246 25247 25248 25249 25250 25251 25252 25253 25254 25255 25256 25257 25258 25259 25260 25261 25262 25263 25264 25265 25266 25267 25268 25269 25270 25271 25272 25273 25274 25275 25276 25277 25278 25279 25280 25281 25282 25283 25284 25285 25286 25287 25288 25289 25290 25291 25292 25293 25294 25295 25296 25297 25298 25299 25300 25301 25302 25303 25304 25305 25306 25307 25308 25309 25310 25311 25312 25313 25314 25315 25316 25317 25318 25319 25320 25321 25322 25323 25324 25325 25326 25327 25328 25329 25330 25331 25332 25333 25334 25335 25336 25337 25338 25339 25340 25341 25342 25343 25344 25345 25346 25347 25348 25349 25350 25351 25352 25353 25354 25355 25356 25357 25358 25359 25360 25361 25362 25363 25364 25365 25366 25367 25368 25369 25370 25371 25372 25373 25374 25375 25376 25377 25378 25379 25380 25381 25382 25383 25384 25385 25386 25387 25388 25389 25390 25391 25392 25393 25394 25395 25396 25397 25398 25399 25400 25401 25402 25403 25404 25405 25406 25407 25408 25409 25410 25411 25412 25413 25414 25415 25416 25417 25418 25419 25420 25421 25422 25423 25424 25425 25426 25427 25428 25429 25430 25431 25432 25433 25434 25435 25436 25437 25438 25439 25440 25441 25442 25443 25444 25445 25446 25447 25448 25449 25450 25451 25452 25453 25454 25455 25456 25457 25458 25459 25460 25461 25462 25463 25464 25465 25466 25467 25468 25469 25470 25471 25472 25473 25474 25475 25476 25477 25478 25479 25480 25481 25482 25483 25484 25485 25486 25487 25488 25489 25490 25491 25492 25493 25494 25495 25496 25497 25498 25499 25500 25501 25502 25503 25504 25505 25506 25507 25508 25509 25510 25511 25512 25513 25514 25515 25516 25517 25518 25519 25520 25521 25522 25523 25524 25525 25526 25527 25528 25529 25530 25531 25532 25533 25534 25535 25536 25537 25538 25539 25540 25541 25542 25543 25544 25545 25546 25547 25548 25549 25550 25551 25552 25553 25554 25555 25556 25557 25558 25559 25560 25561 25562 25563 25564 25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 25578 25579 25580 25581 25582 25583 25584 25585 25586 25587 25588 25589 25590 25591 25592 25593 25594 25595 25596 25597 25598 25599 25600 25601 25602 25603 25604 25605 25606 25607 25608 25609 25610 25611 25612 25613 25614 25615 25616 25617 25618 25619 25620 25621 25622 25623 25624 25625 25626 25627 25628 25629 25630 25631 25632 25633 25634 25635 25636 25637 25638 25639 25640 25641 25642 25643 25644 25645 25646 25647 25648 25649 25650 25651 25652 25653 25654 25655 25656 25657 25658 25659 25660 25661 25662 25663 25664 25665 25666 25667 25668 25669 25670 25671 25672 25673 25674 25675 25676 25677 25678 25679 25680 25681 25682 25683 25684 25685 25686 25687 25688 25689 25690 25691 25692 25693 25694 25695 25696 25697 25698 25699 25700 25701 25702 25703 25704 25705 25706 25707 25708 25709 25710 25711 25712 25713 25714 25715 25716 25717 25718 25719 25720 25721 25722 25723 25724 25725 25726 25727 25728 25729 25730 25731 25732 25733 25734 25735 25736 25737 25738 25739 25740 25741 25742 25743 25744 25745 25746 25747 25748 25749 25750 25751 25752 25753 25754 25755 25756 25757 25758 25759 25760 25761 25762 25763 25764 25765 25766 25767 25768 25769 25770 25771 25772 25773 25774 25775 25776 25777 25778 25779 25780 25781 25782 25783 25784 25785 25786 25787 25788 25789 25790 25791 25792 25793 25794 25795 25796 25797 25798 25799 25800 25801 25802 25803 25804 25805 25806 25807 25808 25809 25810 25811 25812 25813 25814 25815 25816 25817 25818 25819 25820 25821 25822 25823 25824 25825 25826 25827 25828 25829 25830 25831 25832 25833 25834 25835 25836 25837 25838 25839 25840 25841 25842 25843 25844 25845 25846 25847 25848 25849 25850 25851 25852 25853 25854 25855 25856 25857 25858 25859 25860 25861 25862 25863 25864 25865 25866 25867 25868 25869 25870 25871 25872 25873 25874 25875 25876 25877 25878 25879 25880 25881 25882 25883 25884 25885 25886 25887 25888 25889 25890 25891 25892 25893 25894 25895 25896 25897 25898 25899 25900 25901 25902 25903 25904 25905 25906 25907 25908 25909 25910 25911 25912 25913 25914 25915 25916 25917 25918 25919 25920 25921 25922 25923 25924 25925 25926 25927 25928 25929 25930 25931 25932 25933 25934 25935 25936 25937 25938 25939 25940 25941 25942 25943 25944 25945 25946 25947 25948 25949 25950 25951 25952 25953 25954 25955 25956 25957 25958 25959 25960 25961 25962 25963 25964 25965 25966 25967 25968 25969 25970 25971 25972 25973 25974 25975 25976 25977 25978 25979 25980 25981 25982 25983 25984 25985 25986 25987 25988 25989 25990 25991 25992 25993 25994 25995 25996 25997 25998 25999 26000 26001 26002 26003 26004 26005 26006 26007 26008 26009 26010 26011 26012 26013 26014 26015 26016 26017 26018 26019 26020 26021 26022 26023 26024 26025 26026 26027 26028 26029 26030 26031 26032 26033 26034 26035 26036 26037 26038 26039 26040 26041 26042 26043 26044 26045 26046 26047 26048 26049 26050 26051 26052 26053 26054 26055 26056 26057 26058 26059 26060 26061 26062 26063 26064 26065 26066 26067 26068 26069 26070 26071 26072 26073 26074 26075 26076 26077 26078 26079 26080 26081 26082 26083 26084 26085 26086 26087 26088 26089 26090 26091 26092 26093 26094 26095 26096 26097 26098 26099 26100 26101 26102 26103 26104 26105 26106 26107 26108 26109 26110 26111 26112 26113 26114 26115 26116 26117 26118 26119 26120 26121 26122 26123 26124 26125 26126 26127 26128 26129 26130 26131 26132 26133 26134 26135 26136 26137 26138 26139 26140 26141 26142 26143 26144 26145 26146 26147 26148 26149 26150 26151 26152 26153 26154 26155 26156 26157 26158 26159 26160 26161 26162 26163 26164 26165 26166 26167 26168 26169 26170 26171 26172 26173 26174 26175 26176 26177 26178 26179 26180 26181 26182 26183 26184 26185 26186 26187 26188 26189 26190 26191 26192 26193 26194 26195 26196 26197 26198 26199 26200 26201 26202 26203 26204 26205 26206 26207 26208 26209 26210 26211 26212 26213 26214 26215 26216 26217 26218 26219 26220 26221 26222 26223 26224 26225 26226 26227 26228 26229 26230 26231 26232 26233 26234 26235 26236 26237 26238 26239 26240 26241 26242 26243 26244 26245 26246 26247 26248 26249 26250 26251 26252 26253 26254 26255 26256 26257 26258 26259 26260 26261 26262 26263 26264 26265 26266 26267 26268 26269 26270 26271 26272 26273 26274 26275 26276 26277 26278 26279 26280 26281 26282 26283 26284 26285 26286 26287 26288 26289 26290 26291 26292 26293 26294 26295 26296 26297 26298 26299 26300 26301 26302 26303 26304 26305 26306 26307 26308 26309 26310 26311 26312 26313 26314 26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 26326 26327 26328 26329 26330 26331 26332 26333 26334 26335 26336 26337 26338 26339 26340 26341 26342 26343 26344 26345 26346 26347 26348 26349 26350 26351 26352 26353 26354 26355 26356 26357 26358 26359 26360 26361 26362 26363 26364 26365 26366 26367 26368 26369 26370 26371 26372 26373 26374 26375 26376 26377 26378 26379 26380 26381 26382 26383 26384 26385 26386 26387 26388 26389 26390 26391 26392 26393 26394 26395 26396 26397 26398 26399 26400 26401 26402 26403 26404 26405 26406 26407 26408 26409 26410 26411 26412 26413 26414 26415 26416 26417 26418 26419 26420 26421 26422 26423 26424 26425 26426 26427 26428 26429 26430 26431 26432 26433 26434 26435 26436 26437 26438 26439 26440 26441 26442 26443 26444 26445 26446 26447 26448 26449 26450 26451 26452 26453 26454 26455 26456 26457 26458 26459 26460 26461 26462 26463 26464 26465 26466 26467 26468 26469 26470 26471 26472 26473 26474 26475 26476 26477 26478 26479 26480 26481 26482 26483 26484 26485 26486 26487 26488 26489 26490 26491 26492 26493 26494 26495 26496 26497 26498 26499 26500 26501 26502 26503 26504 26505 26506 26507 26508 26509 26510 26511 26512 26513 26514 26515 26516 26517 26518 26519 26520 26521 26522 26523 26524 26525 26526 26527 26528 26529 26530 26531 26532 26533 26534 26535 26536 26537 26538 26539 26540 26541 26542 26543 26544 26545 26546 26547 26548 26549 26550 26551 26552 26553 26554 26555 26556 26557 26558 26559 26560 26561 26562 26563 26564 26565 26566 26567 26568 26569 26570 26571 26572 26573 26574 26575 26576 26577 26578 26579 26580 26581 26582 26583 26584 26585 26586 26587 26588 26589 26590 26591 26592 26593 26594 26595 26596 26597 26598 26599 26600 26601 26602 26603 26604 26605 26606 26607 26608 26609 26610 26611 26612 26613 26614 26615 26616 26617 26618 26619 26620 26621 26622 26623 26624 26625 26626 26627 26628 26629 26630 26631 26632 26633 26634 26635 26636 26637 26638 26639 26640 26641 26642 26643 26644 26645 26646 26647 26648 26649 26650 26651 26652 26653 26654 26655 26656 26657 26658 26659 26660 26661 26662 26663 26664 26665 26666 26667 26668 26669 26670 26671 26672 26673 26674 26675 26676 26677 26678 26679 26680 26681 26682 26683 26684 26685 26686 26687 26688 26689 26690 26691 26692 26693 26694 26695 26696 26697 26698 26699 26700 26701 26702 26703 26704 26705 26706 26707 26708 26709 26710 26711 26712 26713 26714 26715 26716 26717 26718 26719 26720 26721 26722 26723 26724 26725 26726 26727 26728 26729 26730 26731 26732 26733 26734 26735 26736 26737 26738 26739 26740 26741 26742 26743 26744 26745 26746 26747 26748 26749 26750 26751 26752 26753 26754 26755 26756 26757 26758 26759 26760 26761 26762 26763 26764 26765 26766 26767 26768 26769 26770 26771 26772 26773 26774 26775 26776 26777 26778 26779 26780 26781 26782 26783 26784 26785 26786 26787 26788 26789 26790 26791 26792 26793 26794 26795 26796 26797 26798 26799 26800 26801 26802 26803 26804 26805 26806 26807 26808 26809 26810 26811 26812 26813 26814 26815 26816 26817 26818 26819 26820 26821 26822 26823 26824 26825 26826 26827 26828 26829 26830 26831 26832 26833 26834 26835 26836 26837 26838 26839 26840 26841 26842 26843 26844 26845 26846 26847 26848 26849 26850 26851 26852 26853 26854 26855 26856 26857 26858 26859 26860 26861 26862 26863 26864 26865 26866 26867 26868 26869 26870 26871 26872 26873 26874 26875 26876 26877 26878 26879 26880 26881 26882 26883 26884 26885 26886 26887 26888 26889 26890 26891 26892 26893 26894 26895 26896 26897 26898 26899 26900 26901 26902 26903 26904 26905 26906 26907 26908 26909 26910 26911 26912 26913 26914 26915 26916 26917 26918 26919 26920 26921 26922 26923 26924 26925 26926 26927 26928 26929 26930 26931 26932 26933 26934 26935 26936 26937 26938 26939 26940 26941 26942 26943 26944 26945 26946 26947 26948 26949 26950 26951 26952 26953 26954 26955 26956 26957 26958 26959 26960 26961 26962 26963 26964 26965 26966 26967 26968 26969 26970 26971 26972 26973 26974 26975 26976 26977 26978 26979 26980 26981 26982 26983 26984 26985 26986 26987 26988 26989 26990 26991 26992 26993 26994 26995 26996 26997 26998 26999 27000 27001 27002 27003 27004 27005 27006 27007 27008 27009 27010 27011 27012 27013 27014 27015 27016 27017 27018 27019 27020 27021 27022 27023 27024 27025 27026 27027 27028 27029 27030 27031 27032 27033 27034 27035 27036 27037 27038 27039 27040 27041 27042 27043 27044 27045 27046 27047 27048 27049 27050 27051 27052 27053 27054 27055 27056 27057 27058 27059 27060 27061 27062 27063 27064 27065 27066 27067 27068 27069 27070 27071 27072 27073 27074 27075 27076 27077 27078 27079 27080 27081 27082 27083 27084 27085 27086 27087 27088 27089 27090 27091 27092 27093 27094 27095 27096 27097 27098 27099 27100 27101 27102 27103 27104 27105 27106 27107 27108 27109 27110 27111 27112 27113 27114 27115 27116 27117 27118 27119 27120 27121 27122 27123 27124 27125 27126 27127 27128 27129 27130 27131 27132 27133 27134 27135 27136 27137 27138 27139 27140 27141 27142 27143 27144 27145 27146 27147 27148 27149 27150 27151 27152 27153 27154 27155 27156 27157 27158 27159 27160 27161 27162 27163 27164 27165 27166 27167 27168 27169 27170 27171 27172 27173 27174 27175 27176 27177 27178 27179 27180 27181 27182 27183 27184 27185 27186 27187 27188 27189 27190 27191 27192 27193 27194 27195 27196 27197 27198 27199 27200 27201 27202 27203 27204 27205 27206 27207 27208 27209 27210 27211 27212 27213 27214 27215 27216 27217 27218 27219 27220 27221 27222 27223 27224 27225 27226 27227 27228 27229 27230 27231 27232 27233 27234 27235 27236 27237 27238 27239 27240 27241 27242 27243 27244 27245 27246 27247 27248 27249 27250 27251 27252 27253 27254 27255 27256 27257 27258 27259 27260 27261 27262 27263 27264 27265 27266 27267 27268 27269 27270 27271 27272 27273 27274 27275 27276 27277 27278 27279 27280 27281 27282 27283 27284 27285 27286 27287 27288 27289 27290 27291 27292 27293 27294 27295 27296 27297 27298 27299 27300 27301 27302 27303 27304 27305 27306 27307 27308 27309 27310 27311 27312 27313 27314 27315 27316 27317 27318 27319 27320 27321 27322 27323 27324 27325 27326 27327 27328 27329 27330 27331 27332 27333 27334 27335 27336 27337 27338 27339 27340 27341 27342 27343 27344 27345 27346 27347 27348 27349 27350 27351 27352 27353 27354 27355 27356 27357 27358 27359 27360 27361 27362 27363 27364 27365 27366 27367 27368 27369 27370 27371 27372 27373 27374 27375 27376 27377 27378 27379 27380 27381 27382 27383 27384 27385 27386 27387 27388 27389 27390 27391 27392 27393 27394 27395 27396 27397 27398 27399 27400 27401 27402 27403 27404 27405 27406 27407 27408 27409 27410 27411 27412 27413 27414 27415 27416 27417 27418 27419 27420 27421 27422 27423 27424 27425 27426 27427 27428 27429 27430 27431 27432 27433 27434 27435 27436 27437 27438 27439 27440 27441 27442 27443 27444 27445 27446 27447 27448 27449 27450 27451 27452 27453 27454 27455 27456 27457 27458 27459 27460 27461 27462 27463 27464 27465 27466 27467 27468 27469 27470 27471 27472 27473 27474 27475 27476 27477 27478 27479 27480 27481 27482 27483 27484 27485 27486 27487 27488 27489 27490 27491 27492 27493 27494 27495 27496 27497 27498 27499 27500 27501 27502 27503 27504 27505 27506 27507 27508 27509 27510 27511 27512 27513 27514 27515 27516 27517 27518 27519 27520 27521 27522 27523 27524 27525 27526 27527 27528 27529 27530 27531 27532 27533 27534 27535 27536 27537 27538 27539 27540 27541 27542 27543 27544 27545 27546 27547 27548 27549 27550 27551 27552 27553 27554 27555 27556 27557 27558 27559 27560 27561 27562 27563 27564 27565 27566 27567 27568 27569 27570 27571 27572 27573 27574 27575 27576 27577 27578 27579 27580 27581 27582 27583 27584 27585 27586 27587 27588 27589 27590 27591 27592 27593 27594 27595 27596 27597 27598 27599 27600 27601 27602 27603 27604 27605 27606 27607 27608 27609 27610 27611 27612 27613 27614 27615 27616 27617 27618 27619 27620 27621 27622 27623 27624 27625 27626 27627 27628 27629 27630 27631 27632 27633 27634 27635 27636 27637 27638 27639 27640 27641 27642 27643 27644 27645 27646 27647 27648 27649 27650 27651 27652 27653 27654 27655 27656 27657 27658 27659 27660 27661 27662 27663 27664 27665 27666 27667 27668 27669 27670 27671 27672 27673 27674 27675 27676 27677 27678 27679 27680 27681 27682 27683 27684 27685 27686 27687 27688 27689 27690 27691 27692 27693 27694 27695 27696 27697 27698 27699 27700 27701 27702 27703 27704 27705 27706 27707 27708 27709 27710 27711 27712 27713 27714 27715 27716 27717 27718 27719 27720 27721 27722 27723 27724 27725 27726 27727 27728 27729 27730 27731 27732 27733 27734 27735 27736 27737 27738 27739 27740 27741 27742 27743 27744 27745 27746 27747 27748 27749 27750 27751 27752 27753 27754 27755 27756 27757 27758 27759 27760 27761 27762 27763 27764 27765 27766 27767 27768 27769 27770 27771 27772 27773 27774 27775 27776 27777 27778 27779 27780 27781 27782 27783 27784 27785 27786 27787 27788 27789 27790 27791 27792 27793 27794 27795 27796 27797 27798 27799 27800 27801 27802 27803 27804 27805 27806 27807 27808 27809 27810 27811 27812 27813 27814 27815 27816 27817 27818 27819 27820 27821 27822 27823 27824 27825 27826 27827 27828 27829 27830 27831 27832 27833 27834 27835 27836 27837 27838 27839 27840 27841 27842 27843 27844 27845 27846 27847 27848 27849 27850 27851 27852 27853 27854 27855 27856 27857 27858 27859 27860 27861 27862 27863 27864 27865 27866 27867 27868 27869 27870 27871 27872 27873 27874 27875 27876 27877 27878 27879 27880 27881 27882 27883 27884 27885 27886 27887 27888 27889 27890 27891 27892 27893 27894 27895 27896 27897 27898 27899 27900 27901 27902 27903 27904 27905 27906 27907 27908 27909 27910 27911 27912 27913 27914 27915 27916 27917 27918 27919 27920 27921 27922 27923 27924 27925 27926 27927 27928 27929 27930 27931 27932 27933 27934 27935 27936 27937 27938 27939 27940 27941 27942 27943 27944 27945 27946 27947 27948 27949 27950 27951 27952 27953 27954 27955 27956 27957 27958 27959 27960 27961 27962 27963 27964 27965 27966 27967 27968 27969 27970 27971 27972 27973 27974 27975 27976 27977 27978 27979 27980 27981 27982 27983 27984 27985 27986 27987 27988 27989 27990 27991 27992 27993 27994 27995 27996 27997 27998 27999 28000 28001 28002 28003 28004 28005 28006 28007 28008 28009 28010 28011 28012 28013 28014 28015 28016 28017 28018 28019 28020 28021 28022 28023 28024 28025 28026 28027 28028 28029 28030 28031 28032 28033 28034 28035 28036 28037 28038 28039 28040 28041 28042 28043 28044 28045 28046 28047 28048 28049 28050 28051 28052 28053 28054 28055 28056 28057 28058 28059 28060 28061 28062 28063 28064 28065 28066 28067 28068 28069 28070 28071 28072 28073 28074 28075 28076 28077 28078 28079 28080 28081 28082 28083 28084 28085 28086 28087 28088 28089 28090 28091 28092 28093 28094 28095 28096 28097 28098 28099 28100 28101 28102 28103 28104 28105 28106 28107 28108 28109 28110 28111 28112 28113 28114 28115 28116 28117 28118 28119 28120 28121 28122 28123 28124 28125 28126 28127 28128 28129 28130 28131 28132 28133 28134 28135 28136 28137 28138 28139 28140 28141 28142 28143 28144 28145 28146 28147 28148 28149 28150 28151 28152 28153 28154 28155 28156 28157 28158 28159 28160 28161 28162 28163 28164 28165 28166 28167 28168 28169 28170 28171 28172 28173 28174 28175 28176 28177 28178 28179 28180 28181 28182 28183 28184 28185 28186 28187 28188 28189 28190 28191 28192 28193 28194 28195 28196 28197 28198 28199 28200 28201 28202 28203 28204 28205 28206 28207 28208 28209 28210 28211 28212 28213 28214 28215 28216 28217 28218 28219 28220 28221 28222 28223 28224 28225 28226 28227 28228 28229 28230 28231 28232 28233 28234 28235 28236 28237 28238 28239 28240 28241 28242 28243 28244 28245 28246 28247 28248 28249 28250 28251 28252 28253 28254 28255 28256 28257 28258 28259 28260 28261 28262 28263 28264 28265 28266 28267 28268 28269 28270 28271 28272 28273 28274 28275 28276 28277 28278 28279 28280 28281 28282 28283 28284 28285 28286 28287 28288 28289 28290 28291 28292 28293 28294 28295 28296 28297 28298 28299 28300 28301 28302 28303 28304 28305 28306 28307 28308 28309 28310 28311 28312 28313 28314 28315 28316 28317 28318 28319 28320 28321 28322 28323 28324 28325 28326 28327 28328 28329 28330 28331 28332 28333 28334 28335 28336 28337 28338 28339 28340 28341 28342 28343 28344 28345 28346 28347 28348 28349 28350 28351 28352 28353 28354 28355 28356 28357 28358 28359 28360 28361 28362 28363 28364 28365 28366 28367 28368 28369 28370 28371 28372 28373 28374 28375 28376 28377 28378 28379 28380 28381 28382 28383 28384 28385 28386 28387 28388 28389 28390 28391 28392 28393 28394 28395 28396 28397 28398 28399 28400 28401 28402 28403 28404 28405 28406 28407 28408 28409 28410 28411 28412 28413 28414 28415 28416 28417 28418 28419 28420 28421 28422 28423 28424 28425 28426 28427 28428 28429 28430 28431 28432 28433 28434 28435 28436 28437 28438 28439 28440 28441 28442 28443 28444 28445 28446 28447 28448 28449 28450 28451 28452 28453 28454 28455 28456 28457 28458 28459 28460 28461 28462 28463 28464 28465 28466 28467 28468 28469 28470 28471 28472 28473 28474 28475 28476 28477 28478 28479 28480 28481 28482 28483 28484 28485 28486 28487 28488 28489 28490 28491 28492 28493 28494 28495 28496 28497 28498 28499 28500 28501 28502 28503 28504 28505 28506 28507 28508 28509 28510 28511 28512 28513 28514 28515 28516 28517 28518 28519 28520 28521 28522 28523 28524 28525 28526 28527 28528 28529 28530 28531 28532 28533 28534 28535 28536 28537 28538 28539 28540 28541 28542 28543 28544 28545 28546 28547 28548 28549 28550 28551 28552 28553 28554 28555 28556 28557 28558 28559 28560 28561 28562 28563 28564 28565 28566 28567 28568 28569 28570 28571 28572 28573 28574 28575 28576 28577 28578 28579 28580 28581 28582 28583 28584 28585 28586 28587 28588 28589 28590 28591 28592 28593 28594 28595 28596 28597 28598 28599 28600 28601 28602 28603 28604 28605 28606 28607 28608 28609 28610 28611 28612 28613 28614 28615 28616 28617 28618 28619 28620 28621 28622 28623 28624 28625 28626 28627 28628 28629 28630 28631 28632 28633 28634 28635 28636 28637 28638 28639 28640 28641 28642 28643 28644 28645 28646 28647 28648 28649 28650 28651 28652 28653 28654 28655 28656 28657 28658 28659 28660 28661 28662 28663 28664 28665 28666 28667 28668 28669 28670 28671 28672 28673 28674 28675 28676 28677 28678 28679 28680 28681 28682 28683 28684 28685 28686 28687 28688 28689 28690 28691 28692 28693 28694 28695 28696 28697 28698 28699 28700 28701 28702 28703 28704 28705 28706 28707 28708 28709 28710 28711 28712 28713 28714 28715 28716 28717 28718 28719 28720 28721 28722 28723 28724 28725 28726 28727 28728 28729 28730 28731 28732 28733 28734 28735 28736 28737 28738 28739 28740 28741 28742 28743 28744 28745 28746 28747 28748 28749 28750 28751 28752 28753 28754 28755 28756 28757 28758 28759 28760 28761 28762 28763 28764 28765 28766 28767 28768 28769 28770 28771 28772 28773 28774 28775 28776 28777 28778 28779 28780 28781 28782 28783 28784 28785 28786 28787 28788 28789 28790 28791 28792 28793 28794 28795 28796 28797 28798 28799 28800 28801 28802 28803 28804 28805 28806 28807 28808 28809 28810 28811 28812 28813 28814 28815 28816 28817 28818 28819 28820 28821 28822 28823 28824 28825 28826 28827 28828 28829 28830 28831 28832 28833 28834 28835 28836 28837 28838 28839 28840 28841 28842 28843 28844 28845 28846 28847 28848 28849 28850 28851 28852 28853 28854 28855 28856 28857 28858 28859 28860 28861 28862 28863 28864 28865 28866 28867 28868 28869 28870 28871 28872 28873 28874 28875 28876 28877 28878 28879 28880 28881 28882 28883 28884 28885 28886 28887 28888 28889 28890 28891 28892 28893 28894 28895 28896 28897 28898 28899 28900 28901 28902 28903 28904 28905 28906 28907 28908 28909 28910 28911 28912 28913 28914 28915 28916 28917 28918 28919 28920 28921 28922 28923 28924 28925 28926 28927 28928 28929 28930 28931 28932 28933 28934 28935 28936 28937 28938 28939 28940 28941 28942 28943 28944 28945 28946 28947 28948 28949 28950 28951 28952 28953 28954 28955 28956 28957 28958 28959 28960 28961 28962 28963 28964 28965 28966 28967 28968 28969 28970 28971 28972 28973 28974 28975 28976 28977 28978 28979 28980 28981 28982 28983 28984 28985 28986 28987 28988 28989 28990 28991 28992 28993 28994 28995 28996 28997 28998 28999 29000 29001 29002 29003 29004 29005 29006 29007 29008 29009 29010 29011 29012 29013 29014 29015 29016 29017 29018 29019 29020 29021 29022 29023 29024 29025 29026 29027 29028 29029 29030 29031 29032 29033 29034 29035 29036 29037 29038 29039 29040 29041 29042 29043 29044 29045 29046 29047 29048 29049 29050 29051 29052 29053 29054 29055 29056 29057 29058 29059 29060 29061 29062 29063 29064 29065 29066 29067 29068 29069 29070 29071 29072 29073 29074 29075 29076 29077 29078 29079 29080 29081 29082 29083 29084 29085 29086 29087 29088 29089 29090 29091 29092 29093 29094 29095 29096 29097 29098 29099 29100 29101 29102 29103 29104 29105 29106 29107 29108 29109 29110 29111 29112 29113 29114 29115 29116 29117 29118 29119 29120 29121 29122 29123 29124 29125 29126 29127 29128 29129 29130 29131 29132 29133 29134 29135 29136 29137 29138 29139 29140 29141 29142 29143 29144 29145 29146 29147 29148 29149 29150 29151 29152 29153 29154 29155 29156 29157 29158 29159 29160 29161 29162 29163 29164 29165 29166 29167 29168 29169 29170 29171 29172 29173 29174 29175 29176 29177 29178 29179 29180 29181 29182 29183 29184 29185 29186 29187 29188 29189 29190 29191 29192 29193 29194 29195 29196 29197 29198 29199 29200 29201 29202 29203 29204 29205 29206 29207 29208 29209 29210 29211 29212 29213 29214 29215 29216 29217 29218 29219 29220 29221 29222 29223 29224 29225 29226 29227 29228 29229 29230 29231 29232 29233 29234 29235 29236 29237 29238 29239 29240 29241 29242 29243 29244 29245 29246 29247 29248 29249 29250 29251 29252 29253 29254 29255 29256 29257 29258 29259 29260 29261 29262 29263 29264 29265 29266 29267 29268 29269 29270 29271 29272 29273 29274 29275 29276 29277 29278 29279 29280 29281 29282 29283 29284 29285 29286 29287 29288 29289 29290 29291 29292 29293 29294 29295 29296 29297 29298 29299 29300 29301 29302 29303 29304 29305 29306 29307 29308 29309 29310 29311 29312 29313 29314 29315 29316 29317 29318 29319 29320 29321 29322 29323 29324 29325 29326 29327 29328 29329 29330 29331 29332 29333 29334 29335 29336 29337 29338 29339 29340 29341 29342 29343 29344 29345 29346 29347 29348 29349 29350 29351 29352 29353 29354 29355 29356 29357 29358 29359 29360 29361 29362 29363 29364 29365 29366 29367 29368 29369 29370 29371 29372 29373 29374 29375 29376 29377 29378 29379 29380 29381 29382 29383 29384 29385 29386 29387 29388 29389 29390 29391 29392 29393 29394 29395 29396 29397 29398 29399 29400 29401 29402 29403 29404 29405 29406 29407 29408 29409 29410 29411 29412 29413 29414 29415 29416 29417 29418 29419 29420 29421 29422 29423 29424 29425 29426 29427 29428 29429 29430 29431 29432 29433 29434 29435 29436 29437 29438 29439 29440 29441 29442 29443 29444 29445 29446 29447 29448 29449 29450 29451 29452 29453 29454 29455 29456 29457 29458 29459 29460 29461 29462 29463 29464 29465 29466 29467 29468 29469 29470 29471 29472 29473 29474 29475 29476 29477 29478 29479 29480 29481 29482 29483 29484 29485 29486 29487 29488 29489 29490 29491 29492 29493 29494 29495 29496 29497 29498 29499 29500 29501 29502 29503 29504 29505 29506 29507 29508 29509 29510 29511 29512 29513 29514 29515 29516 29517 29518 29519 29520 29521 29522 29523 29524 29525 29526 29527 29528 29529 29530 29531 29532 29533 29534 29535 29536 29537 29538 29539 29540 29541 29542 29543 29544 29545 29546 29547 29548 29549 29550 29551 29552 29553 29554 29555 29556 29557 29558 29559 29560 29561 29562 29563 29564 29565 29566 29567 29568 29569 29570 29571 29572 29573 29574 29575 29576 29577 29578 29579 29580 29581 29582 29583 29584 29585 29586 29587 29588 29589 29590 29591 29592 29593 29594 29595 29596 29597 29598 29599 29600 29601 29602 29603 29604 29605 29606 29607 29608 29609 29610 29611 29612 29613 29614 29615 29616 29617 29618 29619 29620 29621 29622 29623 29624 29625 29626 29627 29628 29629 29630 29631 29632 29633 29634 29635 29636 29637 29638 29639 29640 29641 29642 29643 29644 29645 29646 29647 29648 29649 29650 29651 29652 29653 29654 29655 29656 29657 29658 29659 29660 29661 29662 29663 29664 29665 29666 29667 29668 29669 29670 29671 29672 29673 29674 29675 29676 29677 29678 29679 29680 29681 29682 29683 29684 29685 29686 29687 29688 29689 29690 29691 29692 29693 29694 29695 29696 29697 29698 29699 29700 29701 29702 29703 29704 29705 29706 29707 29708 29709 29710 29711 29712 29713 29714 29715 29716 29717 29718 29719 29720 29721 29722 29723 29724 29725 29726 29727 29728 29729 29730 29731 29732 29733 29734 29735 29736 29737 29738 29739 29740 29741 29742 29743 29744 29745 29746 29747 29748 29749 29750 29751 29752 29753 29754 29755 29756 29757 29758 29759 29760 29761 29762 29763 29764 29765 29766 29767 29768 29769 29770 29771 29772 29773 29774 29775 29776 29777 29778 29779 29780 29781 29782 29783 29784 29785 29786 29787 29788 29789 29790 29791 29792 29793 29794 29795 29796 29797 29798 29799 29800 29801 29802 29803 29804 29805 29806 29807 29808 29809 29810 29811 29812 29813 29814 29815 29816 29817 29818 29819 29820 29821 29822 29823 29824 29825 29826 29827 29828 29829 29830 29831 29832 29833 29834 29835 29836 29837 29838 29839 29840 29841 29842 29843 29844 29845 29846 29847 29848 29849 29850 29851 29852 29853 29854 29855 29856 29857 29858 29859 29860 29861 29862 29863 29864 29865 29866 29867 29868 29869 29870 29871 29872 29873 29874 29875 29876 29877 29878 29879 29880 29881 29882 29883 29884 29885 29886 29887 29888 29889 29890 29891 29892 29893 29894 29895 29896 29897 29898 29899 29900 29901 29902 29903 29904 29905 29906 29907 29908 29909 29910 29911 29912 29913 29914 29915 29916 29917 29918 29919 29920 29921 29922 29923 29924 29925 29926 29927 29928 29929 29930 29931 29932 29933 29934 29935 29936 29937 29938 29939 29940 29941 29942 29943 29944 29945 29946 29947 29948 29949 29950 29951 29952 29953 29954 29955 29956 29957 29958 29959 29960 29961 29962 29963 29964 29965 29966 29967 29968 29969 29970 29971 29972 29973 29974 29975 29976 29977 29978 29979 29980 29981 29982 29983 29984 29985 29986 29987 29988 29989 29990 29991 29992 29993 29994 29995 29996 29997 29998 29999 30000 30001 30002 30003 30004 30005 30006 30007 30008 30009 30010 30011 30012 30013 30014 30015 30016 30017 30018 30019 30020 30021 30022 30023 30024 30025 30026 30027 30028 30029 30030 30031 30032 30033 30034 30035 30036 30037 30038 30039 30040 30041 30042 30043 30044 30045 30046 30047 30048 30049 30050 30051 30052 30053 30054 30055 30056 30057 30058 30059 30060 30061 30062 30063 30064 30065 30066 30067 30068 30069 30070 30071 30072 30073 30074 30075 30076 30077 30078 30079 30080 30081 30082 30083 30084 30085 30086 30087 30088 30089 30090 30091 30092 30093 30094 30095 30096 30097 30098 30099 30100 30101 30102 30103 30104 30105 30106 30107 30108 30109 30110 30111 30112 30113 30114 30115 30116 30117 30118 30119 30120 30121 30122 30123 30124 30125 30126 30127 30128 30129 30130 30131 30132 30133 30134 30135 30136 30137 30138 30139 30140 30141 30142 30143 30144 30145 30146 30147 30148 30149 30150 30151 30152 30153 30154 30155 30156 30157 30158 30159 30160 30161 30162 30163 30164 30165 30166 30167 30168 30169 30170 30171 30172 30173 30174 30175 30176 30177 30178 30179 30180 30181 30182 30183 30184 30185 30186 30187 30188 30189 30190 30191 30192 30193 30194 30195 30196 30197 30198 30199 30200 30201 30202 30203 30204 30205 30206 30207 30208 30209 30210 30211 30212 30213 30214 30215 30216 30217 30218 30219 30220 30221 30222 30223 30224 30225 30226 30227 30228 30229 30230 30231 30232 30233 30234 30235 30236 30237 30238 30239 30240 30241 30242 30243 30244 30245 30246 30247 30248 30249 30250 30251 30252 30253 30254 30255 30256 30257 30258 30259 30260 30261 30262 30263 30264 30265 30266 30267 30268 30269 30270 30271 30272 30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 30288 30289 30290 30291 30292 30293 30294 30295 30296 30297 30298 30299 30300 30301 30302 30303 30304 30305 30306 30307 30308 30309 30310 30311 30312 30313 30314 30315 30316 30317 30318 30319 30320 30321 30322 30323 30324 30325 30326 30327 30328 30329 30330 30331 30332 30333 30334 30335 30336 30337 30338 30339 30340 30341 30342 30343 30344 30345 30346 30347 30348 30349 30350 30351 30352 30353 30354 30355 30356 30357 30358 30359 30360 30361 30362 30363 30364 30365 30366 30367 30368 30369 30370 30371 30372 30373 30374 30375 30376 30377 30378 30379 30380 30381 30382 30383 30384 30385 30386 30387 30388 30389 30390 30391 30392 30393 30394 30395 30396 30397 30398 30399 30400 30401 30402 30403 30404 30405 30406 30407 30408 30409 30410 30411 30412 30413 30414 30415 30416 30417 30418 30419 30420 30421 30422 30423 30424 30425 30426 30427 30428 30429 30430 30431 30432 30433 30434 30435 30436 30437 30438 30439 30440 30441 30442 30443 30444 30445 30446 30447 30448 30449 30450 30451 30452 30453 30454 30455 30456 30457 30458 30459 30460 30461 30462 30463 30464 30465 30466 30467 30468 30469 30470 30471 30472 30473 30474 30475 30476 30477 30478 30479 30480 30481 30482 30483 30484 30485 30486 30487 30488 30489 30490 30491 30492 30493 30494 30495 30496 30497 30498 30499 30500 30501 30502 30503 30504 30505 30506 30507 30508 30509 30510 30511 30512 30513 30514 30515 30516 30517 30518 30519 30520 30521 30522 30523 30524 30525 30526 30527 30528 30529 30530 30531 30532 30533 30534 30535 30536 30537 30538 30539 30540 30541 30542 30543 30544 30545 30546 30547 30548 30549 30550 30551 30552 30553 30554 30555 30556 30557 30558 30559 30560 30561 30562 30563 30564 30565 30566 30567 30568 30569 30570 30571 30572 30573 30574 30575 30576 30577 30578 30579 30580 30581 30582 30583 30584 30585 30586 30587 30588 30589 30590 30591 30592 30593 30594 30595 30596 30597 30598 30599 30600 30601 30602 30603 30604 30605 30606 30607 30608 30609 30610 30611 30612 30613 30614 30615 30616 30617 30618 30619 30620 30621 30622 30623 30624 30625 30626 30627 30628 30629 30630 30631 30632 30633 30634 30635 30636 30637 30638 30639 30640 30641 30642 30643 30644 30645 30646 30647 30648 30649 30650 30651 30652 30653 30654 30655 30656 30657 30658 30659 30660 30661 30662 30663 30664 30665 30666 30667 30668 30669 30670 30671 30672 30673 30674 30675 30676 30677 30678 30679 30680 30681 30682 30683 30684 30685 30686 30687 30688 30689 30690 30691 30692 30693 30694 30695 30696 30697 30698 30699 30700 30701 30702 30703 30704 30705 30706 30707 30708 30709 30710 30711 30712 30713 30714 30715 30716 30717 30718 30719 30720 30721 30722 30723 30724 30725 30726 30727 30728 30729 30730 30731 30732 30733 30734 30735 30736 30737 30738 30739 30740 30741 30742 30743 30744 30745 30746 30747 30748 30749 30750 30751 30752 30753 30754 30755 30756 30757 30758 30759 30760 30761 30762 30763 30764 30765 30766 30767 30768 30769 30770 30771 30772 30773 30774 30775 30776 30777 30778 30779 30780 30781 30782 30783 30784 30785 30786 30787 30788 30789 30790 30791 30792 30793 30794 30795 30796 30797 30798 30799 30800 30801 30802 30803 30804 30805 30806 30807 30808 30809 30810 30811 30812 30813 30814 30815 30816 30817 30818 30819 30820 30821 30822 30823 30824 30825 30826 30827 30828 30829 30830 30831 30832 30833 30834 30835 30836 30837 30838 30839 30840 30841 30842 30843 30844 30845 30846 30847 30848 30849 30850 30851 30852 30853 30854 30855 30856 30857 30858 30859 30860 30861 30862 30863 30864 30865 30866 30867 30868 30869 30870 30871 30872 30873 30874 30875 30876 30877 30878 30879 30880 30881 30882 30883 30884 30885 30886 30887 30888 30889 30890 30891 30892 30893 30894 30895 30896 30897 30898 30899 30900 30901 30902 30903 30904 30905 30906 30907 30908 30909 30910 30911 30912 30913 30914 30915 30916 30917 30918 30919 30920 30921 30922 30923 30924 30925 30926 30927 30928 30929 30930 30931 30932 30933 30934 30935 30936 30937 30938 30939 30940 30941 30942 30943 30944 30945 30946 30947 30948 30949 30950 30951 30952 30953 30954 30955 30956 30957 30958 30959 30960 30961 30962 30963 30964 30965 30966 30967 30968 30969 30970 30971 30972 30973 30974 30975 30976 30977 30978 30979 30980 30981 30982 30983 30984 30985 30986 30987 30988 30989 30990 30991 30992 30993 30994 30995 30996 30997 30998 30999 31000 31001 31002 31003 31004 31005 31006 31007 31008 31009 31010 31011 31012 31013 31014 31015 31016 31017 31018 31019 31020 31021 31022 31023 31024 31025 31026 31027 31028 31029 31030 31031 31032 31033 31034 31035 31036 31037 31038 31039 31040 31041 31042 31043 31044 31045 31046 31047 31048 31049 31050 31051 31052 31053 31054 31055 31056 31057 31058 31059 31060 31061 31062 31063 31064 31065 31066 31067 31068 31069 31070 31071 31072 31073 31074 31075 31076 31077 31078 31079 31080 31081 31082 31083 31084 31085 31086 31087 31088 31089 31090 31091 31092 31093 31094 31095 31096 31097 31098 31099 31100 31101 31102 31103 31104 31105 31106 31107 31108 31109 31110 31111 31112 31113 31114 31115 31116 31117 31118 31119 31120 31121 31122 31123 31124 31125 31126 31127 31128 31129 31130 31131 31132 31133 31134 31135 31136 31137 31138 31139 31140 31141 31142 31143 31144 31145 31146 31147 31148 31149 31150 31151 31152 31153 31154 31155 31156 31157 31158 31159 31160 31161 31162 31163 31164 31165 31166 31167 31168 31169 31170 31171 31172 31173 31174 31175 31176 31177 31178 31179 31180 31181 31182 31183 31184 31185 31186 31187 31188 31189 31190 31191 31192 31193 31194 31195 31196 31197 31198 31199 31200 31201 31202 31203 31204 31205 31206 31207 31208 31209 31210 31211 31212 31213 31214 31215 31216 31217 31218 31219 31220 31221 31222 31223 31224 31225 31226 31227 31228 31229 31230 31231 31232 31233 31234 31235 31236 31237 31238 31239 31240 31241 31242 31243 31244 31245 31246 31247 31248 31249 31250 31251 31252 31253 31254 31255 31256 31257 31258 31259 31260 31261 31262 31263 31264 31265 31266 31267 31268 31269 31270 31271 31272 31273 31274 31275 31276 31277 31278 31279 31280 31281 31282 31283 31284 31285 31286 31287 31288 31289 31290 31291 31292 31293 31294 31295 31296 31297 31298 31299 31300 31301 31302 31303 31304 31305 31306 31307 31308 31309 31310 31311 31312 31313 31314 31315 31316 31317 31318 31319 31320 31321 31322 31323 31324 31325 31326 31327 31328 31329 31330 31331 31332 31333 31334 31335 31336 31337 31338 31339 31340 31341 31342 31343 31344 31345 31346 31347 31348 31349 31350 31351 31352 31353 31354 31355 31356 31357 31358 31359 31360 31361 31362 31363 31364 31365 31366 31367 31368 31369 31370 31371 31372 31373 31374 31375 31376 31377 31378 31379 31380 31381 31382 31383 31384 31385 31386 31387 31388 31389 31390 31391 31392 31393 31394 31395 31396 31397 31398 31399 31400 31401 31402 31403 31404 31405 31406 31407 31408 31409 31410 31411 31412 31413 31414 31415 31416 31417 31418 31419 31420 31421 31422 31423 31424 31425 31426 31427 31428 31429 31430 31431 31432 31433 31434 31435 31436 31437 31438 31439 31440 31441 31442 31443 31444 31445 31446 31447 31448 31449 31450 31451 31452 31453 31454 31455 31456 31457 31458 31459 31460 31461 31462 31463 31464 31465 31466 31467 31468 31469 31470 31471 31472 31473 31474 31475 31476 31477 31478 31479 31480 31481 31482 31483 31484 31485 31486 31487 31488 31489 31490 31491 31492 31493 31494 31495 31496 31497 31498 31499 31500 31501 31502 31503 31504 31505 31506 31507 31508 31509 31510 31511 31512 31513 31514 31515 31516 31517 31518 31519 31520 31521 31522 31523 31524 31525 31526 31527 31528 31529 31530 31531 31532 31533 31534 31535 31536 31537 31538 31539 31540 31541 31542 31543 31544 31545 31546 31547 31548 31549 31550 31551 31552 31553 31554 31555 31556 31557 31558 31559 31560 31561 31562 31563 31564 31565 31566 31567 31568 31569 31570 31571 31572 31573 31574 31575 31576 31577 31578 31579 31580 31581 31582 31583 31584 31585 31586 31587 31588 31589 31590 31591 31592 31593 31594 31595 31596 31597 31598 31599 31600 31601 31602 31603 31604 31605 31606 31607 31608 31609 31610 31611 31612 31613 31614 31615 31616 31617 31618 31619 31620 31621 31622 31623 31624 31625 31626 31627 31628 31629 31630 31631 31632 31633 31634 31635 31636 31637 31638 31639 31640 31641 31642 31643 31644 31645 31646 31647 31648 31649 31650 31651 31652 31653 31654 31655 31656 31657 31658 31659 31660 31661 31662 31663 31664 31665 31666 31667 31668 31669 31670 31671 31672 31673 31674 31675 31676 31677 31678 31679 31680 31681 31682 31683 31684 31685 31686 31687 31688 31689 31690 31691 31692 31693 31694 31695 31696 31697 31698 31699 31700 31701 31702 31703 31704 31705 31706 31707 31708 31709 31710 31711 31712 31713 31714 31715 31716 31717 31718 31719 31720 31721 31722 31723 31724 31725 31726 31727 31728 31729 31730 31731 31732 31733 31734 31735 31736 31737 31738 31739 31740 31741 31742 31743 31744 31745 31746 31747 31748 31749 31750 31751 31752 31753 31754 31755 31756 31757 31758 31759 31760 31761 31762 31763 31764 31765 31766 31767 31768 31769 31770 31771 31772 31773 31774 31775 31776 31777 31778 31779 31780 31781 31782 31783 31784 31785 31786 31787 31788 31789 31790 31791 31792 31793 31794 31795 31796 31797 31798 31799 31800 31801 31802 31803 31804 31805 31806 31807 31808 31809 31810 31811 31812 31813 31814 31815 31816 31817 31818 31819 31820 31821 31822 31823 31824 31825 31826 31827 31828 31829 31830 31831 31832 31833 31834 31835 31836 31837 31838 31839 31840 31841 31842 31843 31844 31845 31846 31847 31848 31849 31850 31851 31852 31853 31854 31855 31856 31857 31858 31859 31860 31861 31862 31863 31864 31865 31866 31867 31868 31869 31870 31871 31872 31873 31874 31875 31876 31877 31878 31879 31880 31881 31882 31883 31884 31885 31886 31887 31888 31889 31890 31891 31892 31893 31894 31895 31896 31897 31898 31899 31900 31901 31902 31903 31904 31905 31906 31907 31908 31909 31910 31911 31912 31913 31914 31915 31916 31917 31918 31919 31920 31921 31922 31923 31924 31925 31926 31927 31928 31929 31930 31931 31932 31933 31934 31935 31936 31937 31938 31939 31940 31941 31942 31943 31944 31945 31946 31947 31948 31949 31950 31951 31952 31953 31954 31955 31956 31957 31958 31959 31960 31961 31962 31963 31964 31965 31966 31967 31968 31969 31970 31971 31972 31973 31974 31975 31976 31977 31978 31979 31980 31981 31982 31983 31984 31985 31986 31987 31988 31989 31990 31991 31992 31993 31994 31995 31996 31997 31998 31999 32000 32001 32002 32003 32004 32005 32006 32007 32008 32009 32010 32011 32012 32013 32014 32015 32016 32017 32018 32019 32020 32021 32022 32023 32024 32025 32026 32027 32028 32029 32030 32031 32032 32033 32034 32035 32036 32037 32038 32039 32040 32041 32042 32043 32044 32045 32046 32047 32048 32049 32050 32051 32052 32053 32054 32055 32056 32057 32058 32059 32060 32061 32062 32063 32064 32065 32066 32067 32068 32069 32070 32071 32072 32073 32074 32075 32076 32077 32078 32079 32080 32081 32082 32083 32084 32085 32086 32087 32088 32089 32090 32091 32092 32093 32094 32095 32096 32097 32098 32099 32100 32101 32102 32103 32104 32105 32106 32107 32108 32109 32110 32111 32112 32113 32114 32115 32116 32117 32118 32119 32120 32121 32122 32123 32124 32125 32126 32127 32128 32129 32130 32131 32132 32133 32134 32135 32136 32137 32138 32139 32140 32141 32142 32143 32144 32145 32146 32147 32148 32149 32150 32151 32152 32153 32154 32155 32156 32157 32158 32159 32160 32161 32162 32163 32164 32165 32166 32167 32168 32169 32170 32171 32172 32173 32174 32175 32176 32177 32178 32179 32180 32181 32182 32183 32184 32185 32186 32187 32188 32189 32190 32191 32192 32193 32194 32195 32196 32197 32198 32199 32200 32201 32202 32203 32204 32205 32206 32207 32208 32209 32210 32211 32212 32213 32214 32215 32216 32217 32218 32219 32220 32221 32222 32223 32224 32225 32226 32227 32228 32229 32230 32231 32232 32233 32234 32235 32236 32237 32238 32239 32240 32241 32242 32243 32244 32245 32246 32247 32248 32249 32250 32251 32252 32253 32254 32255 32256 32257 32258 32259 32260 32261 32262 32263 32264 32265 32266 32267 32268 32269 32270 32271 32272 32273 32274 32275 32276 32277 32278 32279 32280 32281 32282 32283 32284 32285 32286 32287 32288 32289 32290 32291 32292 32293 32294 32295 32296 32297 32298 32299 32300 32301 32302 32303 32304 32305 32306 32307 32308 32309 32310 32311 32312 32313 32314 32315 32316 32317 32318 32319 32320 32321 32322 32323 32324 32325 32326 32327 32328 32329 32330 32331 32332 32333 32334 32335 32336 32337 32338 32339 32340 32341 32342 32343 32344 32345 32346 32347 32348 32349 32350 32351 32352 32353 32354 32355 32356 32357 32358 32359 32360 32361 32362 32363 32364 32365 32366 32367 32368 32369 32370 32371 32372 32373 32374 32375 32376 32377 32378 32379 32380 32381 32382 32383 32384 32385 32386 32387 32388 32389 32390 32391 32392 32393 32394 32395 32396 32397 32398 32399 32400 32401 32402 32403 32404 32405 32406 32407 32408 32409 32410 32411 32412 32413 32414 32415 32416 32417 32418 32419 32420 32421 32422 32423 32424 32425 32426 32427 32428 32429 32430 32431 32432 32433 32434 32435 32436 32437 32438 32439 32440 32441 32442 32443 32444 32445 32446 32447 32448 32449 32450 32451 32452 32453 32454 32455 32456 32457 32458 32459 32460 32461 32462 32463 32464 32465 32466 32467 32468 32469 32470 32471 32472 32473 32474 32475 32476 32477 32478 32479 32480 32481 32482 32483 32484 32485 32486 32487 32488 32489 32490 32491 32492 32493 32494 32495 32496 32497 32498 32499 32500 32501 32502 32503 32504 32505 32506 32507 32508 32509 32510 32511 32512 32513 32514 32515 32516 32517 32518 32519 32520 32521 32522 32523 32524 32525 32526 32527 32528 32529 32530 32531 32532 32533 32534 32535 32536 32537 32538 32539 32540 32541 32542 32543 32544 32545 32546 32547 32548 32549 32550 32551 32552 32553 32554 32555 32556 32557 32558 32559 32560 32561 32562 32563 32564 32565 32566 32567 32568 32569 32570 32571 32572 32573 32574 32575 32576 32577 32578 32579 32580 32581 32582 32583 32584 32585 32586 32587 32588 32589 32590 32591 32592 32593 32594 32595 32596 32597 32598 32599 32600 32601 32602 32603 32604 32605 32606 32607 32608 32609 32610 32611 32612 32613 32614 32615 32616 32617 32618 32619 32620 32621 32622 32623 32624 32625 32626 32627 32628 32629 32630 32631 32632 32633 32634 32635 32636 32637 32638 32639 32640 32641 32642 32643 32644 32645 32646 32647 32648 32649 32650 32651 32652 32653 32654 32655 32656 32657 32658 32659 32660 32661 32662 32663 32664 32665 32666 32667 32668 32669 32670 32671 32672 32673 32674 32675 32676 32677 32678 32679 32680 32681 32682 32683 32684 32685 32686 32687 32688 32689 32690 32691 32692 32693 32694 32695 32696 32697 32698 32699 32700 32701 32702 32703 32704 32705 32706 32707 32708 32709 32710 32711 32712 32713 32714 32715 32716 32717 32718 32719 32720 32721 32722 32723 32724 32725 32726 32727 32728 32729 32730 32731 32732 32733 32734 32735 32736 32737 32738 32739 32740 32741 32742 32743 32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 32759 32760 32761 32762 32763 32764 32765 32766 32767 32768 32769 32770 32771 32772 32773 32774 32775 32776 32777 32778 32779 32780 32781 32782 32783 32784 32785 32786 32787 32788 32789 32790 32791 32792 32793 32794 32795 32796 32797 32798 32799 32800 32801 32802 32803 32804 32805 32806 32807 32808 32809 32810 32811 32812 32813 32814 32815 32816 32817 32818 32819 32820 32821 32822 32823 32824 32825 32826 32827 32828 32829 32830 32831 32832 32833 32834 32835 32836 32837 32838 32839 32840 32841 32842 32843 32844 32845 32846 32847 32848 32849 32850 32851 32852 32853 32854 32855 32856 32857 32858 32859 32860 32861 32862 32863 32864 32865 32866 32867 32868 32869 32870 32871 32872 32873 32874 32875 32876 32877 32878 32879 32880 32881 32882 32883 32884 32885 32886 32887 32888 32889 32890 32891 32892 32893 32894 32895 32896 32897 32898 32899 32900 32901 32902 32903 32904 32905 32906 32907 32908 32909 32910 32911 32912 32913 32914 32915 32916 32917 32918 32919 32920 32921 32922 32923 32924 32925 32926 32927 32928 32929 32930 32931 32932 32933 32934 32935 32936 32937 32938 32939 32940 32941 32942 32943 32944 32945 32946 32947 32948 32949 32950 32951 32952 32953 32954 32955 32956 32957 32958 32959 32960 32961 32962 32963 32964 32965 32966 32967 32968 32969 32970 32971 32972 32973 32974 32975 32976 32977 32978 32979 32980 32981 32982 32983 32984 32985 32986 32987 32988 32989 32990 32991 32992 32993 32994 32995 32996 32997 32998 32999 33000 33001 33002 33003 33004 33005 33006 33007 33008 33009 33010 33011 33012 33013 33014 33015 33016 33017 33018 33019 33020 33021 33022 33023 33024 33025 33026 33027 33028 33029 33030 33031 33032 33033 33034 33035 33036 33037 33038 33039 33040 33041 33042 33043 33044 33045 33046 33047 33048 33049 33050 33051 33052 33053 33054 33055 33056 33057 33058 33059 33060 33061 33062 33063 33064 33065 33066 33067 33068 33069 33070 33071 33072 33073 33074 33075 33076 33077 33078 33079 33080 33081 33082 33083 33084 33085 33086 33087 33088 33089 33090 33091 33092 33093 33094 33095 33096 33097 33098 33099 33100 33101 33102 33103 33104 33105 33106 33107 33108 33109 33110 33111 33112 33113 33114 33115 33116 33117 33118 33119 33120 33121 33122 33123 33124 33125 33126 33127 33128 33129 33130 33131 33132 33133 33134 33135 33136 33137 33138 33139 33140 33141 33142 33143 33144 33145 33146 33147 33148 33149 33150 33151 33152 33153 33154 33155 33156 33157 33158 33159 33160 33161 33162 33163 33164 33165 33166 33167 33168 33169 33170 33171 33172 33173 33174 33175 33176 33177 33178 33179 33180 33181 33182 33183 33184 33185 33186 33187 33188 33189 33190 33191 33192 33193 33194 33195 33196 33197 33198 33199 33200 33201 33202 33203 33204 33205 33206 33207 33208 33209 33210 33211 33212 33213 33214 33215 33216 33217 33218 33219 33220 33221 33222 33223 33224 33225 33226 33227 33228 33229 33230 33231 33232 33233 33234 33235 33236 33237 33238 33239 33240 33241 33242 33243 33244 33245 33246 33247 33248 33249 33250 33251 33252 33253 33254 33255 33256 33257 33258 33259 33260 33261 33262 33263 33264 33265 33266 33267 33268 33269 33270 33271 33272 33273 33274 33275 33276 33277 33278 33279 33280 33281 33282 33283 33284 33285 33286 33287 33288 33289 33290 33291 33292 33293 33294 33295 33296 33297 33298 33299 33300 33301 33302 33303 33304 33305 33306 33307 33308 33309 33310 33311 33312 33313 33314 33315 33316 33317 33318 33319 33320 33321 33322 33323 33324 33325 33326 33327 33328 33329 33330 33331 33332 33333 33334 33335 33336 33337 33338 33339 33340 33341 33342 33343 33344 33345 33346 33347 33348 33349 33350 33351 33352 33353 33354 33355 33356 33357 33358 33359 33360 33361 33362 33363 33364 33365 33366 33367 33368 33369 33370 33371 33372 33373 33374 33375 33376 33377 33378 33379 33380 33381 33382 33383 33384 33385 33386 33387 33388 33389 33390 33391 33392 33393 33394 33395 33396 33397 33398 33399 33400 33401 33402 33403 33404 33405 33406 33407 33408 33409 33410 33411 33412 33413 33414 33415 33416 33417 33418 33419 33420 33421 33422 33423 33424 33425 33426 33427 33428 33429 33430 33431 33432 33433 33434 33435 33436 33437 33438 33439 33440 33441 33442 33443 33444 33445 33446 33447 33448 33449 33450 33451 33452 33453 33454 33455 33456 33457 33458 33459 33460 33461 33462 33463 33464 33465 33466 33467 33468 33469 33470 33471 33472 33473 33474 33475 33476 33477 33478 33479 33480 33481 33482 33483 33484 33485 33486 33487 33488 33489 33490 33491 33492 33493 33494 33495 33496 33497 33498 33499 33500 33501 33502 33503 33504 33505 33506 33507 33508 33509 33510 33511 33512 33513 33514 33515 33516 33517 33518 33519 33520 33521 33522 33523 33524 33525 33526 33527 33528 33529 33530 33531 33532 33533 33534 33535 33536 33537 33538 33539 33540 33541 33542 33543 33544 33545 33546 33547 33548 33549 33550 33551 33552 33553 33554 33555 33556 33557 33558 33559 33560 33561 33562 33563 33564 33565 33566 33567 33568 33569 33570 33571 33572 33573 33574 33575 33576 33577 33578 33579 33580 33581 33582 33583 33584 33585 33586 33587 33588 33589 33590 33591 33592 33593 33594 33595 33596 33597 33598 33599 33600 33601 33602 33603 33604 33605 33606 33607 33608 33609 33610 33611 33612 33613 33614 33615 33616 33617 33618 33619 33620 33621 33622 33623 33624 33625 33626 33627 33628 33629 33630 33631 33632 33633 33634 33635 33636 33637 33638 33639 33640 33641 33642 33643 33644 33645 33646 33647 33648 33649 33650 33651 33652 33653 33654 33655 33656 33657 33658 33659 33660 33661 33662 33663 33664 33665 33666 33667 33668 33669 33670 33671 33672 33673 33674 33675 33676 33677 33678 33679 33680 33681 33682 33683 33684 33685 33686 33687 33688 33689 33690 33691 33692 33693 33694 33695 33696 33697 33698 33699 33700 33701 33702 33703 33704 33705 33706 33707 33708 33709 33710 33711 33712 33713 33714 33715 33716 33717 33718 33719 33720 33721 33722 33723 33724 33725 33726 33727 33728 33729 33730 33731 33732 33733 33734 33735 33736 33737 33738 33739 33740 33741 33742 33743 33744 33745 33746 33747 33748 33749 33750 33751 33752 33753 33754 33755 33756 33757 33758 33759 33760 33761 33762 33763 33764 33765 33766 33767 33768 33769 33770 33771 33772 33773 33774 33775 33776 33777 33778 33779 33780 33781 33782 33783 33784 33785 33786 33787 33788 33789 33790 33791 33792 33793 33794 33795 33796 33797 33798 33799 33800 33801 33802 33803 33804 33805 33806 33807 33808 33809 33810 33811 33812 33813 33814 33815 33816 33817 33818 33819 33820 33821 33822 33823 33824 33825 33826 33827 33828 33829 33830 33831 33832 33833 33834 33835 33836 33837 33838 33839 33840 33841 33842 33843 33844 33845 33846 33847 33848 33849 33850 33851 33852 33853 33854 33855 33856 33857 33858 33859 33860 33861 33862 33863 33864 33865 33866 33867 33868 33869 33870 33871 33872 33873 33874 33875 33876 33877 33878 33879 33880 33881 33882 33883 33884 33885 33886 33887 33888 33889 33890 33891 33892 33893 33894 33895 33896 33897 33898 33899 33900 33901 33902 33903 33904 33905 33906 33907 33908 33909 33910 33911 33912 33913 33914 33915 33916 33917 33918 33919 33920 33921 33922 33923 33924 33925 33926 33927 33928 33929 33930 33931 33932 33933 33934 33935 33936 33937 33938 33939 33940 33941 33942 33943 33944 33945 33946 33947 33948 33949 33950 33951 33952 33953 33954 33955 33956 33957 33958 33959 33960 33961 33962 33963 33964 33965 33966 33967 33968 33969 33970 33971 33972 33973 33974 33975 33976 33977 33978 33979 33980 33981 33982 33983 33984 33985 33986 33987 33988 33989 33990 33991 33992 33993 33994 33995 33996 33997 33998 33999 34000 34001 34002 34003 34004 34005 34006 34007 34008 34009 34010 34011 34012 34013 34014 34015 34016 34017 34018 34019 34020 34021 34022 34023 34024 34025 34026 34027 34028 34029 34030 34031 34032 34033 34034 34035 34036 34037 34038 34039 34040 34041 34042 34043 34044 34045 34046 34047 34048 34049 34050 34051 34052 34053 34054 34055 34056 34057 34058 34059 34060 34061 34062 34063 34064 34065 34066 34067 34068 34069 34070 34071 34072 34073 34074 34075 34076 34077 34078 34079 34080 34081 34082 34083 34084 34085 34086 34087 34088 34089 34090 34091 34092 34093 34094 34095 34096 34097 34098 34099 34100 34101 34102 34103 34104 34105 34106 34107 34108 34109 34110 34111 34112 34113 34114 34115 34116 34117 34118 34119 34120 34121 34122 34123 34124 34125 34126 34127 34128 34129 34130 34131 34132 34133 34134 34135 34136 34137 34138 34139 34140 34141 34142 34143 34144 34145 34146 34147 34148 34149 34150 34151 34152 34153 34154 34155 34156 34157 34158 34159 34160 34161 34162 34163 34164 34165 34166 34167 34168 34169 34170 34171 34172 34173 34174 34175 34176 34177 34178 34179 34180 34181 34182 34183 34184 34185 34186 34187 34188 34189 34190 34191 34192 34193 34194 34195 34196 34197 34198 34199 34200 34201 34202 34203 34204 34205 34206 34207 34208 34209 34210 34211 34212 34213 34214 34215 34216 34217 34218 34219 34220 34221 34222 34223 34224 34225 34226 34227 34228 34229 34230 34231 34232 34233 34234 34235 34236 34237 34238 34239 34240 34241 34242 34243 34244 34245 34246 34247 34248 34249 34250 34251 34252 34253 34254 34255 34256 34257 34258 34259 34260 34261 34262 34263 34264 34265 34266 34267 34268 34269 34270 34271 34272 34273 34274 34275 34276 34277 34278 34279 34280 34281 34282 34283 34284 34285 34286 34287 34288 34289 34290 34291 34292 34293 34294 34295 34296 34297 34298 34299 34300 34301 34302 34303 34304 34305 34306 34307 34308 34309 34310 34311 34312 34313 34314 34315 34316 34317 34318 34319 34320 34321 34322 34323 34324 34325 34326 34327 34328 34329 34330 34331 34332 34333 34334 34335 34336 34337 34338 34339 34340 34341 34342 34343 34344 34345 34346 34347 34348 34349 34350 34351 34352 34353 34354 34355 34356 34357 34358 34359 34360 34361 34362 34363 34364 34365 34366 34367 34368 34369 34370 34371 34372 34373 34374 34375 34376 34377 34378 34379 34380 34381 34382 34383 34384 34385 34386 34387 34388 34389 34390 34391 34392 34393 34394 34395 34396 34397 34398 34399 34400 34401 34402 34403 34404 34405 34406 34407 34408 34409 34410 34411 34412 34413 34414 34415 34416 34417 34418 34419 34420 34421 34422 34423 34424 34425 34426 34427 34428 34429 34430 34431 34432 34433 34434 34435 34436 34437 34438 34439 34440 34441 34442 34443 34444 34445 34446 34447 34448 34449 34450 34451 34452 34453 34454 34455 34456 34457 34458 34459 34460 34461 34462 34463 34464 34465 34466 34467 34468 34469 34470 34471 34472 34473 34474 34475 34476 34477 34478 34479 34480 34481 34482 34483 34484 34485 34486 34487 34488 34489 34490 34491 34492 34493 34494 34495 34496 34497 34498 34499 34500 34501 34502 34503 34504 34505 34506 34507 34508 34509 34510 34511 34512 34513 34514 34515 34516 34517 34518 34519 34520 34521 34522 34523 34524 34525 34526 34527 34528 34529 34530 34531 34532 34533 34534 34535 34536 34537 34538 34539 34540 34541 34542 34543 34544 34545 34546 34547 34548 34549 34550 34551 34552 34553 34554 34555 34556 34557 34558 34559 34560 34561 34562 34563 34564 34565 34566 34567 34568 34569 34570 34571 34572 34573 34574 34575 34576 34577 34578 34579 34580 34581 34582 34583 34584 34585 34586 34587 34588 34589 34590 34591 34592 34593 34594 34595 34596 34597 34598 34599 34600 34601 34602 34603 34604 34605 34606 34607 34608 34609 34610 34611 34612 34613 34614 34615 34616 34617 34618 34619 34620 34621 34622 34623 34624 34625 34626 34627 34628 34629 34630 34631 34632 34633 34634 34635 34636 34637 34638 34639 34640 34641 34642 34643 34644 34645 34646 34647 34648 34649 34650 34651 34652 34653 34654 34655 34656 34657 34658 34659 34660 34661 34662 34663 34664 34665 34666 34667 34668 34669 34670 34671 34672 34673 34674 34675 34676 34677 34678 34679 34680 34681 34682 34683 34684 34685 34686 34687 34688 34689 34690 34691 34692 34693 34694 34695 34696 34697 34698 34699 34700 34701 34702 34703 34704 34705 34706 34707 34708 34709 34710 34711 34712 34713 34714 34715 34716 34717 34718 34719 34720 34721 34722 34723 34724 34725 34726 34727 34728 34729 34730 34731 34732 34733 34734 34735 34736 34737 34738 34739 34740 34741 34742 34743 34744 34745 34746 34747 34748 34749 34750 34751 34752 34753 34754 34755 34756 34757 34758 34759 34760 34761 34762 34763 34764 34765 34766 34767 34768 34769 34770 34771 34772 34773 34774 34775 34776 34777 34778 34779 34780 34781 34782 34783 34784 34785 34786 34787 34788 34789 34790 34791 34792 34793 34794 34795 34796 34797 34798 34799 34800 34801 34802 34803 34804 34805 34806 34807 34808 34809 34810 34811 34812 34813 34814 34815 34816 34817 34818 34819 34820 34821 34822 34823 34824 34825 34826 34827 34828 34829 34830 34831 34832 34833 34834 34835 34836 34837 34838 34839 34840 34841 34842 34843 34844 34845 34846 34847 34848 34849 34850 34851 34852 34853 34854 34855 34856 34857 34858 34859 34860 34861 34862 34863 34864 34865 34866 34867 34868 34869 34870 34871 34872 34873 34874 34875 34876 34877 34878 34879 34880 34881 34882 34883 34884 34885 34886 34887 34888 34889 34890 34891 34892 34893 34894 34895 34896 34897 34898 34899 34900 34901 34902 34903 34904 34905 34906 34907 34908 34909 34910 34911 34912 34913 34914 34915 34916 34917 34918 34919 34920 34921 34922 34923 34924 34925 34926 34927 34928 34929 34930 34931 34932 34933 34934 34935 34936 34937 34938 34939 34940 34941 34942 34943 34944 34945 34946 34947 34948 34949 34950 34951 34952 34953 34954 34955 34956 34957 34958 34959 34960 34961 34962 34963 34964 34965 34966 34967 34968 34969 34970 34971 34972 34973 34974 34975 34976 34977 34978 34979 34980 34981 34982 34983 34984 34985 34986 34987 34988 34989 34990 34991 34992 34993 34994 34995 34996 34997 34998 34999 35000 35001 35002 35003 35004 35005 35006 35007 35008 35009 35010 35011 35012 35013 35014 35015 35016 35017 35018 35019 35020 35021 35022 35023 35024 35025 35026 35027 35028 35029 35030 35031 35032 35033 35034 35035 35036 35037 35038 35039 35040 35041 35042 35043 35044 35045 35046 35047 35048 35049 35050 35051 35052 35053 35054 35055 35056 35057 35058 35059 35060 35061 35062 35063 35064 35065 35066 35067 35068 35069 35070 35071 35072 35073 35074 35075 35076 35077 35078 35079 35080 35081 35082 35083 35084 35085 35086 35087 35088 35089 35090 35091 35092 35093 35094 35095 35096 35097 35098 35099 35100 35101 35102 35103 35104 35105 35106 35107 35108 35109 35110 35111 35112 35113 35114 35115 35116 35117 35118 35119 35120 35121 35122 35123 35124 35125 35126 35127 35128 35129 35130 35131 35132 35133 35134 35135 35136 35137 35138 35139 35140 35141 35142 35143 35144 35145 35146 35147 35148 35149 35150 35151 35152 35153 35154 35155 35156 35157 35158 35159 35160 35161 35162 35163 35164 35165 35166 35167 35168 35169 35170 35171 35172 35173 35174 35175 35176 35177 35178 35179 35180 35181 35182 35183 35184 35185 35186 35187 35188 35189 35190 35191 35192 35193 35194 35195 35196 35197 35198 35199 35200 35201 35202 35203 35204 35205 35206 35207 35208 35209 35210 35211 35212 35213 35214 35215 35216 35217 35218 35219 35220 35221 35222 35223 35224 35225 35226 35227 35228 35229 35230 35231 35232 35233 35234 35235 35236 35237 35238 35239 35240 35241 35242 35243 35244 35245 35246 35247 35248 35249 35250 35251 35252 35253 35254 35255 35256 35257 35258 35259 35260 35261 35262 35263 35264 35265 35266 35267 35268 35269 35270 35271 35272 35273 35274 35275 35276 35277 35278 35279 35280 35281 35282 35283 35284 35285 35286 35287 35288 35289 35290 35291 35292 35293 35294 35295 35296 35297 35298 35299 35300 35301 35302 35303 35304 35305 35306 35307 35308 35309 35310 35311 35312 35313 35314 35315 35316 35317 35318 35319 35320 35321 35322 35323 35324 35325 35326 35327 35328 35329 35330 35331 35332 35333 35334 35335 35336 35337 35338 35339 35340 35341 35342 35343 35344 35345 35346 35347 35348 35349 35350 35351 35352 35353 35354 35355 35356 35357 35358 35359 35360 35361 35362 35363 35364 35365 35366 35367 35368 35369 35370 35371 35372 35373 35374 35375 35376 35377 35378 35379 35380 35381 35382 35383 35384 35385 35386 35387 35388 35389 35390 35391 35392 35393 35394 35395 35396 35397 35398 35399 35400 35401 35402 35403 35404 35405 35406 35407 35408 35409 35410 35411 35412 35413 35414 35415 35416 35417 35418 35419 35420 35421 35422 35423 35424 35425 35426 35427 35428 35429 35430 35431 35432 35433 35434 35435 35436 35437 35438 35439 35440 35441 35442 35443 35444 35445 35446 35447 35448 35449 35450 35451 35452 35453 35454 35455 35456 35457 35458 35459 35460 35461 35462 35463 35464 35465 35466 35467 35468 35469 35470 35471 35472 35473 35474 35475 35476 35477 35478 35479 35480 35481 35482 35483 35484 35485 35486 35487 35488 35489 35490 35491 35492 35493 35494 35495 35496 35497 35498 35499 35500 35501 35502 35503 35504 35505 35506 35507 35508 35509 35510 35511 35512 35513 35514 35515 35516 35517 35518 35519 35520 35521 35522 35523 35524 35525 35526 35527 35528 35529 35530 35531 35532 35533 35534 35535 35536 35537 35538 35539 35540 35541 35542 35543 35544 35545 35546 35547 35548 35549 35550 35551 35552 35553 35554 35555 35556 35557 35558 35559 35560 35561 35562 35563 35564 35565 35566 35567 35568 35569 35570 35571 35572 35573 35574 35575 35576 35577 35578 35579 35580 35581 35582 35583 35584 35585 35586 35587 35588 35589 35590 35591 35592 35593 35594 35595 35596 35597 35598 35599 35600 35601 35602 35603 35604 35605 35606 35607 35608 35609 35610 35611 35612 35613 35614 35615 35616 35617 35618 35619 35620 35621 35622 35623 35624 35625 35626 35627 35628 35629 35630 35631 35632 35633 35634 35635 35636 35637 35638 35639 35640 35641 35642 35643 35644 35645 35646 35647 35648 35649 35650 35651 35652 35653 35654 35655 35656 35657 35658 35659 35660 35661 35662 35663 35664 35665 35666 35667 35668 35669 35670 35671 35672 35673 35674 35675 35676 35677 35678 35679 35680 35681 35682 35683 35684 35685 35686 35687 35688 35689 35690 35691 35692 35693 35694 35695 35696 35697 35698 35699 35700 35701 35702 35703 35704 35705 35706 35707 35708 35709 35710 35711 35712 35713 35714 35715 35716 35717 35718 35719 35720 35721 35722 35723 35724 35725 35726 35727 35728 35729 35730 35731 35732 35733 35734 35735 35736 35737 35738 35739 35740 35741 35742 35743 35744 35745 35746 35747 35748 35749 35750 35751 35752 35753 35754 35755 35756 35757 35758 35759 35760 35761 35762 35763 35764 35765 35766 35767 35768 35769 35770 35771 35772 35773 35774 35775 35776 35777 35778 35779 35780 35781 35782 35783 35784 35785 35786 35787 35788 35789 35790 35791 35792 35793 35794 35795 35796 35797 35798 35799 35800 35801 35802 35803 35804 35805 35806 35807 35808 35809 35810 35811 35812 35813 35814 35815 35816 35817 35818 35819 35820 35821 35822 35823 35824 35825 35826 35827 35828 35829 35830 35831 35832 35833 35834 35835 35836 35837 35838 35839 35840 35841 35842 35843 35844 35845 35846 35847 35848 35849 35850 35851 35852 35853 35854 35855 35856 35857 35858 35859 35860 35861 35862 35863 35864 35865 35866 35867 35868 35869 35870 35871 35872 35873 35874 35875 35876 35877 35878 35879 35880 35881 35882 35883 35884 35885 35886 35887 35888 35889 35890 35891 35892 35893 35894 35895 35896 35897 35898 35899 35900 35901 35902 35903 35904 35905 35906 35907 35908 35909 35910 35911 35912 35913 35914 35915 35916 35917 35918 35919 35920 35921 35922 35923 35924 35925 35926 35927 35928 35929 35930 35931 35932 35933 35934 35935 35936 35937 35938 35939 35940 35941 35942 35943 35944 35945 35946 35947 35948 35949 35950 35951 35952 35953 35954 35955 35956 35957 35958 35959 35960 35961 35962 35963 35964 35965 35966 35967 35968 35969 35970 35971 35972 35973 35974 35975 35976 35977 35978 35979 35980 35981 35982 35983 35984 35985 35986 35987 35988 35989 35990 35991 35992 35993 35994 35995 35996 35997 35998 35999 36000 36001 36002 36003 36004 36005 36006 36007 36008 36009 36010 36011 36012 36013 36014 36015 36016 36017 36018 36019 36020 36021 36022 36023 36024 36025 36026 36027 36028 36029 36030 36031 36032 36033 36034 36035 36036 36037 36038 36039 36040 36041 36042 36043 36044 36045 36046 36047 36048 36049 36050 36051 36052 36053 36054 36055 36056 36057 36058 36059 36060 36061 36062 36063 36064 36065 36066 36067 36068 36069 36070 36071 36072 36073 36074 36075 36076 36077 36078 36079 36080 36081 36082 36083 36084 36085 36086 36087 36088 36089 36090 36091 36092 36093 36094 36095 36096 36097 36098 36099 36100 36101 36102 36103 36104 36105 36106 36107 36108 36109 36110 36111 36112 36113 36114 36115 36116 36117 36118 36119 36120 36121 36122 36123 36124 36125 36126 36127 36128 36129 36130 36131 36132 36133 36134 36135 36136 36137 36138 36139 36140 36141 36142 36143 36144 36145 36146 36147 36148 36149 36150 36151 36152 36153 36154 36155 36156 36157 36158 36159 36160 36161 36162 36163 36164 36165 36166 36167 36168 36169 36170 36171 36172 36173 36174 36175 36176 36177 36178 36179 36180 36181 36182 36183 36184 36185 36186 36187 36188 36189 36190 36191 36192 36193 36194 36195 36196 36197 36198 36199 36200 36201 36202 36203 36204 36205 36206 36207 36208 36209 36210 36211 36212 36213 36214 36215 36216 36217 36218 36219 36220 36221 36222 36223 36224 36225 36226 36227 36228 36229 36230 36231 36232 36233 36234 36235 36236 36237 36238 36239 36240 36241 36242 36243 36244 36245 36246 36247 36248 36249 36250 36251 36252 36253 36254 36255 36256 36257 36258 36259 36260 36261 36262 36263 36264 36265 36266 36267 36268 36269 36270 36271 36272 36273 36274 36275 36276 36277 36278 36279 36280 36281 36282 36283 36284 36285 36286 36287 36288 36289 36290 36291 36292 36293 36294 36295 36296 36297 36298 36299 36300 36301 36302 36303 36304 36305 36306 36307 36308 36309 36310 36311 36312 36313 36314 36315 36316 36317 36318 36319 36320 36321 36322 36323 36324 36325 36326 36327 36328 36329 36330 36331 36332 36333 36334 36335 36336 36337 36338 36339 36340 36341 36342 36343 36344 36345 36346 36347 36348 36349 36350 36351 36352 36353 36354 36355 36356 36357 36358 36359 36360 36361 36362 36363 36364 36365 36366 36367 36368 36369 36370 36371 36372 36373 36374 36375 36376 36377 36378 36379 36380 36381 36382 36383 36384 36385 36386 36387 36388 36389 36390 36391 36392 36393 36394 36395 36396 36397 36398 36399 36400 36401 36402 36403 36404 36405 36406 36407 36408 36409 36410 36411 36412 36413 36414 36415 36416 36417 36418 36419 36420 36421 36422 36423 36424 36425 36426 36427 36428 36429 36430 36431 36432 36433 36434 36435 36436 36437 36438 36439 36440 36441 36442 36443 36444 36445 36446 36447 36448 36449 36450 36451 36452 36453 36454 36455 36456 36457 36458 36459 36460 36461 36462 36463 36464 36465 36466 36467 36468 36469 36470 36471 36472 36473 36474 36475 36476 36477 36478 36479 36480 36481 36482 36483 36484 36485 36486 36487 36488 36489 36490 36491 36492 36493 36494 36495 36496 36497 36498 36499 36500 36501 36502 36503 36504 36505 36506 36507 36508 36509 36510 36511 36512 36513 36514 36515 36516 36517 36518 36519 36520 36521 36522 36523 36524 36525 36526 36527 36528 36529 36530 36531 36532 36533 36534 36535 36536 36537 36538 36539 36540 36541 36542 36543 36544 36545 36546 36547 36548 36549 36550 36551 36552 36553 36554 36555 36556 36557 36558 36559 36560 36561 36562 36563 36564 36565 36566 36567 36568 36569 36570 36571 36572 36573 36574 36575 36576 36577 36578 36579 36580 36581 36582 36583 36584 36585 36586 36587 36588 36589 36590 36591 36592 36593 36594 36595 36596 36597 36598 36599 36600 36601 36602 36603 36604 36605 36606 36607 36608 36609 36610 36611 36612 36613 36614 36615 36616 36617 36618 36619 36620 36621 36622 36623 36624 36625 36626 36627 36628 36629 36630 36631 36632 36633 36634 36635 36636 36637 36638 36639 36640 36641 36642 36643 36644 36645 36646 36647 36648 36649 36650 36651 36652 36653 36654 36655 36656 36657 36658 36659 36660 36661 36662 36663 36664 36665 36666 36667 36668 36669
#[cfg(
any(
feature = "google-cloud-aiplatform-v1-schema-predict-instance",
feature = "google-cloud-aiplatform-v1-schema-predict-params",
feature = "google-cloud-aiplatform-v1-schema-predict-prediction",
feature = "google-cloud-aiplatform-v1-schema-trainingjob-definition",
)
)]
pub mod schema;
// This file is @generated by prost-build.
/// Schema is used to define the format of input/output data. Represents a select
/// subset of an [OpenAPI 3.0 schema
/// object](<https://spec.openapis.org/oas/v3.0.3#schema>). More fields may be
/// added in the future as needed.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Schema {
/// Optional. The type of the data.
#[prost(enumeration = "Type", tag = "1")]
pub r#type: i32,
/// Optional. The format of the data.
/// Supported formats:
/// for NUMBER type: "float", "double"
/// for INTEGER type: "int32", "int64"
/// for STRING type: "email", "byte", etc
#[prost(string, tag = "7")]
pub format: ::prost::alloc::string::String,
/// Optional. The title of the Schema.
#[prost(string, tag = "24")]
pub title: ::prost::alloc::string::String,
/// Optional. The description of the data.
#[prost(string, tag = "8")]
pub description: ::prost::alloc::string::String,
/// Optional. Indicates if the value may be null.
#[prost(bool, tag = "6")]
pub nullable: bool,
/// Optional. Default value of the data.
#[prost(message, optional, tag = "23")]
pub default: ::core::option::Option<::prost_types::Value>,
/// Optional. SCHEMA FIELDS FOR TYPE ARRAY
/// Schema of the elements of Type.ARRAY.
#[prost(message, optional, boxed, tag = "2")]
pub items: ::core::option::Option<::prost::alloc::boxed::Box<Schema>>,
/// Optional. Minimum number of the elements for Type.ARRAY.
#[prost(int64, tag = "21")]
pub min_items: i64,
/// Optional. Maximum number of the elements for Type.ARRAY.
#[prost(int64, tag = "22")]
pub max_items: i64,
/// Optional. Possible values of the element of Type.STRING with enum format.
/// For example we can define an Enum Direction as :
/// {type:STRING, format:enum, enum:\["EAST", NORTH", "SOUTH", "WEST"\]}
#[prost(string, repeated, tag = "9")]
pub r#enum: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. SCHEMA FIELDS FOR TYPE OBJECT
/// Properties of Type.OBJECT.
#[prost(btree_map = "string, message", tag = "3")]
pub properties: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
Schema,
>,
/// Optional. Required properties of Type.OBJECT.
#[prost(string, repeated, tag = "5")]
pub required: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. Minimum number of the properties for Type.OBJECT.
#[prost(int64, tag = "14")]
pub min_properties: i64,
/// Optional. Maximum number of the properties for Type.OBJECT.
#[prost(int64, tag = "15")]
pub max_properties: i64,
/// Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER
/// Minimum value of the Type.INTEGER and Type.NUMBER
#[prost(double, tag = "16")]
pub minimum: f64,
/// Optional. Maximum value of the Type.INTEGER and Type.NUMBER
#[prost(double, tag = "17")]
pub maximum: f64,
/// Optional. SCHEMA FIELDS FOR TYPE STRING
/// Minimum length of the Type.STRING
#[prost(int64, tag = "18")]
pub min_length: i64,
/// Optional. Maximum length of the Type.STRING
#[prost(int64, tag = "19")]
pub max_length: i64,
/// Optional. Pattern of the Type.STRING to restrict a string to a regular
/// expression.
#[prost(string, tag = "20")]
pub pattern: ::prost::alloc::string::String,
/// Optional. Example of the object. Will only populated when the object is the
/// root.
#[prost(message, optional, tag = "4")]
pub example: ::core::option::Option<::prost_types::Value>,
}
/// Type contains the list of OpenAPI data types as defined by
/// <https://swagger.io/docs/specification/data-models/data-types/>
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Type {
/// Not specified, should not be used.
Unspecified = 0,
/// OpenAPI string type
String = 1,
/// OpenAPI number type
Number = 2,
/// OpenAPI integer type
Integer = 3,
/// OpenAPI boolean type
Boolean = 4,
/// OpenAPI array type
Array = 5,
/// OpenAPI object type
Object = 6,
}
impl Type {
/// 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 {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::String => "STRING",
Type::Number => "NUMBER",
Type::Integer => "INTEGER",
Type::Boolean => "BOOLEAN",
Type::Array => "ARRAY",
Type::Object => "OBJECT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"STRING" => Some(Self::String),
"NUMBER" => Some(Self::Number),
"INTEGER" => Some(Self::Integer),
"BOOLEAN" => Some(Self::Boolean),
"ARRAY" => Some(Self::Array),
"OBJECT" => Some(Self::Object),
_ => None,
}
}
}
/// Tool details that the model may use to generate response.
///
/// A `Tool` is a piece of code that enables the system to interact with
/// external systems to perform an action, or set of actions, outside of
/// knowledge and scope of the model. A Tool object should contain exactly
/// one type of Tool (e.g FunctionDeclaration, Retrieval or
/// GoogleSearchRetrieval).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Tool {
/// Optional. Function tool type.
/// One or more function declarations to be passed to the model along with the
/// current user query. Model may decide to call a subset of these functions
/// by populating [FunctionCall][content.part.function_call] in the response.
/// User should provide a [FunctionResponse][content.part.function_response]
/// for each function call in the next turn. Based on the function responses,
/// Model will generate the final response back to the user.
/// Maximum 64 function declarations can be provided.
#[prost(message, repeated, tag = "1")]
pub function_declarations: ::prost::alloc::vec::Vec<FunctionDeclaration>,
/// Optional. Retrieval tool type.
/// System will always execute the provided retrieval tool(s) to get external
/// knowledge to answer the prompt. Retrieval results are presented to the
/// model for generation.
#[prost(message, optional, tag = "2")]
pub retrieval: ::core::option::Option<Retrieval>,
/// Optional. GoogleSearchRetrieval tool type.
/// Specialized retrieval tool that is powered by Google search.
#[prost(message, optional, tag = "3")]
pub google_search_retrieval: ::core::option::Option<GoogleSearchRetrieval>,
}
/// Structured representation of a function declaration as defined by the
/// [OpenAPI 3.0 specification](<https://spec.openapis.org/oas/v3.0.3>). Included
/// in this declaration are the function name and parameters. This
/// FunctionDeclaration is a representation of a block of code that can be used
/// as a `Tool` by the model and executed by the client.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunctionDeclaration {
/// Required. The name of the function to call.
/// Must start with a letter or an underscore.
/// Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a
/// maximum length of 64.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. Description and purpose of the function.
/// Model uses it to decide how and whether to call the function.
#[prost(string, tag = "2")]
pub description: ::prost::alloc::string::String,
/// Optional. Describes the parameters to this function in JSON Schema Object
/// format. Reflects the Open API 3.03 Parameter Object. string Key: the name
/// of the parameter. Parameter names are case sensitive. Schema Value: the
/// Schema defining the type used for the parameter. For function with no
/// parameters, this can be left unset. Parameter names must start with a
/// letter or an underscore and must only contain chars a-z, A-Z, 0-9, or
/// underscores with a maximum length of 64. Example with 1 required and 1
/// optional parameter: type: OBJECT properties:
/// param1:
/// type: STRING
/// param2:
/// type: INTEGER
/// required:
/// - param1
#[prost(message, optional, tag = "3")]
pub parameters: ::core::option::Option<Schema>,
}
/// A predicted \[FunctionCall\] returned from the model that contains a string
/// representing the \[FunctionDeclaration.name\] and a structured JSON object
/// containing the parameters and their values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunctionCall {
/// Required. The name of the function to call.
/// Matches \[FunctionDeclaration.name\].
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. Required. The function parameters and values in JSON object
/// format. See \[FunctionDeclaration.parameters\] for parameter details.
#[prost(message, optional, tag = "2")]
pub args: ::core::option::Option<::prost_types::Struct>,
}
/// The result output from a \[FunctionCall\] that contains a string representing
/// the \[FunctionDeclaration.name\] and a structured JSON object containing any
/// output from the function is used as context to the model. This should contain
/// the result of a \[FunctionCall\] made based on model prediction.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunctionResponse {
/// Required. The name of the function to call.
/// Matches \[FunctionDeclaration.name\] and \[FunctionCall.name\].
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The function response in JSON object format.
#[prost(message, optional, tag = "2")]
pub response: ::core::option::Option<::prost_types::Struct>,
}
/// Defines a retrieval tool that model can call to access external knowledge.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Retrieval {
/// Optional. Deprecated. This option is no longer supported.
#[deprecated]
#[prost(bool, tag = "3")]
pub disable_attribution: bool,
/// The source of the retrieval.
#[prost(oneof = "retrieval::Source", tags = "2")]
pub source: ::core::option::Option<retrieval::Source>,
}
/// Nested message and enum types in `Retrieval`.
pub mod retrieval {
/// The source of the retrieval.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// Set to use data source powered by Vertex AI Search.
#[prost(message, tag = "2")]
VertexAiSearch(super::VertexAiSearch),
}
}
/// Retrieve from Vertex AI Search datastore for grounding.
/// See <https://cloud.google.com/vertex-ai-search-and-conversation>
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VertexAiSearch {
/// Required. Fully-qualified Vertex AI Search's datastore resource ID.
/// Format:
/// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
#[prost(string, tag = "1")]
pub datastore: ::prost::alloc::string::String,
}
/// Tool to retrieve public web data for grounding, powered by Google.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct GoogleSearchRetrieval {}
/// Tool config. This config is shared for all tools provided in the request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolConfig {
/// Optional. Function calling config.
#[prost(message, optional, tag = "1")]
pub function_calling_config: ::core::option::Option<FunctionCallingConfig>,
}
/// Function calling config.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FunctionCallingConfig {
/// Optional. Function calling mode.
#[prost(enumeration = "function_calling_config::Mode", tag = "1")]
pub mode: i32,
/// Optional. Function names to call. Only set when the Mode is ANY. Function
/// names should match \[FunctionDeclaration.name\]. With mode set to ANY, model
/// will predict a function call from the set of function names provided.
#[prost(string, repeated, tag = "2")]
pub allowed_function_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Nested message and enum types in `FunctionCallingConfig`.
pub mod function_calling_config {
/// Function calling mode.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Mode {
/// Unspecified function calling mode. This value should not be used.
Unspecified = 0,
/// Default model behavior, model decides to predict either a function call
/// or a natural language response.
Auto = 1,
/// Model is constrained to always predicting a function call only.
/// If "allowed_function_names" are set, the predicted function call will be
/// limited to any one of "allowed_function_names", else the predicted
/// function call will be any one of the provided "function_declarations".
Any = 2,
/// Model will not predict any function call. Model behavior is same as when
/// not passing any function declarations.
None = 3,
}
impl Mode {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Mode::Unspecified => "MODE_UNSPECIFIED",
Mode::Auto => "AUTO",
Mode::Any => "ANY",
Mode::None => "NONE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MODE_UNSPECIFIED" => Some(Self::Unspecified),
"AUTO" => Some(Self::Auto),
"ANY" => Some(Self::Any),
"NONE" => Some(Self::None),
_ => None,
}
}
}
}
/// The base structured datatype containing multi-part content of a message.
///
/// A `Content` includes a `role` field designating the producer of the `Content`
/// and a `parts` field containing multi-part data that contains the content of
/// the message turn.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Content {
/// Optional. The producer of the content. Must be either 'user' or 'model'.
///
/// Useful to set for multi-turn conversations, otherwise can be left blank
/// or unset.
#[prost(string, tag = "1")]
pub role: ::prost::alloc::string::String,
/// Required. Ordered `Parts` that constitute a single message. Parts may have
/// different IANA MIME types.
#[prost(message, repeated, tag = "2")]
pub parts: ::prost::alloc::vec::Vec<Part>,
}
/// A datatype containing media that is part of a multi-part `Content` message.
///
/// A `Part` consists of data which has an associated datatype. A `Part` can only
/// contain one of the accepted types in `Part.data`.
///
/// A `Part` must have a fixed IANA MIME type identifying the type and subtype
/// of the media if `inline_data` or `file_data` field is filled with raw bytes.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Part {
#[prost(oneof = "part::Data", tags = "1, 2, 3, 5, 6")]
pub data: ::core::option::Option<part::Data>,
#[prost(oneof = "part::Metadata", tags = "4")]
pub metadata: ::core::option::Option<part::Metadata>,
}
/// Nested message and enum types in `Part`.
pub mod part {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Data {
/// Optional. Text part (can be code).
#[prost(string, tag = "1")]
Text(::prost::alloc::string::String),
/// Optional. Inlined bytes data.
#[prost(message, tag = "2")]
InlineData(super::Blob),
/// Optional. URI based data.
#[prost(message, tag = "3")]
FileData(super::FileData),
/// Optional. A predicted \[FunctionCall\] returned from the model that
/// contains a string representing the \[FunctionDeclaration.name\] with the
/// parameters and their values.
#[prost(message, tag = "5")]
FunctionCall(super::FunctionCall),
/// Optional. The result output of a \[FunctionCall\] that contains a string
/// representing the \[FunctionDeclaration.name\] and a structured JSON object
/// containing any output from the function call. It is used as context to
/// the model.
#[prost(message, tag = "6")]
FunctionResponse(super::FunctionResponse),
}
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Metadata {
/// Optional. Video metadata. The metadata should only be specified while the
/// video data is presented in inline_data or file_data.
#[prost(message, tag = "4")]
VideoMetadata(super::VideoMetadata),
}
}
/// Content blob.
///
/// It's preferred to send as [text][google.cloud.aiplatform.v1.Part.text]
/// directly rather than raw bytes.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Blob {
/// Required. The IANA standard MIME type of the source data.
#[prost(string, tag = "1")]
pub mime_type: ::prost::alloc::string::String,
/// Required. Raw bytes.
#[prost(bytes = "bytes", tag = "2")]
pub data: ::prost::bytes::Bytes,
}
/// URI based data.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FileData {
/// Required. The IANA standard MIME type of the source data.
#[prost(string, tag = "1")]
pub mime_type: ::prost::alloc::string::String,
/// Required. URI.
#[prost(string, tag = "2")]
pub file_uri: ::prost::alloc::string::String,
}
/// Metadata describes the input video content.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct VideoMetadata {
/// Optional. The start offset of the video.
#[prost(message, optional, tag = "1")]
pub start_offset: ::core::option::Option<::prost_types::Duration>,
/// Optional. The end offset of the video.
#[prost(message, optional, tag = "2")]
pub end_offset: ::core::option::Option<::prost_types::Duration>,
}
/// Generation config.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GenerationConfig {
/// Optional. Controls the randomness of predictions.
#[prost(float, optional, tag = "1")]
pub temperature: ::core::option::Option<f32>,
/// Optional. If specified, nucleus sampling will be used.
#[prost(float, optional, tag = "2")]
pub top_p: ::core::option::Option<f32>,
/// Optional. If specified, top-k sampling will be used.
#[prost(float, optional, tag = "3")]
pub top_k: ::core::option::Option<f32>,
/// Optional. Number of candidates to generate.
#[prost(int32, optional, tag = "4")]
pub candidate_count: ::core::option::Option<i32>,
/// Optional. The maximum number of output tokens to generate per message.
#[prost(int32, optional, tag = "5")]
pub max_output_tokens: ::core::option::Option<i32>,
/// Optional. Stop sequences.
#[prost(string, repeated, tag = "6")]
pub stop_sequences: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. Positive penalties.
#[prost(float, optional, tag = "8")]
pub presence_penalty: ::core::option::Option<f32>,
/// Optional. Frequency penalties.
#[prost(float, optional, tag = "9")]
pub frequency_penalty: ::core::option::Option<f32>,
/// Optional. Seed.
#[prost(int32, optional, tag = "12")]
pub seed: ::core::option::Option<i32>,
/// Optional. Output response mimetype of the generated candidate text.
/// Supported mimetype:
/// - `text/plain`: (default) Text output.
/// - `application/json`: JSON response in the candidates.
/// The model needs to be prompted to output the appropriate response type,
/// otherwise the behavior is undefined.
/// This is a preview feature.
#[prost(string, tag = "13")]
pub response_mime_type: ::prost::alloc::string::String,
/// Optional. The `Schema` object allows the definition of input and output
/// data types. These types can be objects, but also primitives and arrays.
/// Represents a select subset of an [OpenAPI 3.0 schema
/// object](<https://spec.openapis.org/oas/v3.0.3#schema>).
/// If set, a compatible response_mime_type must also be set.
/// Compatible mimetypes:
/// `application/json`: Schema for JSON response.
#[prost(message, optional, tag = "16")]
pub response_schema: ::core::option::Option<Schema>,
/// Optional. Routing configuration.
#[prost(message, optional, tag = "17")]
pub routing_config: ::core::option::Option<generation_config::RoutingConfig>,
}
/// Nested message and enum types in `GenerationConfig`.
pub mod generation_config {
/// The configuration for routing the request to a specific model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RoutingConfig {
/// Routing mode.
#[prost(oneof = "routing_config::RoutingConfig", tags = "1, 2")]
pub routing_config: ::core::option::Option<routing_config::RoutingConfig>,
}
/// Nested message and enum types in `RoutingConfig`.
pub mod routing_config {
/// When automated routing is specified, the routing will be determined by
/// the pretrained routing model and customer provided model routing
/// preference.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AutoRoutingMode {
/// The model routing preference.
#[prost(
enumeration = "auto_routing_mode::ModelRoutingPreference",
optional,
tag = "1"
)]
pub model_routing_preference: ::core::option::Option<i32>,
}
/// Nested message and enum types in `AutoRoutingMode`.
pub mod auto_routing_mode {
/// The model routing preference.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ModelRoutingPreference {
/// Unspecified model routing preference.
Unknown = 0,
/// Prefer higher quality over low cost.
PrioritizeQuality = 1,
/// Balanced model routing preference.
Balanced = 2,
/// Prefer lower cost over higher quality.
PrioritizeCost = 3,
}
impl ModelRoutingPreference {
/// 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 {
ModelRoutingPreference::Unknown => "UNKNOWN",
ModelRoutingPreference::PrioritizeQuality => "PRIORITIZE_QUALITY",
ModelRoutingPreference::Balanced => "BALANCED",
ModelRoutingPreference::PrioritizeCost => "PRIORITIZE_COST",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNKNOWN" => Some(Self::Unknown),
"PRIORITIZE_QUALITY" => Some(Self::PrioritizeQuality),
"BALANCED" => Some(Self::Balanced),
"PRIORITIZE_COST" => Some(Self::PrioritizeCost),
_ => None,
}
}
}
}
/// When manual routing is set, the specified model will be used directly.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ManualRoutingMode {
/// The model name to use. Only the public LLM models are accepted. e.g.
/// 'gemini-1.5-pro-001'.
#[prost(string, optional, tag = "1")]
pub model_name: ::core::option::Option<::prost::alloc::string::String>,
}
/// Routing mode.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum RoutingConfig {
/// Automated routing.
#[prost(message, tag = "1")]
AutoMode(AutoRoutingMode),
/// Manual routing.
#[prost(message, tag = "2")]
ManualMode(ManualRoutingMode),
}
}
}
/// Safety settings.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SafetySetting {
/// Required. Harm category.
#[prost(enumeration = "HarmCategory", tag = "1")]
pub category: i32,
/// Required. The harm block threshold.
#[prost(enumeration = "safety_setting::HarmBlockThreshold", tag = "2")]
pub threshold: i32,
/// Optional. Specify if the threshold is used for probability or severity
/// score. If not specified, the threshold is used for probability score.
#[prost(enumeration = "safety_setting::HarmBlockMethod", tag = "4")]
pub method: i32,
}
/// Nested message and enum types in `SafetySetting`.
pub mod safety_setting {
/// Probability based thresholds levels for blocking.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum HarmBlockThreshold {
/// Unspecified harm block threshold.
Unspecified = 0,
/// Block low threshold and above (i.e. block more).
BlockLowAndAbove = 1,
/// Block medium threshold and above.
BlockMediumAndAbove = 2,
/// Block only high threshold (i.e. block less).
BlockOnlyHigh = 3,
/// Block none.
BlockNone = 4,
}
impl HarmBlockThreshold {
/// 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 {
HarmBlockThreshold::Unspecified => "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
HarmBlockThreshold::BlockLowAndAbove => "BLOCK_LOW_AND_ABOVE",
HarmBlockThreshold::BlockMediumAndAbove => "BLOCK_MEDIUM_AND_ABOVE",
HarmBlockThreshold::BlockOnlyHigh => "BLOCK_ONLY_HIGH",
HarmBlockThreshold::BlockNone => "BLOCK_NONE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"HARM_BLOCK_THRESHOLD_UNSPECIFIED" => Some(Self::Unspecified),
"BLOCK_LOW_AND_ABOVE" => Some(Self::BlockLowAndAbove),
"BLOCK_MEDIUM_AND_ABOVE" => Some(Self::BlockMediumAndAbove),
"BLOCK_ONLY_HIGH" => Some(Self::BlockOnlyHigh),
"BLOCK_NONE" => Some(Self::BlockNone),
_ => None,
}
}
}
/// Probability vs severity.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum HarmBlockMethod {
/// The harm block method is unspecified.
Unspecified = 0,
/// The harm block method uses both probability and severity scores.
Severity = 1,
/// The harm block method uses the probability score.
Probability = 2,
}
impl HarmBlockMethod {
/// 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 {
HarmBlockMethod::Unspecified => "HARM_BLOCK_METHOD_UNSPECIFIED",
HarmBlockMethod::Severity => "SEVERITY",
HarmBlockMethod::Probability => "PROBABILITY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"HARM_BLOCK_METHOD_UNSPECIFIED" => Some(Self::Unspecified),
"SEVERITY" => Some(Self::Severity),
"PROBABILITY" => Some(Self::Probability),
_ => None,
}
}
}
}
/// Safety rating corresponding to the generated content.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SafetyRating {
/// Output only. Harm category.
#[prost(enumeration = "HarmCategory", tag = "1")]
pub category: i32,
/// Output only. Harm probability levels in the content.
#[prost(enumeration = "safety_rating::HarmProbability", tag = "2")]
pub probability: i32,
/// Output only. Harm probability score.
#[prost(float, tag = "5")]
pub probability_score: f32,
/// Output only. Harm severity levels in the content.
#[prost(enumeration = "safety_rating::HarmSeverity", tag = "6")]
pub severity: i32,
/// Output only. Harm severity score.
#[prost(float, tag = "7")]
pub severity_score: f32,
/// Output only. Indicates whether the content was filtered out because of this
/// rating.
#[prost(bool, tag = "3")]
pub blocked: bool,
}
/// Nested message and enum types in `SafetyRating`.
pub mod safety_rating {
/// Harm probability levels in the content.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum HarmProbability {
/// Harm probability unspecified.
Unspecified = 0,
/// Negligible level of harm.
Negligible = 1,
/// Low level of harm.
Low = 2,
/// Medium level of harm.
Medium = 3,
/// High level of harm.
High = 4,
}
impl HarmProbability {
/// 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 {
HarmProbability::Unspecified => "HARM_PROBABILITY_UNSPECIFIED",
HarmProbability::Negligible => "NEGLIGIBLE",
HarmProbability::Low => "LOW",
HarmProbability::Medium => "MEDIUM",
HarmProbability::High => "HIGH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"HARM_PROBABILITY_UNSPECIFIED" => Some(Self::Unspecified),
"NEGLIGIBLE" => Some(Self::Negligible),
"LOW" => Some(Self::Low),
"MEDIUM" => Some(Self::Medium),
"HIGH" => Some(Self::High),
_ => None,
}
}
}
/// Harm severity levels.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum HarmSeverity {
/// Harm severity unspecified.
Unspecified = 0,
/// Negligible level of harm severity.
Negligible = 1,
/// Low level of harm severity.
Low = 2,
/// Medium level of harm severity.
Medium = 3,
/// High level of harm severity.
High = 4,
}
impl HarmSeverity {
/// 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 {
HarmSeverity::Unspecified => "HARM_SEVERITY_UNSPECIFIED",
HarmSeverity::Negligible => "HARM_SEVERITY_NEGLIGIBLE",
HarmSeverity::Low => "HARM_SEVERITY_LOW",
HarmSeverity::Medium => "HARM_SEVERITY_MEDIUM",
HarmSeverity::High => "HARM_SEVERITY_HIGH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"HARM_SEVERITY_UNSPECIFIED" => Some(Self::Unspecified),
"HARM_SEVERITY_NEGLIGIBLE" => Some(Self::Negligible),
"HARM_SEVERITY_LOW" => Some(Self::Low),
"HARM_SEVERITY_MEDIUM" => Some(Self::Medium),
"HARM_SEVERITY_HIGH" => Some(Self::High),
_ => None,
}
}
}
}
/// A collection of source attributions for a piece of content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CitationMetadata {
/// Output only. List of citations.
#[prost(message, repeated, tag = "1")]
pub citations: ::prost::alloc::vec::Vec<Citation>,
}
/// Source attributions for content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Citation {
/// Output only. Start index into the content.
#[prost(int32, tag = "1")]
pub start_index: i32,
/// Output only. End index into the content.
#[prost(int32, tag = "2")]
pub end_index: i32,
/// Output only. Url reference of the attribution.
#[prost(string, tag = "3")]
pub uri: ::prost::alloc::string::String,
/// Output only. Title of the attribution.
#[prost(string, tag = "4")]
pub title: ::prost::alloc::string::String,
/// Output only. License of the attribution.
#[prost(string, tag = "5")]
pub license: ::prost::alloc::string::String,
/// Output only. Publication date of the attribution.
#[prost(message, optional, tag = "6")]
pub publication_date: ::core::option::Option<super::super::super::r#type::Date>,
}
/// A response candidate generated from the model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Candidate {
/// Output only. Index of the candidate.
#[prost(int32, tag = "1")]
pub index: i32,
/// Output only. Content parts of the candidate.
#[prost(message, optional, tag = "2")]
pub content: ::core::option::Option<Content>,
/// Output only. Confidence score of the candidate.
#[prost(double, tag = "8")]
pub score: f64,
/// Output only. Average log probability score of the candidate.
#[prost(double, tag = "9")]
pub avg_logprobs: f64,
/// Output only. The reason why the model stopped generating tokens.
/// If empty, the model has not stopped generating the tokens.
#[prost(enumeration = "candidate::FinishReason", tag = "3")]
pub finish_reason: i32,
/// Output only. List of ratings for the safety of a response candidate.
///
/// There is at most one rating per category.
#[prost(message, repeated, tag = "4")]
pub safety_ratings: ::prost::alloc::vec::Vec<SafetyRating>,
/// Output only. Describes the reason the mode stopped generating tokens in
/// more detail. This is only filled when `finish_reason` is set.
#[prost(string, optional, tag = "5")]
pub finish_message: ::core::option::Option<::prost::alloc::string::String>,
/// Output only. Source attribution of the generated content.
#[prost(message, optional, tag = "6")]
pub citation_metadata: ::core::option::Option<CitationMetadata>,
/// Output only. Metadata specifies sources used to ground generated content.
#[prost(message, optional, tag = "7")]
pub grounding_metadata: ::core::option::Option<GroundingMetadata>,
}
/// Nested message and enum types in `Candidate`.
pub mod candidate {
/// The reason why the model stopped generating tokens.
/// If empty, the model has not stopped generating the tokens.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum FinishReason {
/// The finish reason is unspecified.
Unspecified = 0,
/// Token generation reached a natural stopping point or a configured stop
/// sequence.
Stop = 1,
/// Token generation reached the configured maximum output tokens.
MaxTokens = 2,
/// Token generation stopped because the content potentially contains safety
/// violations. NOTE: When streaming,
/// [content][google.cloud.aiplatform.v1.Candidate.content] is empty if
/// content filters blocks the output.
Safety = 3,
/// Token generation stopped because the content potentially contains
/// copyright violations.
Recitation = 4,
/// All other reasons that stopped the token generation.
Other = 5,
/// Token generation stopped because the content contains forbidden terms.
Blocklist = 6,
/// Token generation stopped for potentially containing prohibited content.
ProhibitedContent = 7,
/// Token generation stopped because the content potentially contains
/// Sensitive Personally Identifiable Information (SPII).
Spii = 8,
/// The function call generated by the model is invalid.
MalformedFunctionCall = 9,
}
impl FinishReason {
/// 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 {
FinishReason::Unspecified => "FINISH_REASON_UNSPECIFIED",
FinishReason::Stop => "STOP",
FinishReason::MaxTokens => "MAX_TOKENS",
FinishReason::Safety => "SAFETY",
FinishReason::Recitation => "RECITATION",
FinishReason::Other => "OTHER",
FinishReason::Blocklist => "BLOCKLIST",
FinishReason::ProhibitedContent => "PROHIBITED_CONTENT",
FinishReason::Spii => "SPII",
FinishReason::MalformedFunctionCall => "MALFORMED_FUNCTION_CALL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"FINISH_REASON_UNSPECIFIED" => Some(Self::Unspecified),
"STOP" => Some(Self::Stop),
"MAX_TOKENS" => Some(Self::MaxTokens),
"SAFETY" => Some(Self::Safety),
"RECITATION" => Some(Self::Recitation),
"OTHER" => Some(Self::Other),
"BLOCKLIST" => Some(Self::Blocklist),
"PROHIBITED_CONTENT" => Some(Self::ProhibitedContent),
"SPII" => Some(Self::Spii),
"MALFORMED_FUNCTION_CALL" => Some(Self::MalformedFunctionCall),
_ => None,
}
}
}
}
/// Segment of the content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Segment {
/// Output only. The index of a Part object within its parent Content object.
#[prost(int32, tag = "1")]
pub part_index: i32,
/// Output only. Start index in the given Part, measured in bytes. Offset from
/// the start of the Part, inclusive, starting at zero.
#[prost(int32, tag = "2")]
pub start_index: i32,
/// Output only. End index in the given Part, measured in bytes. Offset from
/// the start of the Part, exclusive, starting at zero.
#[prost(int32, tag = "3")]
pub end_index: i32,
/// Output only. The text corresponding to the segment from the response.
#[prost(string, tag = "4")]
pub text: ::prost::alloc::string::String,
}
/// Grounding chunk.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GroundingChunk {
/// Chunk type.
#[prost(oneof = "grounding_chunk::ChunkType", tags = "1, 2")]
pub chunk_type: ::core::option::Option<grounding_chunk::ChunkType>,
}
/// Nested message and enum types in `GroundingChunk`.
pub mod grounding_chunk {
/// Chunk from the web.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Web {
/// URI reference of the chunk.
#[prost(string, optional, tag = "1")]
pub uri: ::core::option::Option<::prost::alloc::string::String>,
/// Title of the chunk.
#[prost(string, optional, tag = "2")]
pub title: ::core::option::Option<::prost::alloc::string::String>,
}
/// Chunk from context retrieved by the retrieval tools.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RetrievedContext {
/// URI reference of the attribution.
#[prost(string, optional, tag = "1")]
pub uri: ::core::option::Option<::prost::alloc::string::String>,
/// Title of the attribution.
#[prost(string, optional, tag = "2")]
pub title: ::core::option::Option<::prost::alloc::string::String>,
}
/// Chunk type.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ChunkType {
/// Grounding chunk from the web.
#[prost(message, tag = "1")]
Web(Web),
/// Grounding chunk from context retrieved by the retrieval tools.
#[prost(message, tag = "2")]
RetrievedContext(RetrievedContext),
}
}
/// Grounding support.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GroundingSupport {
/// Segment of the content this support belongs to.
#[prost(message, optional, tag = "1")]
pub segment: ::core::option::Option<Segment>,
/// A list of indices (into 'grounding_chunk') specifying the
/// citations associated with the claim. For instance \[1,3,4\] means
/// that grounding_chunk\[1\], grounding_chunk\[3\],
/// grounding_chunk\[4\] are the retrieved content attributed to the claim.
#[prost(int32, repeated, tag = "2")]
pub grounding_chunk_indices: ::prost::alloc::vec::Vec<i32>,
/// Confidence score of the support references. Ranges from 0 to 1. 1 is the
/// most confident. This list must have the same size as the
/// grounding_chunk_indices.
#[prost(float, repeated, tag = "3")]
pub confidence_scores: ::prost::alloc::vec::Vec<f32>,
}
/// Metadata returned to client when grounding is enabled.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GroundingMetadata {
/// Optional. Web search queries for the following-up web search.
#[prost(string, repeated, tag = "1")]
pub web_search_queries: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. Google search entry for the following-up web searches.
#[prost(message, optional, tag = "4")]
pub search_entry_point: ::core::option::Option<SearchEntryPoint>,
/// List of supporting references retrieved from specified grounding source.
#[prost(message, repeated, tag = "5")]
pub grounding_chunks: ::prost::alloc::vec::Vec<GroundingChunk>,
/// Optional. List of grounding support.
#[prost(message, repeated, tag = "6")]
pub grounding_supports: ::prost::alloc::vec::Vec<GroundingSupport>,
}
/// Google search entry point.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchEntryPoint {
/// Optional. Web content snippet that can be embedded in a web page or an app
/// webview.
#[prost(string, tag = "1")]
pub rendered_content: ::prost::alloc::string::String,
/// Optional. Base64 encoded JSON representing array of <search term, search
/// url> tuple.
#[prost(bytes = "bytes", tag = "2")]
pub sdk_blob: ::prost::bytes::Bytes,
}
/// Harm categories that will block the content.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum HarmCategory {
/// The harm category is unspecified.
Unspecified = 0,
/// The harm category is hate speech.
HateSpeech = 1,
/// The harm category is dangerous content.
DangerousContent = 2,
/// The harm category is harassment.
Harassment = 3,
/// The harm category is sexually explicit content.
SexuallyExplicit = 4,
}
impl HarmCategory {
/// 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 {
HarmCategory::Unspecified => "HARM_CATEGORY_UNSPECIFIED",
HarmCategory::HateSpeech => "HARM_CATEGORY_HATE_SPEECH",
HarmCategory::DangerousContent => "HARM_CATEGORY_DANGEROUS_CONTENT",
HarmCategory::Harassment => "HARM_CATEGORY_HARASSMENT",
HarmCategory::SexuallyExplicit => "HARM_CATEGORY_SEXUALLY_EXPLICIT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"HARM_CATEGORY_UNSPECIFIED" => Some(Self::Unspecified),
"HARM_CATEGORY_HATE_SPEECH" => Some(Self::HateSpeech),
"HARM_CATEGORY_DANGEROUS_CONTENT" => Some(Self::DangerousContent),
"HARM_CATEGORY_HARASSMENT" => Some(Self::Harassment),
"HARM_CATEGORY_SEXUALLY_EXPLICIT" => Some(Self::SexuallyExplicit),
_ => None,
}
}
}
/// Represents a customer-managed encryption key spec that can be applied to
/// a top-level resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EncryptionSpec {
/// Required. The Cloud KMS resource identifier of the customer managed
/// encryption key used to protect a resource. Has the form:
/// `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`.
/// The key needs to be in the same region as where the compute resource is
/// created.
#[prost(string, tag = "1")]
pub kms_key_name: ::prost::alloc::string::String,
}
/// Describes the state of a job.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum JobState {
/// The job state is unspecified.
Unspecified = 0,
/// The job has been just created or resumed and processing has not yet begun.
Queued = 1,
/// The service is preparing to run the job.
Pending = 2,
/// The job is in progress.
Running = 3,
/// The job completed successfully.
Succeeded = 4,
/// The job failed.
Failed = 5,
/// The job is being cancelled. From this state the job may only go to
/// either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
Cancelling = 6,
/// The job has been cancelled.
Cancelled = 7,
/// The job has been stopped, and can be resumed.
Paused = 8,
/// The job has expired.
Expired = 9,
/// The job is being updated. Only jobs in the `RUNNING` state can be updated.
/// After updating, the job goes back to the `RUNNING` state.
Updating = 10,
/// The job is partially succeeded, some results may be missing due to errors.
PartiallySucceeded = 11,
}
impl JobState {
/// 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 {
JobState::Unspecified => "JOB_STATE_UNSPECIFIED",
JobState::Queued => "JOB_STATE_QUEUED",
JobState::Pending => "JOB_STATE_PENDING",
JobState::Running => "JOB_STATE_RUNNING",
JobState::Succeeded => "JOB_STATE_SUCCEEDED",
JobState::Failed => "JOB_STATE_FAILED",
JobState::Cancelling => "JOB_STATE_CANCELLING",
JobState::Cancelled => "JOB_STATE_CANCELLED",
JobState::Paused => "JOB_STATE_PAUSED",
JobState::Expired => "JOB_STATE_EXPIRED",
JobState::Updating => "JOB_STATE_UPDATING",
JobState::PartiallySucceeded => "JOB_STATE_PARTIALLY_SUCCEEDED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"JOB_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"JOB_STATE_QUEUED" => Some(Self::Queued),
"JOB_STATE_PENDING" => Some(Self::Pending),
"JOB_STATE_RUNNING" => Some(Self::Running),
"JOB_STATE_SUCCEEDED" => Some(Self::Succeeded),
"JOB_STATE_FAILED" => Some(Self::Failed),
"JOB_STATE_CANCELLING" => Some(Self::Cancelling),
"JOB_STATE_CANCELLED" => Some(Self::Cancelled),
"JOB_STATE_PAUSED" => Some(Self::Paused),
"JOB_STATE_EXPIRED" => Some(Self::Expired),
"JOB_STATE_UPDATING" => Some(Self::Updating),
"JOB_STATE_PARTIALLY_SUCCEEDED" => Some(Self::PartiallySucceeded),
_ => None,
}
}
}
/// Represents a TuningJob that runs with Google owned models.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TuningJob {
/// Output only. Identifier. Resource name of a TuningJob. Format:
/// `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The display name of the
/// [TunedModel][google.cloud.aiplatform.v1.Model]. The name can be up to 128
/// characters long and can consist of any UTF-8 characters.
#[prost(string, tag = "2")]
pub tuned_model_display_name: ::prost::alloc::string::String,
/// Optional. The description of the
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. The detailed state of the job.
#[prost(enumeration = "JobState", tag = "6")]
pub state: i32,
/// Output only. Time when the
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob] was created.
#[prost(message, optional, tag = "7")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob] for the first time
/// entered the `JOB_STATE_RUNNING` state.
#[prost(message, optional, tag = "8")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the TuningJob entered any of the following
/// [JobStates][google.cloud.aiplatform.v1.JobState]: `JOB_STATE_SUCCEEDED`,
/// `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
#[prost(message, optional, tag = "9")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob] was most recently
/// updated.
#[prost(message, optional, tag = "10")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Only populated when job's state is `JOB_STATE_FAILED` or
/// `JOB_STATE_CANCELLED`.
#[prost(message, optional, tag = "11")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// Optional. The labels with user-defined metadata to organize
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob] and generated resources
/// such as [Model][google.cloud.aiplatform.v1.Model] and
/// [Endpoint][google.cloud.aiplatform.v1.Endpoint].
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "12")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. The Experiment associated with this
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
#[prost(string, tag = "13")]
pub experiment: ::prost::alloc::string::String,
/// Output only. The tuned model resources assiociated with this
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
#[prost(message, optional, tag = "14")]
pub tuned_model: ::core::option::Option<TunedModel>,
/// Output only. The tuning data statistics associated with this
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
#[prost(message, optional, tag = "15")]
pub tuning_data_stats: ::core::option::Option<TuningDataStats>,
/// Customer-managed encryption key options for a TuningJob. If this is set,
/// then all resources created by the TuningJob will be encrypted with the
/// provided encryption key.
#[prost(message, optional, tag = "16")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
#[prost(oneof = "tuning_job::SourceModel", tags = "4")]
pub source_model: ::core::option::Option<tuning_job::SourceModel>,
#[prost(oneof = "tuning_job::TuningSpec", tags = "5")]
pub tuning_spec: ::core::option::Option<tuning_job::TuningSpec>,
}
/// Nested message and enum types in `TuningJob`.
pub mod tuning_job {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SourceModel {
/// The base model that is being tuned, e.g., "gemini-1.0-pro-002".
#[prost(string, tag = "4")]
BaseModel(::prost::alloc::string::String),
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TuningSpec {
/// Tuning Spec for Supervised Fine Tuning.
#[prost(message, tag = "5")]
SupervisedTuningSpec(super::SupervisedTuningSpec),
}
}
/// The Model Registry Model and Online Prediction Endpoint assiociated with
/// this [TuningJob][google.cloud.aiplatform.v1.TuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TunedModel {
/// Output only. The resource name of the TunedModel. Format:
/// `projects/{project}/locations/{location}/models/{model}`.
#[prost(string, tag = "1")]
pub model: ::prost::alloc::string::String,
/// Output only. A resource name of an Endpoint. Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`.
#[prost(string, tag = "2")]
pub endpoint: ::prost::alloc::string::String,
}
/// Dataset distribution for Supervised Tuning.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SupervisedTuningDatasetDistribution {
/// Output only. Sum of a given population of values.
#[prost(int64, tag = "1")]
pub sum: i64,
/// Output only. Sum of a given population of values that are billable.
#[prost(int64, tag = "9")]
pub billable_sum: i64,
/// Output only. The minimum of the population values.
#[prost(double, tag = "2")]
pub min: f64,
/// Output only. The maximum of the population values.
#[prost(double, tag = "3")]
pub max: f64,
/// Output only. The arithmetic mean of the values in the population.
#[prost(double, tag = "4")]
pub mean: f64,
/// Output only. The median of the values in the population.
#[prost(double, tag = "5")]
pub median: f64,
/// Output only. The 5th percentile of the values in the population.
#[prost(double, tag = "6")]
pub p5: f64,
/// Output only. The 95th percentile of the values in the population.
#[prost(double, tag = "7")]
pub p95: f64,
/// Output only. Defines the histogram bucket.
#[prost(message, repeated, tag = "8")]
pub buckets: ::prost::alloc::vec::Vec<
supervised_tuning_dataset_distribution::DatasetBucket,
>,
}
/// Nested message and enum types in `SupervisedTuningDatasetDistribution`.
pub mod supervised_tuning_dataset_distribution {
/// Dataset bucket used to create a histogram for the distribution given a
/// population of values.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DatasetBucket {
/// Output only. Number of values in the bucket.
#[prost(double, tag = "1")]
pub count: f64,
/// Output only. Left bound of the bucket.
#[prost(double, tag = "2")]
pub left: f64,
/// Output only. Right bound of the bucket.
#[prost(double, tag = "3")]
pub right: f64,
}
}
/// Tuning data statistics for Supervised Tuning.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SupervisedTuningDataStats {
/// Output only. Number of examples in the tuning dataset.
#[prost(int64, tag = "1")]
pub tuning_dataset_example_count: i64,
/// Output only. Number of tuning characters in the tuning dataset.
#[prost(int64, tag = "2")]
pub total_tuning_character_count: i64,
/// Output only. Number of billable characters in the tuning dataset.
#[deprecated]
#[prost(int64, tag = "3")]
pub total_billable_character_count: i64,
/// Output only. Number of billable tokens in the tuning dataset.
#[prost(int64, tag = "9")]
pub total_billable_token_count: i64,
/// Output only. Number of tuning steps for this Tuning Job.
#[prost(int64, tag = "4")]
pub tuning_step_count: i64,
/// Output only. Dataset distributions for the user input tokens.
#[prost(message, optional, tag = "5")]
pub user_input_token_distribution: ::core::option::Option<
SupervisedTuningDatasetDistribution,
>,
/// Output only. Dataset distributions for the user output tokens.
#[prost(message, optional, tag = "6")]
pub user_output_token_distribution: ::core::option::Option<
SupervisedTuningDatasetDistribution,
>,
/// Output only. Dataset distributions for the messages per example.
#[prost(message, optional, tag = "7")]
pub user_message_per_example_distribution: ::core::option::Option<
SupervisedTuningDatasetDistribution,
>,
/// Output only. Sample user messages in the training dataset uri.
#[prost(message, repeated, tag = "8")]
pub user_dataset_examples: ::prost::alloc::vec::Vec<Content>,
/// The number of examples in the dataset that have been truncated by any
/// amount.
#[prost(int64, tag = "10")]
pub total_truncated_example_count: i64,
/// A partial sample of the indices (starting from 1) of the truncated
/// examples.
#[prost(int64, repeated, tag = "11")]
pub truncated_example_indices: ::prost::alloc::vec::Vec<i64>,
}
/// The tuning data statistic values for
/// [TuningJob][google.cloud.aiplatform.v1.TuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TuningDataStats {
#[prost(oneof = "tuning_data_stats::TuningDataStats", tags = "1")]
pub tuning_data_stats: ::core::option::Option<tuning_data_stats::TuningDataStats>,
}
/// Nested message and enum types in `TuningDataStats`.
pub mod tuning_data_stats {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TuningDataStats {
/// The SFT Tuning data stats.
#[prost(message, tag = "1")]
SupervisedTuningDataStats(super::SupervisedTuningDataStats),
}
}
/// Hyperparameters for SFT.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SupervisedHyperParameters {
/// Optional. Number of complete passes the model makes over the entire
/// training dataset during training.
#[prost(int64, tag = "1")]
pub epoch_count: i64,
/// Optional. Multiplier for adjusting the default learning rate.
#[prost(double, tag = "2")]
pub learning_rate_multiplier: f64,
/// Optional. Adapter size for tuning.
#[prost(enumeration = "supervised_hyper_parameters::AdapterSize", tag = "3")]
pub adapter_size: i32,
}
/// Nested message and enum types in `SupervisedHyperParameters`.
pub mod supervised_hyper_parameters {
/// Supported adapter sizes for tuning.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum AdapterSize {
/// Adapter size is unspecified.
Unspecified = 0,
/// Adapter size 1.
One = 1,
/// Adapter size 4.
Four = 2,
/// Adapter size 8.
Eight = 3,
/// Adapter size 16.
Sixteen = 4,
}
impl AdapterSize {
/// 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 {
AdapterSize::Unspecified => "ADAPTER_SIZE_UNSPECIFIED",
AdapterSize::One => "ADAPTER_SIZE_ONE",
AdapterSize::Four => "ADAPTER_SIZE_FOUR",
AdapterSize::Eight => "ADAPTER_SIZE_EIGHT",
AdapterSize::Sixteen => "ADAPTER_SIZE_SIXTEEN",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ADAPTER_SIZE_UNSPECIFIED" => Some(Self::Unspecified),
"ADAPTER_SIZE_ONE" => Some(Self::One),
"ADAPTER_SIZE_FOUR" => Some(Self::Four),
"ADAPTER_SIZE_EIGHT" => Some(Self::Eight),
"ADAPTER_SIZE_SIXTEEN" => Some(Self::Sixteen),
_ => None,
}
}
}
}
/// Tuning Spec for Supervised Tuning.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SupervisedTuningSpec {
/// Required. Cloud Storage path to file containing training dataset for
/// tuning. The dataset must be formatted as a JSONL file.
#[prost(string, tag = "1")]
pub training_dataset_uri: ::prost::alloc::string::String,
/// Optional. Cloud Storage path to file containing validation dataset for
/// tuning. The dataset must be formatted as a JSONL file.
#[prost(string, tag = "2")]
pub validation_dataset_uri: ::prost::alloc::string::String,
/// Optional. Hyperparameters for SFT.
#[prost(message, optional, tag = "3")]
pub hyper_parameters: ::core::option::Option<SupervisedHyperParameters>,
}
/// Stats and Anomaly generated at specific timestamp for specific Feature.
/// The start_time and end_time are used to define the time range of the dataset
/// that current stats belongs to, e.g. prediction traffic is bucketed into
/// prediction datasets by time window. If the Dataset is not defined by time
/// window, start_time = end_time. Timestamp of the stats and anomalies always
/// refers to end_time. Raw stats and anomalies are stored in stats_uri or
/// anomaly_uri in the tensorflow defined protos. Field data_stats contains
/// almost identical information with the raw stats in Vertex AI
/// defined proto, for UI to display.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureStatsAnomaly {
/// Feature importance score, only populated when cross-feature monitoring is
/// enabled. For now only used to represent feature attribution score within
/// range \[0, 1\] for
/// [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW]
/// and
/// [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT].
#[prost(double, tag = "1")]
pub score: f64,
/// Path of the stats file for current feature values in Cloud Storage bucket.
/// Format: gs://<bucket_name>/<object_name>/stats.
/// Example: gs://monitoring_bucket/feature_name/stats.
/// Stats are stored as binary format with Protobuf message
/// [tensorflow.metadata.v0.FeatureNameStatistics](<https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto>).
#[prost(string, tag = "3")]
pub stats_uri: ::prost::alloc::string::String,
/// Path of the anomaly file for current feature values in Cloud Storage
/// bucket.
/// Format: gs://<bucket_name>/<object_name>/anomalies.
/// Example: gs://monitoring_bucket/feature_name/anomalies.
/// Stats are stored as binary format with Protobuf message
/// Anoamlies are stored as binary format with Protobuf message
/// \[tensorflow.metadata.v0.AnomalyInfo\]
/// (<https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto>).
#[prost(string, tag = "4")]
pub anomaly_uri: ::prost::alloc::string::String,
/// Deviation from the current stats to baseline stats.
/// 1. For categorical feature, the distribution distance is calculated by
/// L-inifinity norm.
/// 2. For numerical feature, the distribution distance is calculated by
/// Jensen–Shannon divergence.
#[prost(double, tag = "5")]
pub distribution_deviation: f64,
/// This is the threshold used when detecting anomalies.
/// The threshold can be changed by user, so this one might be different from
/// [ThresholdConfig.value][google.cloud.aiplatform.v1.ThresholdConfig.value].
#[prost(double, tag = "9")]
pub anomaly_detection_threshold: f64,
/// The start timestamp of window where stats were generated.
/// For objectives where time window doesn't make sense (e.g. Featurestore
/// Snapshot Monitoring), start_time is only used to indicate the monitoring
/// intervals, so it always equals to (end_time - monitoring_interval).
#[prost(message, optional, tag = "7")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The end timestamp of window where stats were generated.
/// For objectives where time window doesn't make sense (e.g. Featurestore
/// Snapshot Monitoring), end_time indicates the timestamp of the data used to
/// generate stats (e.g. timestamp we take snapshots for feature values).
#[prost(message, optional, tag = "8")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Feature Metadata information.
/// For example, color is a feature that describes an apple.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Feature {
/// Immutable. Name of the Feature.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
/// `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
///
/// The last part feature is assigned by the client. The feature can be up to
/// 64 characters long and can consist only of ASCII Latin letters A-Z and a-z,
/// underscore(_), and ASCII digits 0-9 starting with a letter. The value will
/// be unique given an entity type.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Description of the Feature.
#[prost(string, tag = "2")]
pub description: ::prost::alloc::string::String,
/// Immutable. Only applicable for Vertex AI Feature Store (Legacy).
/// Type of Feature value.
#[prost(enumeration = "feature::ValueType", tag = "3")]
pub value_type: i32,
/// Output only. Only applicable for Vertex AI Feature Store (Legacy).
/// Timestamp when this EntityType was created.
#[prost(message, optional, tag = "4")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Only applicable for Vertex AI Feature Store (Legacy).
/// Timestamp when this EntityType was most recently updated.
#[prost(message, optional, tag = "5")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. The labels with user-defined metadata to organize your Features.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information on and examples of labels.
/// No more than 64 user labels can be associated with one Feature (System
/// labels are excluded)."
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "6")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Used to perform a consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "7")]
pub etag: ::prost::alloc::string::String,
/// Optional. Only applicable for Vertex AI Feature Store (Legacy).
/// If not set, use the monitoring_config defined for the EntityType this
/// Feature belongs to.
/// Only Features with type
/// ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
/// STRING, DOUBLE or INT64 can enable monitoring.
///
/// If set to true, all types of data monitoring are disabled despite the
/// config on EntityType.
#[prost(bool, tag = "12")]
pub disable_monitoring: bool,
/// Output only. Only applicable for Vertex AI Feature Store (Legacy).
/// The list of historical stats and anomalies with specified objectives.
#[prost(message, repeated, tag = "11")]
pub monitoring_stats_anomalies: ::prost::alloc::vec::Vec<
feature::MonitoringStatsAnomaly,
>,
/// Only applicable for Vertex AI Feature Store.
/// The name of the BigQuery Table/View column hosting data for this version.
/// If no value is provided, will use feature_id.
#[prost(string, tag = "106")]
pub version_column_name: ::prost::alloc::string::String,
/// Entity responsible for maintaining this feature. Can be comma separated
/// list of email addresses or URIs.
#[prost(string, tag = "107")]
pub point_of_contact: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Feature`.
pub mod feature {
/// A list of historical
/// [SnapshotAnalysis][google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig.SnapshotAnalysis]
/// or
/// [ImportFeaturesAnalysis][google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig.ImportFeaturesAnalysis]
/// stats requested by user, sorted by
/// [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1.FeatureStatsAnomaly.start_time]
/// descending.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MonitoringStatsAnomaly {
/// Output only. The objective for each stats.
#[prost(enumeration = "monitoring_stats_anomaly::Objective", tag = "1")]
pub objective: i32,
/// Output only. The stats and anomalies generated at specific timestamp.
#[prost(message, optional, tag = "2")]
pub feature_stats_anomaly: ::core::option::Option<super::FeatureStatsAnomaly>,
}
/// Nested message and enum types in `MonitoringStatsAnomaly`.
pub mod monitoring_stats_anomaly {
/// If the objective in the request is both
/// Import Feature Analysis and Snapshot Analysis, this objective could be
/// one of them. Otherwise, this objective should be the same as the
/// objective in the request.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Objective {
/// If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty.
Unspecified = 0,
/// Stats are generated by Import Feature Analysis.
ImportFeatureAnalysis = 1,
/// Stats are generated by Snapshot Analysis.
SnapshotAnalysis = 2,
}
impl Objective {
/// 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 {
Objective::Unspecified => "OBJECTIVE_UNSPECIFIED",
Objective::ImportFeatureAnalysis => "IMPORT_FEATURE_ANALYSIS",
Objective::SnapshotAnalysis => "SNAPSHOT_ANALYSIS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OBJECTIVE_UNSPECIFIED" => Some(Self::Unspecified),
"IMPORT_FEATURE_ANALYSIS" => Some(Self::ImportFeatureAnalysis),
"SNAPSHOT_ANALYSIS" => Some(Self::SnapshotAnalysis),
_ => None,
}
}
}
}
/// Only applicable for Vertex AI Legacy Feature Store.
/// An enum representing the value type of a feature.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ValueType {
/// The value type is unspecified.
Unspecified = 0,
/// Used for Feature that is a boolean.
Bool = 1,
/// Used for Feature that is a list of boolean.
BoolArray = 2,
/// Used for Feature that is double.
Double = 3,
/// Used for Feature that is a list of double.
DoubleArray = 4,
/// Used for Feature that is INT64.
Int64 = 9,
/// Used for Feature that is a list of INT64.
Int64Array = 10,
/// Used for Feature that is string.
String = 11,
/// Used for Feature that is a list of String.
StringArray = 12,
/// Used for Feature that is bytes.
Bytes = 13,
/// Used for Feature that is struct.
Struct = 14,
}
impl ValueType {
/// 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 {
ValueType::Unspecified => "VALUE_TYPE_UNSPECIFIED",
ValueType::Bool => "BOOL",
ValueType::BoolArray => "BOOL_ARRAY",
ValueType::Double => "DOUBLE",
ValueType::DoubleArray => "DOUBLE_ARRAY",
ValueType::Int64 => "INT64",
ValueType::Int64Array => "INT64_ARRAY",
ValueType::String => "STRING",
ValueType::StringArray => "STRING_ARRAY",
ValueType::Bytes => "BYTES",
ValueType::Struct => "STRUCT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"VALUE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"BOOL" => Some(Self::Bool),
"BOOL_ARRAY" => Some(Self::BoolArray),
"DOUBLE" => Some(Self::Double),
"DOUBLE_ARRAY" => Some(Self::DoubleArray),
"INT64" => Some(Self::Int64),
"INT64_ARRAY" => Some(Self::Int64Array),
"STRING" => Some(Self::String),
"STRING_ARRAY" => Some(Self::StringArray),
"BYTES" => Some(Self::Bytes),
"STRUCT" => Some(Self::Struct),
_ => None,
}
}
}
}
/// The storage details for Avro input content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AvroSource {
/// Required. Google Cloud Storage location.
#[prost(message, optional, tag = "1")]
pub gcs_source: ::core::option::Option<GcsSource>,
}
/// The storage details for CSV input content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CsvSource {
/// Required. Google Cloud Storage location.
#[prost(message, optional, tag = "1")]
pub gcs_source: ::core::option::Option<GcsSource>,
}
/// The Google Cloud Storage location for the input content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GcsSource {
/// Required. Google Cloud Storage URI(-s) to the input file(s). May contain
/// wildcards. For more information on wildcards, see
/// <https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.>
#[prost(string, repeated, tag = "1")]
pub uris: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// The Google Cloud Storage location where the output is to be written to.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GcsDestination {
/// Required. Google Cloud Storage URI to output directory. If the uri doesn't
/// end with
/// '/', a '/' will be automatically appended. The directory is created if it
/// doesn't exist.
#[prost(string, tag = "1")]
pub output_uri_prefix: ::prost::alloc::string::String,
}
/// The BigQuery location for the input content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQuerySource {
/// Required. BigQuery URI to a table, up to 2000 characters long.
/// Accepted forms:
///
/// * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
#[prost(string, tag = "1")]
pub input_uri: ::prost::alloc::string::String,
}
/// The BigQuery location for the output content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQueryDestination {
/// Required. BigQuery URI to a project or table, up to 2000 characters long.
///
/// When only the project is specified, the Dataset and Table is created.
/// When the full table reference is specified, the Dataset must exist and
/// table must not exist.
///
/// Accepted forms:
///
/// * BigQuery path. For example:
/// `bq://projectId` or `bq://projectId.bqDatasetId` or
/// `bq://projectId.bqDatasetId.bqTableId`.
#[prost(string, tag = "1")]
pub output_uri: ::prost::alloc::string::String,
}
/// The storage details for CSV output content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CsvDestination {
/// Required. Google Cloud Storage location.
#[prost(message, optional, tag = "1")]
pub gcs_destination: ::core::option::Option<GcsDestination>,
}
/// The storage details for TFRecord output content.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TfRecordDestination {
/// Required. Google Cloud Storage location.
#[prost(message, optional, tag = "1")]
pub gcs_destination: ::core::option::Option<GcsDestination>,
}
/// The Container Registry location for the container image.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ContainerRegistryDestination {
/// Required. Container Registry URI of a container image.
/// Only Google Container Registry and Artifact Registry are supported now.
/// Accepted forms:
///
/// * Google Container Registry path. For example:
/// `gcr.io/projectId/imageName:tag`.
///
/// * Artifact Registry path. For example:
/// `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`.
///
/// If a tag is not specified, "latest" will be used as the default tag.
#[prost(string, tag = "1")]
pub output_uri: ::prost::alloc::string::String,
}
/// Vertex AI Feature Group.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureGroup {
/// Identifier. Name of the FeatureGroup. Format:
/// `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Timestamp when this FeatureGroup was created.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this FeatureGroup was last updated.
#[prost(message, optional, tag = "3")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Used to perform consistent read-modify-write updates. If not set,
/// a blind "overwrite" update happens.
#[prost(string, tag = "4")]
pub etag: ::prost::alloc::string::String,
/// Optional. The labels with user-defined metadata to organize your
/// FeatureGroup.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information on and examples of labels.
/// No more than 64 user labels can be associated with one
/// FeatureGroup(System labels are excluded)." System reserved label keys
/// are prefixed with "aiplatform.googleapis.com/" and are immutable.
#[prost(btree_map = "string, string", tag = "5")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. Description of the FeatureGroup.
#[prost(string, tag = "6")]
pub description: ::prost::alloc::string::String,
#[prost(oneof = "feature_group::Source", tags = "7")]
pub source: ::core::option::Option<feature_group::Source>,
}
/// Nested message and enum types in `FeatureGroup`.
pub mod feature_group {
/// Input source type for BigQuery Tables and Views.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQuery {
/// Required. Immutable. The BigQuery source URI that points to either a
/// BigQuery Table or View.
#[prost(message, optional, tag = "1")]
pub big_query_source: ::core::option::Option<super::BigQuerySource>,
/// Optional. Columns to construct entity_id / row keys.
/// If not provided defaults to `entity_id`.
#[prost(string, repeated, tag = "2")]
pub entity_id_columns: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. If the source is a time-series source, this can be set to
/// control how downstream sources (ex:
/// [FeatureView][google.cloud.aiplatform.v1.FeatureView] ) will treat
/// time-series sources. If not set, will treat the source as a time-series
/// source with `feature_timestamp` as timestamp column and no scan boundary.
#[prost(message, optional, tag = "4")]
pub time_series: ::core::option::Option<big_query::TimeSeries>,
}
/// Nested message and enum types in `BigQuery`.
pub mod big_query {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TimeSeries {
/// Optional. Column hosting timestamp values for a time-series source.
/// Will be used to determine the latest `feature_values` for each entity.
/// Optional. If not provided, column named `feature_timestamp` of
/// type `TIMESTAMP` will be used.
#[prost(string, tag = "1")]
pub timestamp_column: ::prost::alloc::string::String,
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// Indicates that features for this group come from BigQuery Table/View.
/// By default treats the source as a sparse time series source. The BigQuery
/// source table or view must have at least one entity ID column and a column
/// named `feature_timestamp`.
#[prost(message, tag = "7")]
BigQuery(BigQuery),
}
}
/// Configuration of how features in Featurestore are monitored.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FeaturestoreMonitoringConfig {
/// The config for Snapshot Analysis Based Feature Monitoring.
#[prost(message, optional, tag = "1")]
pub snapshot_analysis: ::core::option::Option<
featurestore_monitoring_config::SnapshotAnalysis,
>,
/// The config for ImportFeatures Analysis Based Feature Monitoring.
#[prost(message, optional, tag = "2")]
pub import_features_analysis: ::core::option::Option<
featurestore_monitoring_config::ImportFeaturesAnalysis,
>,
/// Threshold for numerical features of anomaly detection.
/// This is shared by all objectives of Featurestore Monitoring for numerical
/// features (i.e. Features with type
/// ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) DOUBLE
/// or INT64).
#[prost(message, optional, tag = "3")]
pub numerical_threshold_config: ::core::option::Option<
featurestore_monitoring_config::ThresholdConfig,
>,
/// Threshold for categorical features of anomaly detection.
/// This is shared by all types of Featurestore Monitoring for categorical
/// features (i.e. Features with type
/// ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL or
/// STRING).
#[prost(message, optional, tag = "4")]
pub categorical_threshold_config: ::core::option::Option<
featurestore_monitoring_config::ThresholdConfig,
>,
}
/// Nested message and enum types in `FeaturestoreMonitoringConfig`.
pub mod featurestore_monitoring_config {
/// Configuration of the Featurestore's Snapshot Analysis Based Monitoring.
/// This type of analysis generates statistics for each Feature based on a
/// snapshot of the latest feature value of each entities every
/// monitoring_interval.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SnapshotAnalysis {
/// The monitoring schedule for snapshot analysis.
/// For EntityType-level config:
/// unset / disabled = true indicates disabled by
/// default for Features under it; otherwise by default enable snapshot
/// analysis monitoring with monitoring_interval for Features under it.
/// Feature-level config:
/// disabled = true indicates disabled regardless of the EntityType-level
/// config; unset monitoring_interval indicates going with EntityType-level
/// config; otherwise run snapshot analysis monitoring with
/// monitoring_interval regardless of the EntityType-level config.
/// Explicitly Disable the snapshot analysis based monitoring.
#[prost(bool, tag = "1")]
pub disabled: bool,
/// Configuration of the snapshot analysis based monitoring pipeline
/// running interval. The value indicates number of days.
#[prost(int32, tag = "3")]
pub monitoring_interval_days: i32,
/// Customized export features time window for snapshot analysis. Unit is one
/// day. Default value is 3 weeks. Minimum value is 1 day. Maximum value is
/// 4000 days.
#[prost(int32, tag = "4")]
pub staleness_days: i32,
}
/// Configuration of the Featurestore's ImportFeature Analysis Based
/// Monitoring. This type of analysis generates statistics for values of each
/// Feature imported by every
/// [ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues]
/// operation.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ImportFeaturesAnalysis {
/// Whether to enable / disable / inherite default hebavior for import
/// features analysis.
#[prost(enumeration = "import_features_analysis::State", tag = "1")]
pub state: i32,
/// The baseline used to do anomaly detection for the statistics generated by
/// import features analysis.
#[prost(enumeration = "import_features_analysis::Baseline", tag = "2")]
pub anomaly_detection_baseline: i32,
}
/// Nested message and enum types in `ImportFeaturesAnalysis`.
pub mod import_features_analysis {
/// The state defines whether to enable ImportFeature analysis.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Should not be used.
Unspecified = 0,
/// The default behavior of whether to enable the monitoring.
/// EntityType-level config: disabled.
/// Feature-level config: inherited from the configuration of EntityType
/// this Feature belongs to.
Default = 1,
/// Explicitly enables import features analysis.
/// EntityType-level config: by default enables import features analysis
/// for all Features under it. Feature-level config: enables import
/// features analysis regardless of the EntityType-level config.
Enabled = 2,
/// Explicitly disables import features analysis.
/// EntityType-level config: by default disables import features analysis
/// for all Features under it. Feature-level config: disables import
/// features analysis regardless of the EntityType-level config.
Disabled = 3,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Default => "DEFAULT",
State::Enabled => "ENABLED",
State::Disabled => "DISABLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"DEFAULT" => Some(Self::Default),
"ENABLED" => Some(Self::Enabled),
"DISABLED" => Some(Self::Disabled),
_ => None,
}
}
}
/// Defines the baseline to do anomaly detection for feature values imported
/// by each
/// [ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues]
/// operation.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Baseline {
/// Should not be used.
Unspecified = 0,
/// Choose the later one statistics generated by either most recent
/// snapshot analysis or previous import features analysis. If non of them
/// exists, skip anomaly detection and only generate a statistics.
LatestStats = 1,
/// Use the statistics generated by the most recent snapshot analysis if
/// exists.
MostRecentSnapshotStats = 2,
/// Use the statistics generated by the previous import features analysis
/// if exists.
PreviousImportFeaturesStats = 3,
}
impl Baseline {
/// 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 {
Baseline::Unspecified => "BASELINE_UNSPECIFIED",
Baseline::LatestStats => "LATEST_STATS",
Baseline::MostRecentSnapshotStats => "MOST_RECENT_SNAPSHOT_STATS",
Baseline::PreviousImportFeaturesStats => {
"PREVIOUS_IMPORT_FEATURES_STATS"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"BASELINE_UNSPECIFIED" => Some(Self::Unspecified),
"LATEST_STATS" => Some(Self::LatestStats),
"MOST_RECENT_SNAPSHOT_STATS" => Some(Self::MostRecentSnapshotStats),
"PREVIOUS_IMPORT_FEATURES_STATS" => {
Some(Self::PreviousImportFeaturesStats)
}
_ => None,
}
}
}
}
/// The config for Featurestore Monitoring threshold.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ThresholdConfig {
#[prost(oneof = "threshold_config::Threshold", tags = "1")]
pub threshold: ::core::option::Option<threshold_config::Threshold>,
}
/// Nested message and enum types in `ThresholdConfig`.
pub mod threshold_config {
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Threshold {
/// Specify a threshold value that can trigger the alert.
/// 1. For categorical feature, the distribution distance is calculated by
/// L-inifinity norm.
/// 2. For numerical feature, the distribution distance is calculated by
/// Jensen–Shannon divergence. Each feature must have a non-zero threshold
/// if they need to be monitored. Otherwise no alert will be triggered for
/// that feature.
#[prost(double, tag = "1")]
Value(f64),
}
}
}
/// An entity type is a type of object in a system that needs to be modeled and
/// have stored information about. For example, driver is an entity type, and
/// driver0 is an instance of an entity type driver.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EntityType {
/// Immutable. Name of the EntityType.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
///
/// The last part entity_type is assigned by the client. The entity_type can be
/// up to 64 characters long and can consist only of ASCII Latin letters A-Z
/// and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The
/// value will be unique given a featurestore.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. Description of the EntityType.
#[prost(string, tag = "2")]
pub description: ::prost::alloc::string::String,
/// Output only. Timestamp when this EntityType was created.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this EntityType was most recently updated.
#[prost(message, optional, tag = "4")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. The labels with user-defined metadata to organize your
/// EntityTypes.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information on and examples of labels.
/// No more than 64 user labels can be associated with one EntityType (System
/// labels are excluded)."
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "6")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. Used to perform a consistent read-modify-write updates. If not
/// set, a blind "overwrite" update happens.
#[prost(string, tag = "7")]
pub etag: ::prost::alloc::string::String,
/// Optional. The default monitoring configuration for all Features with value
/// type
/// ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
/// STRING, DOUBLE or INT64 under this EntityType.
///
/// If this is populated with
/// \[FeaturestoreMonitoringConfig.monitoring_interval\] specified, snapshot
/// analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
/// disabled.
#[prost(message, optional, tag = "8")]
pub monitoring_config: ::core::option::Option<FeaturestoreMonitoringConfig>,
/// Optional. Config for data retention policy in offline storage.
/// TTL in days for feature values that will be stored in offline storage.
/// The Feature Store offline storage periodically removes obsolete feature
/// values older than `offline_storage_ttl_days` since the feature generation
/// time. If unset (or explicitly set to 0), default to 4000 days TTL.
#[prost(int32, tag = "10")]
pub offline_storage_ttl_days: i32,
/// Output only. Reserved for future use.
#[prost(bool, tag = "11")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "12")]
pub satisfies_pzi: bool,
}
/// Matcher for Features of an EntityType by Feature ID.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IdMatcher {
/// Required. The following are accepted as `ids`:
///
/// * A single-element list containing only `*`, which selects all Features
/// in the target EntityType, or
/// * A list containing only Feature IDs, which selects only Features with
/// those IDs in the target EntityType.
#[prost(string, repeated, tag = "1")]
pub ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Selector for Features of an EntityType.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureSelector {
/// Required. Matches Features based on ID.
#[prost(message, optional, tag = "1")]
pub id_matcher: ::core::option::Option<IdMatcher>,
}
/// Vertex AI Feature Store provides a centralized repository for organizing,
/// storing, and serving ML features. The Featurestore is a top-level container
/// for your features and their values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Featurestore {
/// Output only. Name of the Featurestore. Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Timestamp when this Featurestore was created.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Featurestore was last updated.
#[prost(message, optional, tag = "4")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Used to perform consistent read-modify-write updates. If not set,
/// a blind "overwrite" update happens.
#[prost(string, tag = "5")]
pub etag: ::prost::alloc::string::String,
/// Optional. The labels with user-defined metadata to organize your
/// Featurestore.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information on and examples of labels.
/// No more than 64 user labels can be associated with one Featurestore(System
/// labels are excluded)."
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "6")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. Config for online storage resources. The field should not
/// co-exist with the field of `OnlineStoreReplicationConfig`. If both of it
/// and OnlineStoreReplicationConfig are unset, the feature store will not have
/// an online store and cannot be used for online serving.
#[prost(message, optional, tag = "7")]
pub online_serving_config: ::core::option::Option<featurestore::OnlineServingConfig>,
/// Output only. State of the featurestore.
#[prost(enumeration = "featurestore::State", tag = "8")]
pub state: i32,
/// Optional. TTL in days for feature values that will be stored in online
/// serving storage. The Feature Store online storage periodically removes
/// obsolete feature values older than `online_storage_ttl_days` since the
/// feature generation time. Note that `online_storage_ttl_days` should be less
/// than or equal to `offline_storage_ttl_days` for each EntityType under a
/// featurestore. If not set, default to 4000 days
#[prost(int32, tag = "13")]
pub online_storage_ttl_days: i32,
/// Optional. Customer-managed encryption key spec for data storage. If set,
/// both of the online and offline data storage will be secured by this key.
#[prost(message, optional, tag = "10")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "14")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "15")]
pub satisfies_pzi: bool,
}
/// Nested message and enum types in `Featurestore`.
pub mod featurestore {
/// OnlineServingConfig specifies the details for provisioning online serving
/// resources.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct OnlineServingConfig {
/// The number of nodes for the online store. The number of nodes doesn't
/// scale automatically, but you can manually update the number of
/// nodes. If set to 0, the featurestore will not have an
/// online store and cannot be used for online serving.
#[prost(int32, tag = "2")]
pub fixed_node_count: i32,
/// Online serving scaling configuration.
/// Only one of `fixed_node_count` and `scaling` can be set. Setting one will
/// reset the other.
#[prost(message, optional, tag = "4")]
pub scaling: ::core::option::Option<online_serving_config::Scaling>,
}
/// Nested message and enum types in `OnlineServingConfig`.
pub mod online_serving_config {
/// Online serving scaling configuration. If min_node_count and
/// max_node_count are set to the same value, the cluster will be configured
/// with the fixed number of node (no auto-scaling).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Scaling {
/// Required. The minimum number of nodes to scale down to. Must be greater
/// than or equal to 1.
#[prost(int32, tag = "1")]
pub min_node_count: i32,
/// The maximum number of nodes to scale up to. Must be greater than
/// min_node_count, and less than or equal to 10 times of 'min_node_count'.
#[prost(int32, tag = "2")]
pub max_node_count: i32,
/// Optional. The cpu utilization that the Autoscaler should be trying to
/// achieve. This number is on a scale from 0 (no utilization) to 100
/// (total utilization), and is limited between 10 and 80. When a cluster's
/// CPU utilization exceeds the target that you have set, Bigtable
/// immediately adds nodes to the cluster. When CPU utilization is
/// substantially lower than the target, Bigtable removes nodes. If not set
/// or set to 0, default to 50.
#[prost(int32, tag = "3")]
pub cpu_utilization_target: i32,
}
}
/// Possible states a featurestore can have.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Default value. This value is unused.
Unspecified = 0,
/// State when the featurestore configuration is not being updated and the
/// fields reflect the current configuration of the featurestore. The
/// featurestore is usable in this state.
Stable = 1,
/// The state of the featurestore configuration when it is being updated.
/// During an update, the fields reflect either the original configuration
/// or the updated configuration of the featurestore. For example,
/// `online_serving_config.fixed_node_count` can take minutes to update.
/// While the update is in progress, the featurestore is in the UPDATING
/// state, and the value of `fixed_node_count` can be the original value or
/// the updated value, depending on the progress of the operation. Until the
/// update completes, the actual number of nodes can still be the original
/// value of `fixed_node_count`. The featurestore is still usable in this
/// state.
Updating = 2,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Stable => "STABLE",
State::Updating => "UPDATING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"STABLE" => Some(Self::Stable),
"UPDATING" => Some(Self::Updating),
_ => None,
}
}
}
}
/// Generic Metadata shared by all operations.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GenericOperationMetadata {
/// Output only. Partial failures encountered.
/// E.g. single files that couldn't be read.
/// This field should never exceed 20 entries.
/// Status details field will contain standard Google Cloud error details.
#[prost(message, repeated, tag = "1")]
pub partial_failures: ::prost::alloc::vec::Vec<super::super::super::rpc::Status>,
/// Output only. Time when the operation was created.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the operation was updated for the last time.
/// If the operation has finished (successfully or not), this is the finish
/// time.
#[prost(message, optional, tag = "3")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Details of operations that perform deletes of any entities.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeaturestoreRequest {
/// Required. The resource name of the Location to create Featurestores.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Featurestore to create.
#[prost(message, optional, tag = "2")]
pub featurestore: ::core::option::Option<Featurestore>,
/// Required. The ID to use for this Featurestore, which will become the final
/// component of the Featurestore's resource name.
///
/// This value may be up to 60 characters, and valid characters are
/// `\[a-z0-9_\]`. The first character cannot be a number.
///
/// The value must be unique within the project and location.
#[prost(string, tag = "3")]
pub featurestore_id: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetFeaturestoreRequest {
/// Required. The name of the Featurestore resource.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeaturestoresRequest {
/// Required. The resource name of the Location to list Featurestores.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the featurestores that match the filter expression. The following
/// fields are supported:
///
/// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be
/// in RFC 3339 format.
/// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be
/// in RFC 3339 format.
/// * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`,
/// `<=`, and `>=` comparisons.
/// * `labels`: Supports key-value equality and key presence.
///
/// Examples:
///
/// * `create_time > "2020-01-01" OR update_time > "2020-01-01"`
/// Featurestores created or updated after 2020-01-01.
/// * `labels.env = "prod"`
/// Featurestores with label "env" set to "prod".
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of Featurestores to return. The service may return fewer
/// than this value. If unspecified, at most 100 Featurestores will be
/// returned. The maximum value is 100; any value greater than 100 will be
/// coerced to 100.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
/// Supported Fields:
///
/// * `create_time`
/// * `update_time`
/// * `online_serving_config.fixed_node_count`
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "6")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeaturestoresResponse {
/// The Featurestores matching the request.
#[prost(message, repeated, tag = "1")]
pub featurestores: ::prost::alloc::vec::Vec<Featurestore>,
/// A token, which can be sent as
/// [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1.ListFeaturestoresRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeaturestoreRequest {
/// Required. The Featurestore's `name` field is used to identify the
/// Featurestore to be updated. Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}`
#[prost(message, optional, tag = "1")]
pub featurestore: ::core::option::Option<Featurestore>,
/// Field mask is used to specify the fields to be overwritten in the
/// Featurestore resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then only the non-empty fields present in the
/// request will be overwritten. Set the update_mask to `*` to override all
/// fields.
///
/// Updatable fields:
///
/// * `labels`
/// * `online_serving_config.fixed_node_count`
/// * `online_serving_config.scaling`
/// * `online_storage_ttl_days`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFeaturestoreRequest {
/// Required. The name of the Featurestore to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// If set to true, any EntityTypes and Features for this Featurestore will
/// also be deleted. (Otherwise, the request will only work if the Featurestore
/// has no EntityTypes.)
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportFeatureValuesRequest {
/// Required. The resource name of the EntityType grouping the Features for
/// which values are being imported. Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
#[prost(string, tag = "1")]
pub entity_type: ::prost::alloc::string::String,
/// Source column that holds entity IDs. If not provided, entity IDs are
/// extracted from the column named entity_id.
#[prost(string, tag = "5")]
pub entity_id_field: ::prost::alloc::string::String,
/// Required. Specifications defining which Feature values to import from the
/// entity. The request fails if no feature_specs are provided, and having
/// multiple feature_specs for one Feature is not allowed.
#[prost(message, repeated, tag = "8")]
pub feature_specs: ::prost::alloc::vec::Vec<
import_feature_values_request::FeatureSpec,
>,
/// If set, data will not be imported for online serving. This
/// is typically used for backfilling, where Feature generation timestamps are
/// not in the timestamp range needed for online serving.
#[prost(bool, tag = "9")]
pub disable_online_serving: bool,
/// Specifies the number of workers that are used to write data to the
/// Featurestore. Consider the online serving capacity that you require to
/// achieve the desired import throughput without interfering with online
/// serving. The value must be positive, and less than or equal to 100.
/// If not set, defaults to using 1 worker. The low count ensures minimal
/// impact on online serving performance.
#[prost(int32, tag = "11")]
pub worker_count: i32,
/// If true, API doesn't start ingestion analysis pipeline.
#[prost(bool, tag = "12")]
pub disable_ingestion_analysis: bool,
/// Details about the source data, including the location of the storage and
/// the format.
#[prost(oneof = "import_feature_values_request::Source", tags = "2, 3, 4")]
pub source: ::core::option::Option<import_feature_values_request::Source>,
/// Source of Feature timestamp for all Feature values of each entity.
/// Timestamps must be millisecond-aligned.
#[prost(oneof = "import_feature_values_request::FeatureTimeSource", tags = "6, 7")]
pub feature_time_source: ::core::option::Option<
import_feature_values_request::FeatureTimeSource,
>,
}
/// Nested message and enum types in `ImportFeatureValuesRequest`.
pub mod import_feature_values_request {
/// Defines the Feature value(s) to import.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureSpec {
/// Required. ID of the Feature to import values of. This Feature must exist
/// in the target EntityType, or the request will fail.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Source column to get the Feature values from. If not set, uses the column
/// with the same name as the Feature ID.
#[prost(string, tag = "2")]
pub source_field: ::prost::alloc::string::String,
}
/// Details about the source data, including the location of the storage and
/// the format.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
#[prost(message, tag = "2")]
AvroSource(super::AvroSource),
#[prost(message, tag = "3")]
BigquerySource(super::BigQuerySource),
#[prost(message, tag = "4")]
CsvSource(super::CsvSource),
}
/// Source of Feature timestamp for all Feature values of each entity.
/// Timestamps must be millisecond-aligned.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum FeatureTimeSource {
/// Source column that holds the Feature timestamp for all Feature
/// values in each entity.
#[prost(string, tag = "6")]
FeatureTimeField(::prost::alloc::string::String),
/// Single Feature timestamp for all entities being imported. The
/// timestamp must not have higher than millisecond precision.
#[prost(message, tag = "7")]
FeatureTime(::prost_types::Timestamp),
}
}
/// Response message for
/// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ImportFeatureValuesResponse {
/// Number of entities that have been imported by the operation.
#[prost(int64, tag = "1")]
pub imported_entity_count: i64,
/// Number of Feature values that have been imported by the operation.
#[prost(int64, tag = "2")]
pub imported_feature_value_count: i64,
/// The number of rows in input source that weren't imported due to either
/// * Not having any featureValues.
/// * Having a null entityId.
/// * Having a null timestamp.
/// * Not being parsable (applicable for CSV sources).
#[prost(int64, tag = "6")]
pub invalid_row_count: i64,
/// The number rows that weren't ingested due to having feature timestamps
/// outside the retention boundary.
#[prost(int64, tag = "4")]
pub timestamp_outside_retention_rows_count: i64,
}
/// Request message for
/// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchReadFeatureValuesRequest {
/// Required. The resource name of the Featurestore from which to query Feature
/// values. Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}`
#[prost(string, tag = "1")]
pub featurestore: ::prost::alloc::string::String,
/// Required. Specifies output location and format.
#[prost(message, optional, tag = "4")]
pub destination: ::core::option::Option<FeatureValueDestination>,
/// When not empty, the specified fields in the *_read_instances source will be
/// joined as-is in the output, in addition to those fields from the
/// Featurestore Entity.
///
/// For BigQuery source, the type of the pass-through values will be
/// automatically inferred. For CSV source, the pass-through values will be
/// passed as opaque bytes.
#[prost(message, repeated, tag = "8")]
pub pass_through_fields: ::prost::alloc::vec::Vec<
batch_read_feature_values_request::PassThroughField,
>,
/// Required. Specifies EntityType grouping Features to read values of and
/// settings.
#[prost(message, repeated, tag = "7")]
pub entity_type_specs: ::prost::alloc::vec::Vec<
batch_read_feature_values_request::EntityTypeSpec,
>,
/// Optional. Excludes Feature values with feature generation timestamp before
/// this timestamp. If not set, retrieve oldest values kept in Feature Store.
/// Timestamp, if present, must not have higher than millisecond precision.
#[prost(message, optional, tag = "11")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
#[prost(oneof = "batch_read_feature_values_request::ReadOption", tags = "3, 5")]
pub read_option: ::core::option::Option<
batch_read_feature_values_request::ReadOption,
>,
}
/// Nested message and enum types in `BatchReadFeatureValuesRequest`.
pub mod batch_read_feature_values_request {
/// Describe pass-through fields in read_instance source.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PassThroughField {
/// Required. The name of the field in the CSV header or the name of the
/// column in BigQuery table. The naming restriction is the same as
/// [Feature.name][google.cloud.aiplatform.v1.Feature.name].
#[prost(string, tag = "1")]
pub field_name: ::prost::alloc::string::String,
}
/// Selects Features of an EntityType to read values of and specifies read
/// settings.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EntityTypeSpec {
/// Required. ID of the EntityType to select Features. The EntityType id is
/// the
/// [entity_type_id][google.cloud.aiplatform.v1.CreateEntityTypeRequest.entity_type_id]
/// specified during EntityType creation.
#[prost(string, tag = "1")]
pub entity_type_id: ::prost::alloc::string::String,
/// Required. Selectors choosing which Feature values to read from the
/// EntityType.
#[prost(message, optional, tag = "2")]
pub feature_selector: ::core::option::Option<super::FeatureSelector>,
/// Per-Feature settings for the batch read.
#[prost(message, repeated, tag = "3")]
pub settings: ::prost::alloc::vec::Vec<super::DestinationFeatureSetting>,
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ReadOption {
/// Each read instance consists of exactly one read timestamp and one or more
/// entity IDs identifying entities of the corresponding EntityTypes whose
/// Features are requested.
///
/// Each output instance contains Feature values of requested entities
/// concatenated together as of the read time.
///
/// An example read instance may be `foo_entity_id, bar_entity_id,
/// 2020-01-01T10:00:00.123Z`.
///
/// An example output instance may be `foo_entity_id, bar_entity_id,
/// 2020-01-01T10:00:00.123Z, foo_entity_feature1_value,
/// bar_entity_feature2_value`.
///
/// Timestamp in each read instance must be millisecond-aligned.
///
/// `csv_read_instances` are read instances stored in a plain-text CSV file.
/// The header should be:
/// \[ENTITY_TYPE_ID1\], \[ENTITY_TYPE_ID2\], ..., timestamp
///
/// The columns can be in any order.
///
/// Values in the timestamp column must use the RFC 3339 format, e.g.
/// `2012-07-30T10:43:17.123Z`.
#[prost(message, tag = "3")]
CsvReadInstances(super::CsvSource),
/// Similar to csv_read_instances, but from BigQuery source.
#[prost(message, tag = "5")]
BigqueryReadInstances(super::BigQuerySource),
}
}
/// Request message for
/// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportFeatureValuesRequest {
/// Required. The resource name of the EntityType from which to export Feature
/// values. Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
#[prost(string, tag = "1")]
pub entity_type: ::prost::alloc::string::String,
/// Required. Specifies destination location and format.
#[prost(message, optional, tag = "4")]
pub destination: ::core::option::Option<FeatureValueDestination>,
/// Required. Selects Features to export values of.
#[prost(message, optional, tag = "5")]
pub feature_selector: ::core::option::Option<FeatureSelector>,
/// Per-Feature export settings.
#[prost(message, repeated, tag = "6")]
pub settings: ::prost::alloc::vec::Vec<DestinationFeatureSetting>,
/// Required. The mode in which Feature values are exported.
#[prost(oneof = "export_feature_values_request::Mode", tags = "3, 7")]
pub mode: ::core::option::Option<export_feature_values_request::Mode>,
}
/// Nested message and enum types in `ExportFeatureValuesRequest`.
pub mod export_feature_values_request {
/// Describes exporting the latest Feature values of all entities of the
/// EntityType between \[start_time, snapshot_time\].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SnapshotExport {
/// Exports Feature values as of this timestamp. If not set,
/// retrieve values as of now. Timestamp, if present, must not have higher
/// than millisecond precision.
#[prost(message, optional, tag = "1")]
pub snapshot_time: ::core::option::Option<::prost_types::Timestamp>,
/// Excludes Feature values with feature generation timestamp before this
/// timestamp. If not set, retrieve oldest values kept in Feature Store.
/// Timestamp, if present, must not have higher than millisecond precision.
#[prost(message, optional, tag = "2")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Describes exporting all historical Feature values of all entities of the
/// EntityType between \[start_time, end_time\].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FullExport {
/// Excludes Feature values with feature generation timestamp before this
/// timestamp. If not set, retrieve oldest values kept in Feature Store.
/// Timestamp, if present, must not have higher than millisecond precision.
#[prost(message, optional, tag = "2")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Exports Feature values as of this timestamp. If not set,
/// retrieve values as of now. Timestamp, if present, must not have higher
/// than millisecond precision.
#[prost(message, optional, tag = "1")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Required. The mode in which Feature values are exported.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Mode {
/// Exports the latest Feature values of all entities of the EntityType
/// within a time range.
#[prost(message, tag = "3")]
SnapshotExport(SnapshotExport),
/// Exports all historical values of all entities of the EntityType within a
/// time range
#[prost(message, tag = "7")]
FullExport(FullExport),
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DestinationFeatureSetting {
/// Required. The ID of the Feature to apply the setting to.
#[prost(string, tag = "1")]
pub feature_id: ::prost::alloc::string::String,
/// Specify the field name in the export destination. If not specified,
/// Feature ID is used.
#[prost(string, tag = "2")]
pub destination_field: ::prost::alloc::string::String,
}
/// A destination location for Feature values and format.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureValueDestination {
#[prost(oneof = "feature_value_destination::Destination", tags = "1, 2, 3")]
pub destination: ::core::option::Option<feature_value_destination::Destination>,
}
/// Nested message and enum types in `FeatureValueDestination`.
pub mod feature_value_destination {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Destination {
/// Output in BigQuery format.
/// [BigQueryDestination.output_uri][google.cloud.aiplatform.v1.BigQueryDestination.output_uri]
/// in
/// [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1.FeatureValueDestination.bigquery_destination]
/// must refer to a table.
#[prost(message, tag = "1")]
BigqueryDestination(super::BigQueryDestination),
/// Output in TFRecord format.
///
/// Below are the mapping from Feature value type
/// in Featurestore to Feature value type in TFRecord:
///
/// Value type in Featurestore | Value type in TFRecord
/// DOUBLE, DOUBLE_ARRAY | FLOAT_LIST
/// INT64, INT64_ARRAY | INT64_LIST
/// STRING, STRING_ARRAY, BYTES | BYTES_LIST
/// true -> byte_string("true"), false -> byte_string("false")
/// BOOL, BOOL_ARRAY (true, false) | BYTES_LIST
#[prost(message, tag = "2")]
TfrecordDestination(super::TfRecordDestination),
/// Output in CSV format. Array Feature value types are not allowed in CSV
/// format.
#[prost(message, tag = "3")]
CsvDestination(super::CsvDestination),
}
}
/// Response message for
/// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ExportFeatureValuesResponse {}
/// Response message for
/// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BatchReadFeatureValuesResponse {}
/// Request message for
/// [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateEntityTypeRequest {
/// Required. The resource name of the Featurestore to create EntityTypes.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The EntityType to create.
#[prost(message, optional, tag = "2")]
pub entity_type: ::core::option::Option<EntityType>,
/// Required. The ID to use for the EntityType, which will become the final
/// component of the EntityType's resource name.
///
/// This value may be up to 60 characters, and valid characters are
/// `\[a-z0-9_\]`. The first character cannot be a number.
///
/// The value must be unique within a featurestore.
#[prost(string, tag = "3")]
pub entity_type_id: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetEntityTypeRequest {
/// Required. The name of the EntityType resource.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntityTypesRequest {
/// Required. The resource name of the Featurestore to list EntityTypes.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the EntityTypes that match the filter expression. The following
/// filters are supported:
///
/// * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
/// Values must be in RFC 3339 format.
/// * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
/// Values must be in RFC 3339 format.
/// * `labels`: Supports key-value equality as well as key presence.
///
/// Examples:
///
/// * `create_time > \"2020-01-31T15:30:00.000000Z\" OR
/// update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created
/// or updated after 2020-01-31T15:30:00.000000Z.
/// * `labels.active = yes AND labels.env = prod` --> EntityTypes having both
/// (active: yes) and (env: prod) labels.
/// * `labels.env: *` --> Any EntityType which has a label with 'env' as the
/// key.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of EntityTypes to return. The service may return fewer
/// than this value. If unspecified, at most 1000 EntityTypes will be returned.
/// The maximum value is 1000; any value greater than 1000 will be coerced to
/// 1000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
///
/// Supported fields:
///
/// * `entity_type_id`
/// * `create_time`
/// * `update_time`
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "6")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEntityTypesResponse {
/// The EntityTypes matching the request.
#[prost(message, repeated, tag = "1")]
pub entity_types: ::prost::alloc::vec::Vec<EntityType>,
/// A token, which can be sent as
/// [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1.ListEntityTypesRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateEntityTypeRequest {
/// Required. The EntityType's `name` field is used to identify the EntityType
/// to be updated. Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
#[prost(message, optional, tag = "1")]
pub entity_type: ::core::option::Option<EntityType>,
/// Field mask is used to specify the fields to be overwritten in the
/// EntityType resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then only the non-empty fields present in the
/// request will be overwritten. Set the update_mask to `*` to override all
/// fields.
///
/// Updatable fields:
///
/// * `description`
/// * `labels`
/// * `monitoring_config.snapshot_analysis.disabled`
/// * `monitoring_config.snapshot_analysis.monitoring_interval_days`
/// * `monitoring_config.snapshot_analysis.staleness_days`
/// * `monitoring_config.import_features_analysis.state`
/// * `monitoring_config.import_features_analysis.anomaly_detection_baseline`
/// * `monitoring_config.numerical_threshold_config.value`
/// * `monitoring_config.categorical_threshold_config.value`
/// * `offline_storage_ttl_days`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for [FeaturestoreService.DeleteEntityTypes][].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteEntityTypeRequest {
/// Required. The name of the EntityType to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// If set to true, any Features for this EntityType will also be deleted.
/// (Otherwise, the request will only work if the EntityType has no Features.)
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature].
/// Request message for
/// [FeatureRegistryService.CreateFeature][google.cloud.aiplatform.v1.FeatureRegistryService.CreateFeature].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeatureRequest {
/// Required. The resource name of the EntityType or FeatureGroup to create a
/// Feature. Format for entity_type as parent:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
/// Format for feature_group as parent:
/// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Feature to create.
#[prost(message, optional, tag = "2")]
pub feature: ::core::option::Option<Feature>,
/// Required. The ID to use for the Feature, which will become the final
/// component of the Feature's resource name.
///
/// This value may be up to 128 characters, and valid characters are
/// `\[a-z0-9_\]`. The first character cannot be a number.
///
/// The value must be unique within an EntityType/FeatureGroup.
#[prost(string, tag = "3")]
pub feature_id: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateFeaturesRequest {
/// Required. The resource name of the EntityType to create the batch of
/// Features under. Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The request message specifying the Features to create. All
/// Features must be created under the same parent EntityType. The `parent`
/// field in each child request message can be omitted. If `parent` is set in a
/// child request, then the value must match the `parent` value in this request
/// message.
#[prost(message, repeated, tag = "2")]
pub requests: ::prost::alloc::vec::Vec<CreateFeatureRequest>,
}
/// Response message for
/// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateFeaturesResponse {
/// The Features created.
#[prost(message, repeated, tag = "1")]
pub features: ::prost::alloc::vec::Vec<Feature>,
}
/// Request message for
/// [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1.FeaturestoreService.GetFeature].
/// Request message for
/// [FeatureRegistryService.GetFeature][google.cloud.aiplatform.v1.FeatureRegistryService.GetFeature].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetFeatureRequest {
/// Required. The name of the Feature resource.
/// Format for entity_type as parent:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
/// Format for feature_group as parent:
/// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures].
/// Request message for
/// [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeaturesRequest {
/// Required. The resource name of the Location to list Features.
/// Format for entity_type as parent:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
/// Format for feature_group as parent:
/// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the Features that match the filter expression. The following
/// filters are supported:
///
/// * `value_type`: Supports = and != comparisons.
/// * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must
/// be in RFC 3339 format.
/// * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must
/// be in RFC 3339 format.
/// * `labels`: Supports key-value equality as well as key presence.
///
/// Examples:
///
/// * `value_type = DOUBLE` --> Features whose type is DOUBLE.
/// * `create_time > \"2020-01-31T15:30:00.000000Z\" OR
/// update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created
/// or updated after 2020-01-31T15:30:00.000000Z.
/// * `labels.active = yes AND labels.env = prod` --> Features having both
/// (active: yes) and (env: prod) labels.
/// * `labels.env: *` --> Any Feature which has a label with 'env' as the
/// key.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of Features to return. The service may return fewer
/// than this value. If unspecified, at most 1000 Features will be returned.
/// The maximum value is 1000; any value greater than 1000 will be coerced to
/// 1000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
/// call or
/// [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
/// or
/// [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
/// Supported fields:
///
/// * `feature_id`
/// * `value_type` (Not supported for FeatureRegistry Feature)
/// * `create_time`
/// * `update_time`
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "6")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Only applicable for Vertex AI Feature Store (Legacy).
/// If set, return the most recent
/// [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count]
/// of stats for each Feature in response. Valid value is \[0, 10\]. If number of
/// stats exists <
/// [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count],
/// return all existing stats.
#[prost(int32, tag = "7")]
pub latest_stats_count: i32,
}
/// Response message for
/// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures].
/// Response message for
/// [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeaturesResponse {
/// The Features matching the request.
#[prost(message, repeated, tag = "1")]
pub features: ::prost::alloc::vec::Vec<Feature>,
/// A token, which can be sent as
/// [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1.ListFeaturesRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchFeaturesRequest {
/// Required. The resource name of the Location to search Features.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub location: ::prost::alloc::string::String,
/// Query string that is a conjunction of field-restricted queries and/or
/// field-restricted filters. Field-restricted queries and filters can be
/// combined using `AND` to form a conjunction.
///
/// A field query is in the form FIELD:QUERY. This implicitly checks if QUERY
/// exists as a substring within Feature's FIELD. The QUERY
/// and the FIELD are converted to a sequence of words (i.e. tokens) for
/// comparison. This is done by:
///
/// * Removing leading/trailing whitespace and tokenizing the search value.
/// Characters that are not one of alphanumeric `\[a-zA-Z0-9\]`, underscore
/// `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated
/// as a wildcard that matches characters within a token.
/// * Ignoring case.
/// * Prepending an asterisk to the first and appending an asterisk to the
/// last token in QUERY.
///
/// A QUERY must be either a singular token or a phrase. A phrase is one or
/// multiple words enclosed in double quotation marks ("). With phrases, the
/// order of the words is important. Words in the phrase must be matching in
/// order and consecutively.
///
/// Supported FIELDs for field-restricted queries:
///
/// * `feature_id`
/// * `description`
/// * `entity_type_id`
///
/// Examples:
///
/// * `feature_id: foo` --> Matches a Feature with ID containing the substring
/// `foo` (eg. `foo`, `foofeature`, `barfoo`).
/// * `feature_id: foo*feature` --> Matches a Feature with ID containing the
/// substring `foo*feature` (eg. `foobarfeature`).
/// * `feature_id: foo AND description: bar` --> Matches a Feature with ID
/// containing the substring `foo` and description containing the substring
/// `bar`.
///
///
/// Besides field queries, the following exact-match filters are
/// supported. The exact-match filters do not support wildcards. Unlike
/// field-restricted queries, exact-match filters are case-sensitive.
///
/// * `feature_id`: Supports = comparisons.
/// * `description`: Supports = comparisons. Multi-token filters should be
/// enclosed in quotes.
/// * `entity_type_id`: Supports = comparisons.
/// * `value_type`: Supports = and != comparisons.
/// * `labels`: Supports key-value equality as well as key presence.
/// * `featurestore_id`: Supports = comparisons.
///
/// Examples:
///
/// * `description = "foo bar"` --> Any Feature with description exactly equal
/// to `foo bar`
/// * `value_type = DOUBLE` --> Features whose type is DOUBLE.
/// * `labels.active = yes AND labels.env = prod` --> Features having both
/// (active: yes) and (env: prod) labels.
/// * `labels.env: *` --> Any Feature which has a label with `env` as the
/// key.
#[prost(string, tag = "3")]
pub query: ::prost::alloc::string::String,
/// The maximum number of Features to return. The service may return fewer
/// than this value. If unspecified, at most 100 Features will be returned.
/// The maximum value is 100; any value greater than 100 will be coerced to
/// 100.
#[prost(int32, tag = "4")]
pub page_size: i32,
/// A page token, received from a previous
/// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures],
/// except `page_size`, must match the call that provided the page token.
#[prost(string, tag = "5")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchFeaturesResponse {
/// The Features matching the request.
///
/// Fields returned:
///
/// * `name`
/// * `description`
/// * `labels`
/// * `create_time`
/// * `update_time`
#[prost(message, repeated, tag = "1")]
pub features: ::prost::alloc::vec::Vec<Feature>,
/// A token, which can be sent as
/// [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1.SearchFeaturesRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature].
/// Request message for
/// [FeatureRegistryService.UpdateFeature][google.cloud.aiplatform.v1.FeatureRegistryService.UpdateFeature].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeatureRequest {
/// Required. The Feature's `name` field is used to identify the Feature to be
/// updated.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
/// `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
#[prost(message, optional, tag = "1")]
pub feature: ::core::option::Option<Feature>,
/// Field mask is used to specify the fields to be overwritten in the
/// Features resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then only the non-empty fields present in the
/// request will be overwritten. Set the update_mask to `*` to override all
/// fields.
///
/// Updatable fields:
///
/// * `description`
/// * `labels`
/// * `disable_monitoring` (Not supported for FeatureRegistryService Feature)
/// * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature].
/// Request message for
/// [FeatureRegistryService.DeleteFeature][google.cloud.aiplatform.v1.FeatureRegistryService.DeleteFeature].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFeatureRequest {
/// Required. The name of the Features to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
/// `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Details of operations that perform create Featurestore.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeaturestoreOperationMetadata {
/// Operation metadata for Featurestore.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform update Featurestore.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeaturestoreOperationMetadata {
/// Operation metadata for Featurestore.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform import Feature values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportFeatureValuesOperationMetadata {
/// Operation metadata for Featurestore import Feature values.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// Number of entities that have been imported by the operation.
#[prost(int64, tag = "2")]
pub imported_entity_count: i64,
/// Number of Feature values that have been imported by the operation.
#[prost(int64, tag = "3")]
pub imported_feature_value_count: i64,
/// The source URI from where Feature values are imported.
#[prost(string, repeated, tag = "4")]
pub source_uris: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The number of rows in input source that weren't imported due to either
/// * Not having any featureValues.
/// * Having a null entityId.
/// * Having a null timestamp.
/// * Not being parsable (applicable for CSV sources).
#[prost(int64, tag = "6")]
pub invalid_row_count: i64,
/// The number rows that weren't ingested due to having timestamps outside the
/// retention boundary.
#[prost(int64, tag = "7")]
pub timestamp_outside_retention_rows_count: i64,
/// List of ImportFeatureValues operations running under a single EntityType
/// that are blocking this operation.
#[prost(int64, repeated, tag = "8")]
pub blocking_operation_ids: ::prost::alloc::vec::Vec<i64>,
}
/// Details of operations that exports Features values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportFeatureValuesOperationMetadata {
/// Operation metadata for Featurestore export Feature values.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that batch reads Feature values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchReadFeatureValuesOperationMetadata {
/// Operation metadata for Featurestore batch read Features values.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that delete Feature values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFeatureValuesOperationMetadata {
/// Operation metadata for Featurestore delete Features values.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform create EntityType.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateEntityTypeOperationMetadata {
/// Operation metadata for EntityType.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform create Feature.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeatureOperationMetadata {
/// Operation metadata for Feature.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform batch create Features.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateFeaturesOperationMetadata {
/// Operation metadata for Feature.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFeatureValuesRequest {
/// Required. The resource name of the EntityType grouping the Features for
/// which values are being deleted from. Format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
#[prost(string, tag = "1")]
pub entity_type: ::prost::alloc::string::String,
/// Defines options to select feature values to be deleted.
#[prost(oneof = "delete_feature_values_request::DeleteOption", tags = "2, 3")]
pub delete_option: ::core::option::Option<
delete_feature_values_request::DeleteOption,
>,
}
/// Nested message and enum types in `DeleteFeatureValuesRequest`.
pub mod delete_feature_values_request {
/// Message to select entity.
/// If an entity id is selected, all the feature values corresponding to the
/// entity id will be deleted, including the entityId.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SelectEntity {
/// Required. Selectors choosing feature values of which entity id to be
/// deleted from the EntityType.
#[prost(message, optional, tag = "1")]
pub entity_id_selector: ::core::option::Option<super::EntityIdSelector>,
}
/// Message to select time range and feature.
/// Values of the selected feature generated within an inclusive time range
/// will be deleted. Using this option permanently deletes the feature values
/// from the specified feature IDs within the specified time range.
/// This might include data from the online storage. If you want to retain
/// any deleted historical data in the online storage, you must re-ingest it.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SelectTimeRangeAndFeature {
/// Required. Select feature generated within a half-inclusive time range.
/// The time range is lower inclusive and upper exclusive.
#[prost(message, optional, tag = "1")]
pub time_range: ::core::option::Option<
super::super::super::super::r#type::Interval,
>,
/// Required. Selectors choosing which feature values to be deleted from the
/// EntityType.
#[prost(message, optional, tag = "2")]
pub feature_selector: ::core::option::Option<super::FeatureSelector>,
/// If set, data will not be deleted from online storage.
/// When time range is older than the data in online storage, setting this to
/// be true will make the deletion have no impact on online serving.
#[prost(bool, tag = "3")]
pub skip_online_storage_delete: bool,
}
/// Defines options to select feature values to be deleted.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum DeleteOption {
/// Select feature values to be deleted by specifying entities.
#[prost(message, tag = "2")]
SelectEntity(SelectEntity),
/// Select feature values to be deleted by specifying time range and
/// features.
#[prost(message, tag = "3")]
SelectTimeRangeAndFeature(SelectTimeRangeAndFeature),
}
}
/// Response message for
/// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DeleteFeatureValuesResponse {
/// Response based on which delete option is specified in the
/// request
#[prost(oneof = "delete_feature_values_response::Response", tags = "1, 2")]
pub response: ::core::option::Option<delete_feature_values_response::Response>,
}
/// Nested message and enum types in `DeleteFeatureValuesResponse`.
pub mod delete_feature_values_response {
/// Response message if the request uses the SelectEntity option.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SelectEntity {
/// The count of deleted entity rows in the offline storage.
/// Each row corresponds to the combination of an entity ID and a timestamp.
/// One entity ID can have multiple rows in the offline storage.
#[prost(int64, tag = "1")]
pub offline_storage_deleted_entity_row_count: i64,
/// The count of deleted entities in the online storage.
/// Each entity ID corresponds to one entity.
#[prost(int64, tag = "2")]
pub online_storage_deleted_entity_count: i64,
}
/// Response message if the request uses the SelectTimeRangeAndFeature option.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SelectTimeRangeAndFeature {
/// The count of the features or columns impacted.
/// This is the same as the feature count in the request.
#[prost(int64, tag = "1")]
pub impacted_feature_count: i64,
/// The count of modified entity rows in the offline storage.
/// Each row corresponds to the combination of an entity ID and a timestamp.
/// One entity ID can have multiple rows in the offline storage.
/// Within each row, only the features specified in the request are
/// deleted.
#[prost(int64, tag = "2")]
pub offline_storage_modified_entity_row_count: i64,
/// The count of modified entities in the online storage.
/// Each entity ID corresponds to one entity.
/// Within each entity, only the features specified in the request are
/// deleted.
#[prost(int64, tag = "3")]
pub online_storage_modified_entity_count: i64,
}
/// Response based on which delete option is specified in the
/// request
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Response {
/// Response for request specifying the entities to delete
#[prost(message, tag = "1")]
SelectEntity(SelectEntity),
/// Response for request specifying time range and feature
#[prost(message, tag = "2")]
SelectTimeRangeAndFeature(SelectTimeRangeAndFeature),
}
}
/// Selector for entityId. Getting ids from the given source.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EntityIdSelector {
/// Source column that holds entity IDs. If not provided, entity IDs are
/// extracted from the column named entity_id.
#[prost(string, tag = "5")]
pub entity_id_field: ::prost::alloc::string::String,
/// Details about the source data, including the location of the storage and
/// the format.
#[prost(oneof = "entity_id_selector::EntityIdsSource", tags = "3")]
pub entity_ids_source: ::core::option::Option<entity_id_selector::EntityIdsSource>,
}
/// Nested message and enum types in `EntityIdSelector`.
pub mod entity_id_selector {
/// Details about the source data, including the location of the storage and
/// the format.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum EntityIdsSource {
/// Source of Csv
#[prost(message, tag = "3")]
CsvSource(super::CsvSource),
}
}
/// Generated client implementations.
pub mod featurestore_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The service that handles CRUD and List for resources for Featurestore.
#[derive(Debug, Clone)]
pub struct FeaturestoreServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> FeaturestoreServiceClient<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,
) -> FeaturestoreServiceClient<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,
{
FeaturestoreServiceClient::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 new Featurestore in a given project and location.
pub async fn create_featurestore(
&mut self,
request: impl tonic::IntoRequest<super::CreateFeaturestoreRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/CreateFeaturestore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"CreateFeaturestore",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single Featurestore.
pub async fn get_featurestore(
&mut self,
request: impl tonic::IntoRequest<super::GetFeaturestoreRequest>,
) -> std::result::Result<tonic::Response<super::Featurestore>, 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.aiplatform.v1.FeaturestoreService/GetFeaturestore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"GetFeaturestore",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Featurestores in a given project and location.
pub async fn list_featurestores(
&mut self,
request: impl tonic::IntoRequest<super::ListFeaturestoresRequest>,
) -> std::result::Result<
tonic::Response<super::ListFeaturestoresResponse>,
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.aiplatform.v1.FeaturestoreService/ListFeaturestores",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"ListFeaturestores",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single Featurestore.
pub async fn update_featurestore(
&mut self,
request: impl tonic::IntoRequest<super::UpdateFeaturestoreRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/UpdateFeaturestore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"UpdateFeaturestore",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single Featurestore. The Featurestore must not contain any
/// EntityTypes or `force` must be set to true for the request to succeed.
pub async fn delete_featurestore(
&mut self,
request: impl tonic::IntoRequest<super::DeleteFeaturestoreRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/DeleteFeaturestore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"DeleteFeaturestore",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new EntityType in a given Featurestore.
pub async fn create_entity_type(
&mut self,
request: impl tonic::IntoRequest<super::CreateEntityTypeRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/CreateEntityType",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"CreateEntityType",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single EntityType.
pub async fn get_entity_type(
&mut self,
request: impl tonic::IntoRequest<super::GetEntityTypeRequest>,
) -> std::result::Result<tonic::Response<super::EntityType>, 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.aiplatform.v1.FeaturestoreService/GetEntityType",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"GetEntityType",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists EntityTypes in a given Featurestore.
pub async fn list_entity_types(
&mut self,
request: impl tonic::IntoRequest<super::ListEntityTypesRequest>,
) -> std::result::Result<
tonic::Response<super::ListEntityTypesResponse>,
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.aiplatform.v1.FeaturestoreService/ListEntityTypes",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"ListEntityTypes",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single EntityType.
pub async fn update_entity_type(
&mut self,
request: impl tonic::IntoRequest<super::UpdateEntityTypeRequest>,
) -> std::result::Result<tonic::Response<super::EntityType>, 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.aiplatform.v1.FeaturestoreService/UpdateEntityType",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"UpdateEntityType",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single EntityType. The EntityType must not have any Features
/// or `force` must be set to true for the request to succeed.
pub async fn delete_entity_type(
&mut self,
request: impl tonic::IntoRequest<super::DeleteEntityTypeRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/DeleteEntityType",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"DeleteEntityType",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new Feature in a given EntityType.
pub async fn create_feature(
&mut self,
request: impl tonic::IntoRequest<super::CreateFeatureRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/CreateFeature",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"CreateFeature",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a batch of Features in a given EntityType.
pub async fn batch_create_features(
&mut self,
request: impl tonic::IntoRequest<super::BatchCreateFeaturesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/BatchCreateFeatures",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"BatchCreateFeatures",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single Feature.
pub async fn get_feature(
&mut self,
request: impl tonic::IntoRequest<super::GetFeatureRequest>,
) -> std::result::Result<tonic::Response<super::Feature>, 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.aiplatform.v1.FeaturestoreService/GetFeature",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"GetFeature",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Features in a given EntityType.
pub async fn list_features(
&mut self,
request: impl tonic::IntoRequest<super::ListFeaturesRequest>,
) -> std::result::Result<
tonic::Response<super::ListFeaturesResponse>,
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.aiplatform.v1.FeaturestoreService/ListFeatures",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"ListFeatures",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single Feature.
pub async fn update_feature(
&mut self,
request: impl tonic::IntoRequest<super::UpdateFeatureRequest>,
) -> std::result::Result<tonic::Response<super::Feature>, 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.aiplatform.v1.FeaturestoreService/UpdateFeature",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"UpdateFeature",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single Feature.
pub async fn delete_feature(
&mut self,
request: impl tonic::IntoRequest<super::DeleteFeatureRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/DeleteFeature",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"DeleteFeature",
),
);
self.inner.unary(req, path, codec).await
}
/// Imports Feature values into the Featurestore from a source storage.
///
/// The progress of the import is tracked by the returned operation. The
/// imported features are guaranteed to be visible to subsequent read
/// operations after the operation is marked as successfully done.
///
/// If an import operation fails, the Feature values returned from
/// reads and exports may be inconsistent. If consistency is
/// required, the caller must retry the same import request again and wait till
/// the new operation returned is marked as successfully done.
///
/// There are also scenarios where the caller can cause inconsistency.
///
/// - Source data for import contains multiple distinct Feature values for
/// the same entity ID and timestamp.
/// - Source is modified during an import. This includes adding, updating, or
/// removing source data and/or metadata. Examples of updating metadata
/// include but are not limited to changing storage location, storage class,
/// or retention policy.
/// - Online serving cluster is under-provisioned.
pub async fn import_feature_values(
&mut self,
request: impl tonic::IntoRequest<super::ImportFeatureValuesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/ImportFeatureValues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"ImportFeatureValues",
),
);
self.inner.unary(req, path, codec).await
}
/// Batch reads Feature values from a Featurestore.
///
/// This API enables batch reading Feature values, where each read
/// instance in the batch may read Feature values of entities from one or
/// more EntityTypes. Point-in-time correctness is guaranteed for Feature
/// values of each read instance as of each instance's read timestamp.
pub async fn batch_read_feature_values(
&mut self,
request: impl tonic::IntoRequest<super::BatchReadFeatureValuesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/BatchReadFeatureValues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"BatchReadFeatureValues",
),
);
self.inner.unary(req, path, codec).await
}
/// Exports Feature values from all the entities of a target EntityType.
pub async fn export_feature_values(
&mut self,
request: impl tonic::IntoRequest<super::ExportFeatureValuesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/ExportFeatureValues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"ExportFeatureValues",
),
);
self.inner.unary(req, path, codec).await
}
/// Delete Feature values from Featurestore.
///
/// The progress of the deletion is tracked by the returned operation. The
/// deleted feature values are guaranteed to be invisible to subsequent read
/// operations after the operation is marked as successfully done.
///
/// If a delete feature values operation fails, the feature values
/// returned from reads and exports may be inconsistent. If consistency is
/// required, the caller must retry the same delete request again and wait till
/// the new operation returned is marked as successfully done.
pub async fn delete_feature_values(
&mut self,
request: impl tonic::IntoRequest<super::DeleteFeatureValuesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeaturestoreService/DeleteFeatureValues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"DeleteFeatureValues",
),
);
self.inner.unary(req, path, codec).await
}
/// Searches Features matching a query in a given project.
pub async fn search_features(
&mut self,
request: impl tonic::IntoRequest<super::SearchFeaturesRequest>,
) -> std::result::Result<
tonic::Response<super::SearchFeaturesResponse>,
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.aiplatform.v1.FeaturestoreService/SearchFeatures",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreService",
"SearchFeatures",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for
/// [FeatureRegistryService.CreateFeatureGroup][google.cloud.aiplatform.v1.FeatureRegistryService.CreateFeatureGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeatureGroupRequest {
/// Required. The resource name of the Location to create FeatureGroups.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The FeatureGroup to create.
#[prost(message, optional, tag = "2")]
pub feature_group: ::core::option::Option<FeatureGroup>,
/// Required. The ID to use for this FeatureGroup, which will become the final
/// component of the FeatureGroup's resource name.
///
/// This value may be up to 60 characters, and valid characters are
/// `\[a-z0-9_\]`. The first character cannot be a number.
///
/// The value must be unique within the project and location.
#[prost(string, tag = "3")]
pub feature_group_id: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureRegistryService.GetFeatureGroup][google.cloud.aiplatform.v1.FeatureRegistryService.GetFeatureGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetFeatureGroupRequest {
/// Required. The name of the FeatureGroup resource.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureRegistryService.ListFeatureGroups][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatureGroups].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeatureGroupsRequest {
/// Required. The resource name of the Location to list FeatureGroups.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the FeatureGroups that match the filter expression. The
/// following fields are supported:
///
/// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be
/// in RFC 3339 format.
/// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be
/// in RFC 3339 format.
/// * `labels`: Supports key-value equality and key presence.
///
/// Examples:
///
/// * `create_time > "2020-01-01" OR update_time > "2020-01-01"`
/// FeatureGroups created or updated after 2020-01-01.
/// * `labels.env = "prod"`
/// FeatureGroups with label "env" set to "prod".
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of FeatureGroups to return. The service may return
/// fewer than this value. If unspecified, at most 100 FeatureGroups will
/// be returned. The maximum value is 100; any value greater than 100 will be
/// coerced to 100.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [FeatureGroupAdminService.ListFeatureGroups][] call.
/// Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [FeatureGroupAdminService.ListFeatureGroups][] must
/// match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
/// Supported Fields:
///
/// * `create_time`
/// * `update_time`
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [FeatureRegistryService.ListFeatureGroups][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatureGroups].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeatureGroupsResponse {
/// The FeatureGroups matching the request.
#[prost(message, repeated, tag = "1")]
pub feature_groups: ::prost::alloc::vec::Vec<FeatureGroup>,
/// A token, which can be sent as
/// [ListFeatureGroupsRequest.page_token][google.cloud.aiplatform.v1.ListFeatureGroupsRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureRegistryService.UpdateFeatureGroup][google.cloud.aiplatform.v1.FeatureRegistryService.UpdateFeatureGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeatureGroupRequest {
/// Required. The FeatureGroup's `name` field is used to identify the
/// FeatureGroup to be updated. Format:
/// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
#[prost(message, optional, tag = "1")]
pub feature_group: ::core::option::Option<FeatureGroup>,
/// Field mask is used to specify the fields to be overwritten in the
/// FeatureGroup resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then only the non-empty fields present in the
/// request will be overwritten. Set the update_mask to `*` to override all
/// fields.
///
/// Updatable fields:
///
/// * `labels`
/// * `description`
/// * `big_query`
/// * `big_query.entity_id_columns`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [FeatureRegistryService.DeleteFeatureGroup][google.cloud.aiplatform.v1.FeatureRegistryService.DeleteFeatureGroup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFeatureGroupRequest {
/// Required. The name of the FeatureGroup to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/featureGroups/{feature_group}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// If set to true, any Features under this FeatureGroup
/// will also be deleted. (Otherwise, the request will only work if the
/// FeatureGroup has no Features.)
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Details of operations that perform create FeatureGroup.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeatureGroupOperationMetadata {
/// Operation metadata for FeatureGroup.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform update FeatureGroup.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeatureGroupOperationMetadata {
/// Operation metadata for FeatureGroup.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform create FeatureGroup.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateRegistryFeatureOperationMetadata {
/// Operation metadata for Feature.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform update Feature.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeatureOperationMetadata {
/// Operation metadata for Feature Update.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Generated client implementations.
pub mod feature_registry_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The service that handles CRUD and List for resources for
/// FeatureRegistry.
#[derive(Debug, Clone)]
pub struct FeatureRegistryServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> FeatureRegistryServiceClient<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,
) -> FeatureRegistryServiceClient<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,
{
FeatureRegistryServiceClient::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 new FeatureGroup in a given project and location.
pub async fn create_feature_group(
&mut self,
request: impl tonic::IntoRequest<super::CreateFeatureGroupRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureRegistryService/CreateFeatureGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"CreateFeatureGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single FeatureGroup.
pub async fn get_feature_group(
&mut self,
request: impl tonic::IntoRequest<super::GetFeatureGroupRequest>,
) -> std::result::Result<tonic::Response<super::FeatureGroup>, 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.aiplatform.v1.FeatureRegistryService/GetFeatureGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"GetFeatureGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists FeatureGroups in a given project and location.
pub async fn list_feature_groups(
&mut self,
request: impl tonic::IntoRequest<super::ListFeatureGroupsRequest>,
) -> std::result::Result<
tonic::Response<super::ListFeatureGroupsResponse>,
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.aiplatform.v1.FeatureRegistryService/ListFeatureGroups",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"ListFeatureGroups",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single FeatureGroup.
pub async fn update_feature_group(
&mut self,
request: impl tonic::IntoRequest<super::UpdateFeatureGroupRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureRegistryService/UpdateFeatureGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"UpdateFeatureGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single FeatureGroup.
pub async fn delete_feature_group(
&mut self,
request: impl tonic::IntoRequest<super::DeleteFeatureGroupRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureRegistryService/DeleteFeatureGroup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"DeleteFeatureGroup",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new Feature in a given FeatureGroup.
pub async fn create_feature(
&mut self,
request: impl tonic::IntoRequest<super::CreateFeatureRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureRegistryService/CreateFeature",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"CreateFeature",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single Feature.
pub async fn get_feature(
&mut self,
request: impl tonic::IntoRequest<super::GetFeatureRequest>,
) -> std::result::Result<tonic::Response<super::Feature>, 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.aiplatform.v1.FeatureRegistryService/GetFeature",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"GetFeature",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Features in a given FeatureGroup.
pub async fn list_features(
&mut self,
request: impl tonic::IntoRequest<super::ListFeaturesRequest>,
) -> std::result::Result<
tonic::Response<super::ListFeaturesResponse>,
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.aiplatform.v1.FeatureRegistryService/ListFeatures",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"ListFeatures",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single Feature.
pub async fn update_feature(
&mut self,
request: impl tonic::IntoRequest<super::UpdateFeatureRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureRegistryService/UpdateFeature",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"UpdateFeature",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single Feature.
pub async fn delete_feature(
&mut self,
request: impl tonic::IntoRequest<super::DeleteFeatureRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureRegistryService/DeleteFeature",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureRegistryService",
"DeleteFeature",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Points to a DeployedIndex.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployedIndexRef {
/// Immutable. A resource name of the IndexEndpoint.
#[prost(string, tag = "1")]
pub index_endpoint: ::prost::alloc::string::String,
/// Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
#[prost(string, tag = "2")]
pub deployed_index_id: ::prost::alloc::string::String,
/// Output only. The display name of the DeployedIndex.
#[prost(string, tag = "3")]
pub display_name: ::prost::alloc::string::String,
}
/// A representation of a collection of database items organized in a way that
/// allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Index {
/// Output only. The resource name of the Index.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The display name of the Index.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The description of the Index.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Immutable. Points to a YAML file stored on Google Cloud Storage describing
/// additional information about the Index, that is specific to it. Unset if
/// the Index does not have any additional information. The schema is defined
/// as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// Note: The URI given on output will be immutable and probably different,
/// including the URI scheme, than the one given on input. The output URI will
/// point to a location where the user only has a read access.
#[prost(string, tag = "4")]
pub metadata_schema_uri: ::prost::alloc::string::String,
/// An additional information about the Index; the schema of the metadata can
/// be found in
/// [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri].
#[prost(message, optional, tag = "6")]
pub metadata: ::core::option::Option<::prost_types::Value>,
/// Output only. The pointers to DeployedIndexes created from this Index.
/// An Index can be only deleted if all its DeployedIndexes had been undeployed
/// first.
#[prost(message, repeated, tag = "7")]
pub deployed_indexes: ::prost::alloc::vec::Vec<DeployedIndexRef>,
/// Used to perform consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "8")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize your Indexes.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "9")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this Index was created.
#[prost(message, optional, tag = "10")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Index was most recently updated.
/// This also includes any update to the contents of the Index.
/// Note that Operations working on this Index may have their
/// \[Operations.metadata.generic_metadata.update_time\]
/// \[google.cloud.aiplatform.v1.GenericOperationMetadata.update_time\] a little
/// after the value of this timestamp, yet that does not mean their results are
/// not already reflected in the Index. Result of any successfully completed
/// Operation on the Index is reflected in it.
#[prost(message, optional, tag = "11")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Stats of the index resource.
#[prost(message, optional, tag = "14")]
pub index_stats: ::core::option::Option<IndexStats>,
/// Immutable. The update method to use with this Index. If not set,
/// BATCH_UPDATE will be used by default.
#[prost(enumeration = "index::IndexUpdateMethod", tag = "16")]
pub index_update_method: i32,
/// Immutable. Customer-managed encryption key spec for an Index. If set, this
/// Index and all sub-resources of this Index will be secured by this key.
#[prost(message, optional, tag = "17")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "18")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "19")]
pub satisfies_pzi: bool,
}
/// Nested message and enum types in `Index`.
pub mod index {
/// The update method of an Index.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum IndexUpdateMethod {
/// Should not be used.
Unspecified = 0,
/// BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
/// Datapoints to update.
BatchUpdate = 1,
/// StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
/// the Index and the updates will be applied in corresponding
/// DeployedIndexes in nearly real-time.
StreamUpdate = 2,
}
impl IndexUpdateMethod {
/// 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 {
IndexUpdateMethod::Unspecified => "INDEX_UPDATE_METHOD_UNSPECIFIED",
IndexUpdateMethod::BatchUpdate => "BATCH_UPDATE",
IndexUpdateMethod::StreamUpdate => "STREAM_UPDATE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INDEX_UPDATE_METHOD_UNSPECIFIED" => Some(Self::Unspecified),
"BATCH_UPDATE" => Some(Self::BatchUpdate),
"STREAM_UPDATE" => Some(Self::StreamUpdate),
_ => None,
}
}
}
}
/// A datapoint of Index.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IndexDatapoint {
/// Required. Unique identifier of the datapoint.
#[prost(string, tag = "1")]
pub datapoint_id: ::prost::alloc::string::String,
/// Required. Feature embedding vector for dense index. An array of numbers
/// with the length of \[NearestNeighborSearchConfig.dimensions\].
#[prost(float, repeated, packed = "false", tag = "2")]
pub feature_vector: ::prost::alloc::vec::Vec<f32>,
/// Optional. Feature embedding vector for sparse index.
#[prost(message, optional, tag = "7")]
pub sparse_embedding: ::core::option::Option<index_datapoint::SparseEmbedding>,
/// Optional. List of Restrict of the datapoint, used to perform "restricted
/// searches" where boolean rule are used to filter the subset of the database
/// eligible for matching. This uses categorical tokens. See:
/// <https://cloud.google.com/vertex-ai/docs/matching-engine/filtering>
#[prost(message, repeated, tag = "4")]
pub restricts: ::prost::alloc::vec::Vec<index_datapoint::Restriction>,
/// Optional. List of Restrict of the datapoint, used to perform "restricted
/// searches" where boolean rule are used to filter the subset of the database
/// eligible for matching. This uses numeric comparisons.
#[prost(message, repeated, tag = "6")]
pub numeric_restricts: ::prost::alloc::vec::Vec<index_datapoint::NumericRestriction>,
/// Optional. CrowdingTag of the datapoint, the number of neighbors to return
/// in each crowding can be configured during query.
#[prost(message, optional, tag = "5")]
pub crowding_tag: ::core::option::Option<index_datapoint::CrowdingTag>,
}
/// Nested message and enum types in `IndexDatapoint`.
pub mod index_datapoint {
/// Feature embedding vector for sparse index. An array of numbers whose values
/// are located in the specified dimensions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SparseEmbedding {
/// Required. The list of embedding values of the sparse vector.
#[prost(float, repeated, packed = "false", tag = "1")]
pub values: ::prost::alloc::vec::Vec<f32>,
/// Required. The list of indexes for the embedding values of the sparse
/// vector.
#[prost(int64, repeated, packed = "false", tag = "2")]
pub dimensions: ::prost::alloc::vec::Vec<i64>,
}
/// Restriction of a datapoint which describe its attributes(tokens) from each
/// of several attribute categories(namespaces).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Restriction {
/// The namespace of this restriction. e.g.: color.
#[prost(string, tag = "1")]
pub namespace: ::prost::alloc::string::String,
/// The attributes to allow in this namespace. e.g.: 'red'
#[prost(string, repeated, tag = "2")]
pub allow_list: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The attributes to deny in this namespace. e.g.: 'blue'
#[prost(string, repeated, tag = "3")]
pub deny_list: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// This field allows restricts to be based on numeric comparisons rather
/// than categorical tokens.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NumericRestriction {
/// The namespace of this restriction. e.g.: cost.
#[prost(string, tag = "1")]
pub namespace: ::prost::alloc::string::String,
/// This MUST be specified for queries and must NOT be specified for
/// datapoints.
#[prost(enumeration = "numeric_restriction::Operator", tag = "5")]
pub op: i32,
/// The type of Value must be consistent for all datapoints with a given
/// namespace name. This is verified at runtime.
#[prost(oneof = "numeric_restriction::Value", tags = "2, 3, 4")]
pub value: ::core::option::Option<numeric_restriction::Value>,
}
/// Nested message and enum types in `NumericRestriction`.
pub mod numeric_restriction {
/// Which comparison operator to use. Should be specified for queries only;
/// specifying this for a datapoint is an error.
///
/// Datapoints for which Operator is true relative to the query's Value
/// field will be allowlisted.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Operator {
/// Default value of the enum.
Unspecified = 0,
/// Datapoints are eligible iff their value is < the query's.
Less = 1,
/// Datapoints are eligible iff their value is <= the query's.
LessEqual = 2,
/// Datapoints are eligible iff their value is == the query's.
Equal = 3,
/// Datapoints are eligible iff their value is >= the query's.
GreaterEqual = 4,
/// Datapoints are eligible iff their value is > the query's.
Greater = 5,
/// Datapoints are eligible iff their value is != the query's.
NotEqual = 6,
}
impl Operator {
/// 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 {
Operator::Unspecified => "OPERATOR_UNSPECIFIED",
Operator::Less => "LESS",
Operator::LessEqual => "LESS_EQUAL",
Operator::Equal => "EQUAL",
Operator::GreaterEqual => "GREATER_EQUAL",
Operator::Greater => "GREATER",
Operator::NotEqual => "NOT_EQUAL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPERATOR_UNSPECIFIED" => Some(Self::Unspecified),
"LESS" => Some(Self::Less),
"LESS_EQUAL" => Some(Self::LessEqual),
"EQUAL" => Some(Self::Equal),
"GREATER_EQUAL" => Some(Self::GreaterEqual),
"GREATER" => Some(Self::Greater),
"NOT_EQUAL" => Some(Self::NotEqual),
_ => None,
}
}
}
/// The type of Value must be consistent for all datapoints with a given
/// namespace name. This is verified at runtime.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Value {
/// Represents 64 bit integer.
#[prost(int64, tag = "2")]
ValueInt(i64),
/// Represents 32 bit float.
#[prost(float, tag = "3")]
ValueFloat(f32),
/// Represents 64 bit float.
#[prost(double, tag = "4")]
ValueDouble(f64),
}
}
/// Crowding tag is a constraint on a neighbor list produced by nearest
/// neighbor search requiring that no more than some value k' of the k
/// neighbors returned have the same value of crowding_attribute.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CrowdingTag {
/// The attribute value used for crowding. The maximum number of neighbors
/// to return per crowding attribute value
/// (per_crowding_attribute_num_neighbors) is configured per-query. This
/// field is ignored if per_crowding_attribute_num_neighbors is larger than
/// the total number of neighbors to return for a given query.
#[prost(string, tag = "1")]
pub crowding_attribute: ::prost::alloc::string::String,
}
}
/// Stats of the Index.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct IndexStats {
/// Output only. The number of dense vectors in the Index.
#[prost(int64, tag = "1")]
pub vectors_count: i64,
/// Output only. The number of sparse vectors in the Index.
#[prost(int64, tag = "3")]
pub sparse_vectors_count: i64,
/// Output only. The number of shards in the Index.
#[prost(int32, tag = "2")]
pub shards_count: i32,
}
/// The request message for
/// [MatchService.FindNeighbors][google.cloud.aiplatform.v1.MatchService.FindNeighbors].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FindNeighborsRequest {
/// Required. The name of the index endpoint.
/// Format:
/// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
#[prost(string, tag = "1")]
pub index_endpoint: ::prost::alloc::string::String,
/// The ID of the DeployedIndex that will serve the request. This request is
/// sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
/// IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
/// has a DeployedIndex.id field.
/// The value of the field below must equal one of the DeployedIndex.id
/// fields of the IndexEndpoint that is being called for this request.
#[prost(string, tag = "2")]
pub deployed_index_id: ::prost::alloc::string::String,
/// The list of queries.
#[prost(message, repeated, tag = "3")]
pub queries: ::prost::alloc::vec::Vec<find_neighbors_request::Query>,
/// If set to true, the full datapoints (including all vector values and
/// restricts) of the nearest neighbors are returned.
/// Note that returning full datapoint will significantly increase the
/// latency and cost of the query.
#[prost(bool, tag = "4")]
pub return_full_datapoint: bool,
}
/// Nested message and enum types in `FindNeighborsRequest`.
pub mod find_neighbors_request {
/// A query to find a number of the nearest neighbors (most similar vectors)
/// of a vector.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Query {
/// Required. The datapoint/vector whose nearest neighbors should be searched
/// for.
#[prost(message, optional, tag = "1")]
pub datapoint: ::core::option::Option<super::IndexDatapoint>,
/// The number of nearest neighbors to be retrieved from database for each
/// query. If not set, will use the default from the service configuration
/// (<https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config>).
#[prost(int32, tag = "2")]
pub neighbor_count: i32,
/// Crowding is a constraint on a neighbor list produced by nearest neighbor
/// search requiring that no more than some value k' of the k neighbors
/// returned have the same value of crowding_attribute.
/// It's used for improving result diversity.
/// This field is the maximum number of matches with the same crowding tag.
#[prost(int32, tag = "3")]
pub per_crowding_attribute_neighbor_count: i32,
/// The number of neighbors to find via approximate search before
/// exact reordering is performed. If not set, the default value from scam
/// config is used; if set, this value must be > 0.
#[prost(int32, tag = "4")]
pub approximate_neighbor_count: i32,
/// The fraction of the number of leaves to search, set at query time allows
/// user to tune search performance. This value increase result in both
/// search accuracy and latency increase. The value should be between 0.0
/// and 1.0. If not set or set to 0.0, query uses the default value specified
/// in
/// NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
#[prost(double, tag = "5")]
pub fraction_leaf_nodes_to_search_override: f64,
#[prost(oneof = "query::Ranking", tags = "6")]
pub ranking: ::core::option::Option<query::Ranking>,
}
/// Nested message and enum types in `Query`.
pub mod query {
/// Parameters for RRF algorithm that combines search results.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Rrf {
/// Required. Users can provide an alpha value to give more weight to dense
/// vs sparse results. For example, if the alpha is 0, we only return
/// sparse and if the alpha is 1, we only return dense.
#[prost(float, tag = "1")]
pub alpha: f32,
}
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Ranking {
/// Optional. Represents RRF algorithm that combines search results.
#[prost(message, tag = "6")]
Rrf(Rrf),
}
}
}
/// The response message for
/// [MatchService.FindNeighbors][google.cloud.aiplatform.v1.MatchService.FindNeighbors].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FindNeighborsResponse {
/// The nearest neighbors of the query datapoints.
#[prost(message, repeated, tag = "1")]
pub nearest_neighbors: ::prost::alloc::vec::Vec<
find_neighbors_response::NearestNeighbors,
>,
}
/// Nested message and enum types in `FindNeighborsResponse`.
pub mod find_neighbors_response {
/// A neighbor of the query vector.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Neighbor {
/// The datapoint of the neighbor.
/// Note that full datapoints are returned only when "return_full_datapoint"
/// is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
/// fields are populated.
#[prost(message, optional, tag = "1")]
pub datapoint: ::core::option::Option<super::IndexDatapoint>,
/// The distance between the neighbor and the dense embedding query.
#[prost(double, tag = "2")]
pub distance: f64,
/// The distance between the neighbor and the query sparse_embedding.
#[prost(double, tag = "3")]
pub sparse_distance: f64,
}
/// Nearest neighbors for one query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NearestNeighbors {
/// The ID of the query datapoint.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// All its neighbors.
#[prost(message, repeated, tag = "2")]
pub neighbors: ::prost::alloc::vec::Vec<Neighbor>,
}
}
/// The request message for
/// [MatchService.ReadIndexDatapoints][google.cloud.aiplatform.v1.MatchService.ReadIndexDatapoints].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadIndexDatapointsRequest {
/// Required. The name of the index endpoint.
/// Format:
/// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
#[prost(string, tag = "1")]
pub index_endpoint: ::prost::alloc::string::String,
/// The ID of the DeployedIndex that will serve the request.
#[prost(string, tag = "2")]
pub deployed_index_id: ::prost::alloc::string::String,
/// IDs of the datapoints to be searched for.
#[prost(string, repeated, tag = "3")]
pub ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// The response message for
/// [MatchService.ReadIndexDatapoints][google.cloud.aiplatform.v1.MatchService.ReadIndexDatapoints].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadIndexDatapointsResponse {
/// The result list of datapoints.
#[prost(message, repeated, tag = "1")]
pub datapoints: ::prost::alloc::vec::Vec<IndexDatapoint>,
}
/// Generated client implementations.
pub mod match_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// MatchService is a Google managed service for efficient vector similarity
/// search at scale.
#[derive(Debug, Clone)]
pub struct MatchServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> MatchServiceClient<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,
) -> MatchServiceClient<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,
{
MatchServiceClient::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
}
/// Finds the nearest neighbors of each vector within the request.
pub async fn find_neighbors(
&mut self,
request: impl tonic::IntoRequest<super::FindNeighborsRequest>,
) -> std::result::Result<
tonic::Response<super::FindNeighborsResponse>,
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.aiplatform.v1.MatchService/FindNeighbors",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MatchService",
"FindNeighbors",
),
);
self.inner.unary(req, path, codec).await
}
/// Reads the datapoints/vectors of the given IDs.
/// A maximum of 1000 datapoints can be retrieved in a batch.
pub async fn read_index_datapoints(
&mut self,
request: impl tonic::IntoRequest<super::ReadIndexDatapointsRequest>,
) -> std::result::Result<
tonic::Response<super::ReadIndexDatapointsResponse>,
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.aiplatform.v1.MatchService/ReadIndexDatapoints",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MatchService",
"ReadIndexDatapoints",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// A list of boolean values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BoolArray {
/// A list of bool values.
#[prost(bool, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<bool>,
}
/// A list of double values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DoubleArray {
/// A list of double values.
#[prost(double, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<f64>,
}
/// A list of int64 values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Int64Array {
/// A list of int64 values.
#[prost(int64, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<i64>,
}
/// A list of string values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StringArray {
/// A list of string values.
#[prost(string, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// A tensor value type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Tensor {
/// The data type of tensor.
#[prost(enumeration = "tensor::DataType", tag = "1")]
pub dtype: i32,
/// Shape of the tensor.
#[prost(int64, repeated, tag = "2")]
pub shape: ::prost::alloc::vec::Vec<i64>,
/// Type specific representations that make it easy to create tensor protos in
/// all languages. Only the representation corresponding to "dtype" can
/// be set. The values hold the flattened representation of the tensor in
/// row major order.
///
/// [BOOL][google.aiplatform.master.Tensor.DataType.BOOL]
#[prost(bool, repeated, tag = "3")]
pub bool_val: ::prost::alloc::vec::Vec<bool>,
/// [STRING][google.aiplatform.master.Tensor.DataType.STRING]
#[prost(string, repeated, tag = "14")]
pub string_val: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// [STRING][google.aiplatform.master.Tensor.DataType.STRING]
#[prost(bytes = "bytes", repeated, tag = "15")]
pub bytes_val: ::prost::alloc::vec::Vec<::prost::bytes::Bytes>,
/// [FLOAT][google.aiplatform.master.Tensor.DataType.FLOAT]
#[prost(float, repeated, tag = "5")]
pub float_val: ::prost::alloc::vec::Vec<f32>,
/// [DOUBLE][google.aiplatform.master.Tensor.DataType.DOUBLE]
#[prost(double, repeated, tag = "6")]
pub double_val: ::prost::alloc::vec::Vec<f64>,
/// [INT_8][google.aiplatform.master.Tensor.DataType.INT8]
/// [INT_16][google.aiplatform.master.Tensor.DataType.INT16]
/// [INT_32][google.aiplatform.master.Tensor.DataType.INT32]
#[prost(int32, repeated, tag = "7")]
pub int_val: ::prost::alloc::vec::Vec<i32>,
/// [INT64][google.aiplatform.master.Tensor.DataType.INT64]
#[prost(int64, repeated, tag = "8")]
pub int64_val: ::prost::alloc::vec::Vec<i64>,
/// [UINT8][google.aiplatform.master.Tensor.DataType.UINT8]
/// [UINT16][google.aiplatform.master.Tensor.DataType.UINT16]
/// [UINT32][google.aiplatform.master.Tensor.DataType.UINT32]
#[prost(uint32, repeated, tag = "9")]
pub uint_val: ::prost::alloc::vec::Vec<u32>,
/// [UINT64][google.aiplatform.master.Tensor.DataType.UINT64]
#[prost(uint64, repeated, tag = "10")]
pub uint64_val: ::prost::alloc::vec::Vec<u64>,
/// A list of tensor values.
#[prost(message, repeated, tag = "11")]
pub list_val: ::prost::alloc::vec::Vec<Tensor>,
/// A map of string to tensor.
#[prost(btree_map = "string, message", tag = "12")]
pub struct_val: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
Tensor,
>,
/// Serialized raw tensor content.
#[prost(bytes = "bytes", tag = "13")]
pub tensor_val: ::prost::bytes::Bytes,
}
/// Nested message and enum types in `Tensor`.
pub mod tensor {
/// Data type of the tensor.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DataType {
/// Not a legal value for DataType. Used to indicate a DataType field has not
/// been set.
Unspecified = 0,
/// Data types that all computation devices are expected to be
/// capable to support.
Bool = 1,
String = 2,
Float = 3,
Double = 4,
Int8 = 5,
Int16 = 6,
Int32 = 7,
Int64 = 8,
Uint8 = 9,
Uint16 = 10,
Uint32 = 11,
Uint64 = 12,
}
impl DataType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
DataType::Unspecified => "DATA_TYPE_UNSPECIFIED",
DataType::Bool => "BOOL",
DataType::String => "STRING",
DataType::Float => "FLOAT",
DataType::Double => "DOUBLE",
DataType::Int8 => "INT8",
DataType::Int16 => "INT16",
DataType::Int32 => "INT32",
DataType::Int64 => "INT64",
DataType::Uint8 => "UINT8",
DataType::Uint16 => "UINT16",
DataType::Uint32 => "UINT32",
DataType::Uint64 => "UINT64",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DATA_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"BOOL" => Some(Self::Bool),
"STRING" => Some(Self::String),
"FLOAT" => Some(Self::Float),
"DOUBLE" => Some(Self::Double),
"INT8" => Some(Self::Int8),
"INT16" => Some(Self::Int16),
"INT32" => Some(Self::Int32),
"INT64" => Some(Self::Int64),
"UINT8" => Some(Self::Uint8),
"UINT16" => Some(Self::Uint16),
"UINT32" => Some(Self::Uint32),
"UINT64" => Some(Self::Uint64),
_ => None,
}
}
}
}
/// Request message for
/// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WriteFeatureValuesRequest {
/// Required. The resource name of the EntityType for the entities being
/// written. Value format:
/// `projects/{project}/locations/{location}/featurestores/
/// {featurestore}/entityTypes/{entityType}`. For example,
/// for a machine learning model predicting user clicks on a website, an
/// EntityType ID could be `user`.
#[prost(string, tag = "1")]
pub entity_type: ::prost::alloc::string::String,
/// Required. The entities to be written. Up to 100,000 feature values can be
/// written across all `payloads`.
#[prost(message, repeated, tag = "2")]
pub payloads: ::prost::alloc::vec::Vec<WriteFeatureValuesPayload>,
}
/// Contains Feature values to be written for a specific entity.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WriteFeatureValuesPayload {
/// Required. The ID of the entity.
#[prost(string, tag = "1")]
pub entity_id: ::prost::alloc::string::String,
/// Required. Feature values to be written, mapping from Feature ID to value.
/// Up to 100,000 `feature_values` entries may be written across all payloads.
/// The feature generation time, aligned by days, must be no older than five
/// years (1825 days) and no later than one year (366 days) in the future.
#[prost(btree_map = "string, message", tag = "2")]
pub feature_values: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
FeatureValue,
>,
}
/// Response message for
/// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct WriteFeatureValuesResponse {}
/// Request message for
/// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadFeatureValuesRequest {
/// Required. The resource name of the EntityType for the entity being read.
/// Value format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
/// For example, for a machine learning model predicting user clicks on a
/// website, an EntityType ID could be `user`.
#[prost(string, tag = "1")]
pub entity_type: ::prost::alloc::string::String,
/// Required. ID for a specific entity. For example,
/// for a machine learning model predicting user clicks on a website, an entity
/// ID could be `user_123`.
#[prost(string, tag = "2")]
pub entity_id: ::prost::alloc::string::String,
/// Required. Selector choosing Features of the target EntityType.
#[prost(message, optional, tag = "3")]
pub feature_selector: ::core::option::Option<FeatureSelector>,
}
/// Response message for
/// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadFeatureValuesResponse {
/// Response header.
#[prost(message, optional, tag = "1")]
pub header: ::core::option::Option<read_feature_values_response::Header>,
/// Entity view with Feature values. This may be the entity in the
/// Featurestore if values for all Features were requested, or a projection
/// of the entity in the Featurestore if values for only some Features were
/// requested.
#[prost(message, optional, tag = "2")]
pub entity_view: ::core::option::Option<read_feature_values_response::EntityView>,
}
/// Nested message and enum types in `ReadFeatureValuesResponse`.
pub mod read_feature_values_response {
/// Metadata for requested Features.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureDescriptor {
/// Feature ID.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
}
/// Response header with metadata for the requested
/// [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1.ReadFeatureValuesRequest.entity_type]
/// and Features.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Header {
/// The resource name of the EntityType from the
/// [ReadFeatureValuesRequest][google.cloud.aiplatform.v1.ReadFeatureValuesRequest].
/// Value format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
#[prost(string, tag = "1")]
pub entity_type: ::prost::alloc::string::String,
/// List of Feature metadata corresponding to each piece of
/// [ReadFeatureValuesResponse.EntityView.data][google.cloud.aiplatform.v1.ReadFeatureValuesResponse.EntityView.data].
#[prost(message, repeated, tag = "2")]
pub feature_descriptors: ::prost::alloc::vec::Vec<FeatureDescriptor>,
}
/// Entity view with Feature values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EntityView {
/// ID of the requested entity.
#[prost(string, tag = "1")]
pub entity_id: ::prost::alloc::string::String,
/// Each piece of data holds the k
/// requested values for one requested Feature. If no values
/// for the requested Feature exist, the corresponding cell will be empty.
/// This has the same size and is in the same order as the features from the
/// header
/// [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1.ReadFeatureValuesResponse.header].
#[prost(message, repeated, tag = "2")]
pub data: ::prost::alloc::vec::Vec<entity_view::Data>,
}
/// Nested message and enum types in `EntityView`.
pub mod entity_view {
/// Container to hold value(s), successive in time, for one Feature from the
/// request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Data {
#[prost(oneof = "data::Data", tags = "1, 2")]
pub data: ::core::option::Option<data::Data>,
}
/// Nested message and enum types in `Data`.
pub mod data {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Data {
/// Feature value if a single value is requested.
#[prost(message, tag = "1")]
Value(super::super::super::FeatureValue),
/// Feature values list if values, successive in time, are requested.
/// If the requested number of values is greater than the number of
/// existing Feature values, nonexistent values are omitted instead of
/// being returned as empty.
#[prost(message, tag = "2")]
Values(super::super::super::FeatureValueList),
}
}
}
}
/// Request message for
/// [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingReadFeatureValuesRequest {
/// Required. The resource name of the entities' type.
/// Value format:
/// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
/// For example,
/// for a machine learning model predicting user clicks on a website, an
/// EntityType ID could be `user`.
#[prost(string, tag = "1")]
pub entity_type: ::prost::alloc::string::String,
/// Required. IDs of entities to read Feature values of. The maximum number of
/// IDs is 100. For example, for a machine learning model predicting user
/// clicks on a website, an entity ID could be `user_123`.
#[prost(string, repeated, tag = "2")]
pub entity_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Required. Selector choosing Features of the target EntityType. Feature IDs
/// will be deduplicated.
#[prost(message, optional, tag = "3")]
pub feature_selector: ::core::option::Option<FeatureSelector>,
}
/// Value for a feature.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureValue {
/// Metadata of feature value.
#[prost(message, optional, tag = "14")]
pub metadata: ::core::option::Option<feature_value::Metadata>,
/// Value for the feature.
#[prost(oneof = "feature_value::Value", tags = "1, 2, 5, 6, 7, 8, 11, 12, 13, 15")]
pub value: ::core::option::Option<feature_value::Value>,
}
/// Nested message and enum types in `FeatureValue`.
pub mod feature_value {
/// Metadata of feature value.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Metadata {
/// Feature generation timestamp. Typically, it is provided by user at
/// feature ingestion time. If not, feature store
/// will use the system timestamp when the data is ingested into feature
/// store. For streaming ingestion, the time, aligned by days, must be no
/// older than five years (1825 days) and no later than one year (366 days)
/// in the future.
#[prost(message, optional, tag = "1")]
pub generate_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Value for the feature.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Value {
/// Bool type feature value.
#[prost(bool, tag = "1")]
BoolValue(bool),
/// Double type feature value.
#[prost(double, tag = "2")]
DoubleValue(f64),
/// Int64 feature value.
#[prost(int64, tag = "5")]
Int64Value(i64),
/// String feature value.
#[prost(string, tag = "6")]
StringValue(::prost::alloc::string::String),
/// A list of bool type feature value.
#[prost(message, tag = "7")]
BoolArrayValue(super::BoolArray),
/// A list of double type feature value.
#[prost(message, tag = "8")]
DoubleArrayValue(super::DoubleArray),
/// A list of int64 type feature value.
#[prost(message, tag = "11")]
Int64ArrayValue(super::Int64Array),
/// A list of string type feature value.
#[prost(message, tag = "12")]
StringArrayValue(super::StringArray),
/// Bytes feature value.
#[prost(bytes, tag = "13")]
BytesValue(::prost::bytes::Bytes),
/// A struct type feature value.
#[prost(message, tag = "15")]
StructValue(super::StructValue),
}
}
/// Struct (or object) type feature value.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StructValue {
/// A list of field values.
#[prost(message, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<StructFieldValue>,
}
/// One field of a Struct (or object) type feature value.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StructFieldValue {
/// Name of the field in the struct feature.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The value for this field.
#[prost(message, optional, tag = "2")]
pub value: ::core::option::Option<FeatureValue>,
}
/// Container for list of values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureValueList {
/// A list of feature values. All of them should be the same data type.
#[prost(message, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<FeatureValue>,
}
/// Generated client implementations.
pub mod featurestore_online_serving_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for serving online feature values.
#[derive(Debug, Clone)]
pub struct FeaturestoreOnlineServingServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> FeaturestoreOnlineServingServiceClient<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,
) -> FeaturestoreOnlineServingServiceClient<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,
{
FeaturestoreOnlineServingServiceClient::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
}
/// Reads Feature values of a specific entity of an EntityType. For reading
/// feature values of multiple entities of an EntityType, please use
/// StreamingReadFeatureValues.
pub async fn read_feature_values(
&mut self,
request: impl tonic::IntoRequest<super::ReadFeatureValuesRequest>,
) -> std::result::Result<
tonic::Response<super::ReadFeatureValuesResponse>,
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.aiplatform.v1.FeaturestoreOnlineServingService/ReadFeatureValues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreOnlineServingService",
"ReadFeatureValues",
),
);
self.inner.unary(req, path, codec).await
}
/// Reads Feature values for multiple entities. Depending on their size, data
/// for different entities may be broken
/// up across multiple responses.
pub async fn streaming_read_feature_values(
&mut self,
request: impl tonic::IntoRequest<super::StreamingReadFeatureValuesRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::ReadFeatureValuesResponse>>,
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.aiplatform.v1.FeaturestoreOnlineServingService/StreamingReadFeatureValues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreOnlineServingService",
"StreamingReadFeatureValues",
),
);
self.inner.server_streaming(req, path, codec).await
}
/// Writes Feature values of one or more entities of an EntityType.
///
/// The Feature values are merged into existing entities if any. The Feature
/// values to be written must have timestamp within the online storage
/// retention.
pub async fn write_feature_values(
&mut self,
request: impl tonic::IntoRequest<super::WriteFeatureValuesRequest>,
) -> std::result::Result<
tonic::Response<super::WriteFeatureValuesResponse>,
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.aiplatform.v1.FeaturestoreOnlineServingService/WriteFeatureValues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeaturestoreOnlineServingService",
"WriteFeatureValues",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Points to a DeployedModel.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployedModelRef {
/// Immutable. A resource name of an Endpoint.
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Immutable. An ID of a DeployedModel in the above Endpoint.
#[prost(string, tag = "2")]
pub deployed_model_id: ::prost::alloc::string::String,
}
/// Represents a hardware accelerator type.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum AcceleratorType {
/// Unspecified accelerator type, which means no accelerator.
Unspecified = 0,
/// Deprecated: Nvidia Tesla K80 GPU has reached end of support,
/// see <https://cloud.google.com/compute/docs/eol/k80-eol.>
NvidiaTeslaK80 = 1,
/// Nvidia Tesla P100 GPU.
NvidiaTeslaP100 = 2,
/// Nvidia Tesla V100 GPU.
NvidiaTeslaV100 = 3,
/// Nvidia Tesla P4 GPU.
NvidiaTeslaP4 = 4,
/// Nvidia Tesla T4 GPU.
NvidiaTeslaT4 = 5,
/// Nvidia Tesla A100 GPU.
NvidiaTeslaA100 = 8,
/// Nvidia A100 80GB GPU.
NvidiaA10080gb = 9,
/// Nvidia L4 GPU.
NvidiaL4 = 11,
/// Nvidia H100 80Gb GPU.
NvidiaH10080gb = 13,
/// TPU v2.
TpuV2 = 6,
/// TPU v3.
TpuV3 = 7,
/// TPU v4.
TpuV4Pod = 10,
/// TPU v5.
TpuV5Litepod = 12,
}
impl AcceleratorType {
/// 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 {
AcceleratorType::Unspecified => "ACCELERATOR_TYPE_UNSPECIFIED",
AcceleratorType::NvidiaTeslaK80 => "NVIDIA_TESLA_K80",
AcceleratorType::NvidiaTeslaP100 => "NVIDIA_TESLA_P100",
AcceleratorType::NvidiaTeslaV100 => "NVIDIA_TESLA_V100",
AcceleratorType::NvidiaTeslaP4 => "NVIDIA_TESLA_P4",
AcceleratorType::NvidiaTeslaT4 => "NVIDIA_TESLA_T4",
AcceleratorType::NvidiaTeslaA100 => "NVIDIA_TESLA_A100",
AcceleratorType::NvidiaA10080gb => "NVIDIA_A100_80GB",
AcceleratorType::NvidiaL4 => "NVIDIA_L4",
AcceleratorType::NvidiaH10080gb => "NVIDIA_H100_80GB",
AcceleratorType::TpuV2 => "TPU_V2",
AcceleratorType::TpuV3 => "TPU_V3",
AcceleratorType::TpuV4Pod => "TPU_V4_POD",
AcceleratorType::TpuV5Litepod => "TPU_V5_LITEPOD",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ACCELERATOR_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"NVIDIA_TESLA_K80" => Some(Self::NvidiaTeslaK80),
"NVIDIA_TESLA_P100" => Some(Self::NvidiaTeslaP100),
"NVIDIA_TESLA_V100" => Some(Self::NvidiaTeslaV100),
"NVIDIA_TESLA_P4" => Some(Self::NvidiaTeslaP4),
"NVIDIA_TESLA_T4" => Some(Self::NvidiaTeslaT4),
"NVIDIA_TESLA_A100" => Some(Self::NvidiaTeslaA100),
"NVIDIA_A100_80GB" => Some(Self::NvidiaA10080gb),
"NVIDIA_L4" => Some(Self::NvidiaL4),
"NVIDIA_H100_80GB" => Some(Self::NvidiaH10080gb),
"TPU_V2" => Some(Self::TpuV2),
"TPU_V3" => Some(Self::TpuV3),
"TPU_V4_POD" => Some(Self::TpuV4Pod),
"TPU_V5_LITEPOD" => Some(Self::TpuV5Litepod),
_ => None,
}
}
}
/// A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a
/// DeployedModel) to draw its Compute Engine resources from a Shared
/// Reservation, or exclusively from on-demand capacity.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReservationAffinity {
/// Required. Specifies the reservation affinity type.
#[prost(enumeration = "reservation_affinity::Type", tag = "1")]
pub reservation_affinity_type: i32,
/// Optional. Corresponds to the label key of a reservation resource. To target
/// a SPECIFIC_RESERVATION by name, use
/// `compute.googleapis.com/reservation-name` as the key and specify the name
/// of your reservation as its value.
#[prost(string, tag = "2")]
pub key: ::prost::alloc::string::String,
/// Optional. Corresponds to the label values of a reservation resource. This
/// must be the full resource name of the reservation.
#[prost(string, repeated, tag = "3")]
pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Nested message and enum types in `ReservationAffinity`.
pub mod reservation_affinity {
/// Identifies a type of reservation affinity.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// Default value. This should not be used.
Unspecified = 0,
/// Do not consume from any reserved capacity, only use on-demand.
NoReservation = 1,
/// Consume any reservation available, falling back to on-demand.
AnyReservation = 2,
/// Consume from a specific reservation. When chosen, the reservation
/// must be identified via the `key` and `values` fields.
SpecificReservation = 3,
}
impl Type {
/// 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 {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::NoReservation => "NO_RESERVATION",
Type::AnyReservation => "ANY_RESERVATION",
Type::SpecificReservation => "SPECIFIC_RESERVATION",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"NO_RESERVATION" => Some(Self::NoReservation),
"ANY_RESERVATION" => Some(Self::AnyReservation),
"SPECIFIC_RESERVATION" => Some(Self::SpecificReservation),
_ => None,
}
}
}
}
/// Specification of a single machine.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MachineSpec {
/// Immutable. The type of the machine.
///
/// See the [list of machine types supported for
/// prediction](<https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types>)
///
/// See the [list of machine types supported for custom
/// training](<https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types>).
///
/// For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is
/// optional, and the default value is `n1-standard-2`. For
/// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as
/// part of [WorkerPoolSpec][google.cloud.aiplatform.v1.WorkerPoolSpec] this
/// field is required.
#[prost(string, tag = "1")]
pub machine_type: ::prost::alloc::string::String,
/// Immutable. The type of accelerator(s) that may be attached to the machine
/// as per
/// [accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count].
#[prost(enumeration = "AcceleratorType", tag = "2")]
pub accelerator_type: i32,
/// The number of accelerators to attach to the machine.
#[prost(int32, tag = "3")]
pub accelerator_count: i32,
/// Immutable. The topology of the TPUs. Corresponds to the TPU topologies
/// available from GKE. (Example: tpu_topology: "2x2x1").
#[prost(string, tag = "4")]
pub tpu_topology: ::prost::alloc::string::String,
/// Optional. Immutable. Configuration controlling how this resource pool
/// consumes reservation.
#[prost(message, optional, tag = "5")]
pub reservation_affinity: ::core::option::Option<ReservationAffinity>,
}
/// A description of resources that are dedicated to a DeployedModel, and
/// that need a higher degree of manual configuration.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DedicatedResources {
/// Required. Immutable. The specification of a single machine used by the
/// prediction.
#[prost(message, optional, tag = "1")]
pub machine_spec: ::core::option::Option<MachineSpec>,
/// Required. Immutable. The minimum number of machine replicas this
/// DeployedModel will be always deployed on. This value must be greater than
/// or equal to 1.
///
/// If traffic against the DeployedModel increases, it may dynamically be
/// deployed onto more replicas, and as traffic decreases, some of these extra
/// replicas may be freed.
#[prost(int32, tag = "2")]
pub min_replica_count: i32,
/// Immutable. The maximum number of replicas this DeployedModel may be
/// deployed on when the traffic against it increases. If the requested value
/// is too large, the deployment will error, but if deployment succeeds then
/// the ability to scale the model to that many replicas is guaranteed (barring
/// service outages). If traffic against the DeployedModel increases beyond
/// what its replicas at maximum may handle, a portion of the traffic will be
/// dropped. If this value is not provided, will use
/// [min_replica_count][google.cloud.aiplatform.v1.DedicatedResources.min_replica_count]
/// as the default value.
///
/// The value of this field impacts the charge against Vertex CPU and GPU
/// quotas. Specifically, you will be charged for (max_replica_count *
/// number of cores in the selected machine type) and (max_replica_count *
/// number of GPUs per replica in the selected machine type).
#[prost(int32, tag = "3")]
pub max_replica_count: i32,
/// Immutable. The metric specifications that overrides a resource
/// utilization metric (CPU utilization, accelerator's duty cycle, and so on)
/// target value (default to 60 if not set). At most one entry is allowed per
/// metric.
///
/// If
/// [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count]
/// is above 0, the autoscaling will be based on both CPU utilization and
/// accelerator's duty cycle metrics and scale up when either metrics exceeds
/// its target value while scale down if both metrics are under their target
/// value. The default target value is 60 for both metrics.
///
/// If
/// [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count]
/// is 0, the autoscaling will be based on CPU utilization metric only with
/// default target value 60 if not explicitly set.
///
/// For example, in the case of Online Prediction, if you want to override
/// target CPU utilization to 80, you should set
/// [autoscaling_metric_specs.metric_name][google.cloud.aiplatform.v1.AutoscalingMetricSpec.metric_name]
/// to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and
/// [autoscaling_metric_specs.target][google.cloud.aiplatform.v1.AutoscalingMetricSpec.target]
/// to `80`.
#[prost(message, repeated, tag = "4")]
pub autoscaling_metric_specs: ::prost::alloc::vec::Vec<AutoscalingMetricSpec>,
/// Optional. If true, schedule the deployment workload on [spot
/// VMs](<https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms>).
#[prost(bool, tag = "5")]
pub spot: bool,
}
/// A description of resources that to large degree are decided by Vertex AI,
/// and require only a modest additional configuration.
/// Each Model supporting these resources documents its specific guidelines.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AutomaticResources {
/// Immutable. The minimum number of replicas this DeployedModel will be always
/// deployed on. If traffic against it increases, it may dynamically be
/// deployed onto more replicas up to
/// [max_replica_count][google.cloud.aiplatform.v1.AutomaticResources.max_replica_count],
/// and as traffic decreases, some of these extra replicas may be freed. If the
/// requested value is too large, the deployment will error.
#[prost(int32, tag = "1")]
pub min_replica_count: i32,
/// Immutable. The maximum number of replicas this DeployedModel may be
/// deployed on when the traffic against it increases. If the requested value
/// is too large, the deployment will error, but if deployment succeeds then
/// the ability to scale the model to that many replicas is guaranteed (barring
/// service outages). If traffic against the DeployedModel increases beyond
/// what its replicas at maximum may handle, a portion of the traffic will be
/// dropped. If this value is not provided, a no upper bound for scaling under
/// heavy traffic will be assume, though Vertex AI may be unable to scale
/// beyond certain replica number.
#[prost(int32, tag = "2")]
pub max_replica_count: i32,
}
/// A description of resources that are used for performing batch operations, are
/// dedicated to a Model, and need manual configuration.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchDedicatedResources {
/// Required. Immutable. The specification of a single machine.
#[prost(message, optional, tag = "1")]
pub machine_spec: ::core::option::Option<MachineSpec>,
/// Immutable. The number of machine replicas used at the start of the batch
/// operation. If not set, Vertex AI decides starting number, not greater than
/// [max_replica_count][google.cloud.aiplatform.v1.BatchDedicatedResources.max_replica_count]
#[prost(int32, tag = "2")]
pub starting_replica_count: i32,
/// Immutable. The maximum number of machine replicas the batch operation may
/// be scaled to. The default value is 10.
#[prost(int32, tag = "3")]
pub max_replica_count: i32,
}
/// Statistics information about resource consumption.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ResourcesConsumed {
/// Output only. The number of replica hours used. Note that many replicas may
/// run in parallel, and additionally any given work may be queued for some
/// time. Therefore this value is not strictly related to wall time.
#[prost(double, tag = "1")]
pub replica_hours: f64,
}
/// Represents the spec of disk options.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DiskSpec {
/// Type of the boot disk (default is "pd-ssd").
/// Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or
/// "pd-standard" (Persistent Disk Hard Disk Drive).
#[prost(string, tag = "1")]
pub boot_disk_type: ::prost::alloc::string::String,
/// Size in GB of the boot disk (default is 100GB).
#[prost(int32, tag = "2")]
pub boot_disk_size_gb: i32,
}
/// Represents the spec of [persistent
/// disk][<https://cloud.google.com/compute/docs/disks/persistent-disks]> options.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PersistentDiskSpec {
/// Type of the disk (default is "pd-standard").
/// Valid values: "pd-ssd" (Persistent Disk Solid State Drive)
/// "pd-standard" (Persistent Disk Hard Disk Drive)
/// "pd-balanced" (Balanced Persistent Disk)
/// "pd-extreme" (Extreme Persistent Disk)
#[prost(string, tag = "1")]
pub disk_type: ::prost::alloc::string::String,
/// Size in GB of the disk (default is 100GB).
#[prost(int64, tag = "2")]
pub disk_size_gb: i64,
}
/// Represents a mount configuration for Network File System (NFS) to mount.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NfsMount {
/// Required. IP address of the NFS server.
#[prost(string, tag = "1")]
pub server: ::prost::alloc::string::String,
/// Required. Source path exported from NFS server.
/// Has to start with '/', and combined with the ip address, it indicates
/// the source mount path in the form of `server:path`
#[prost(string, tag = "2")]
pub path: ::prost::alloc::string::String,
/// Required. Destination mount path. The NFS will be mounted for the user
/// under /mnt/nfs/<mount_point>
#[prost(string, tag = "3")]
pub mount_point: ::prost::alloc::string::String,
}
/// The metric specification that defines the target resource utilization
/// (CPU utilization, accelerator's duty cycle, and so on) for calculating the
/// desired replica count.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AutoscalingMetricSpec {
/// Required. The resource metric name.
/// Supported metrics:
///
/// * For Online Prediction:
/// * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle`
/// * `aiplatform.googleapis.com/prediction/online/cpu/utilization`
#[prost(string, tag = "1")]
pub metric_name: ::prost::alloc::string::String,
/// The target resource utilization in percentage (1% - 100%) for the given
/// metric; once the real usage deviates from the target by a certain
/// percentage, the machine replicas change. The default value is 60
/// (representing 60%) if not provided.
#[prost(int32, tag = "2")]
pub target: i32,
}
/// A set of Shielded Instance options.
/// See [Images using supported Shielded VM
/// features](<https://cloud.google.com/compute/docs/instances/modifying-shielded-vm>).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ShieldedVmConfig {
/// Defines whether the instance has [Secure
/// Boot](<https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot>)
/// enabled.
///
/// Secure Boot helps ensure that the system only runs authentic software by
/// verifying the digital signature of all boot components, and halting the
/// boot process if signature verification fails.
#[prost(bool, tag = "1")]
pub enable_secure_boot: bool,
}
/// A description of resources that can be shared by multiple DeployedModels,
/// whose underlying specification consists of a DedicatedResources.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeploymentResourcePool {
/// Immutable. The resource name of the DeploymentResourcePool.
/// Format:
/// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The underlying DedicatedResources that the DeploymentResourcePool
/// uses.
#[prost(message, optional, tag = "2")]
pub dedicated_resources: ::core::option::Option<DedicatedResources>,
/// Customer-managed encryption key spec for a DeploymentResourcePool. If set,
/// this DeploymentResourcePool will be secured by this key. Endpoints and the
/// DeploymentResourcePool they deploy in need to have the same EncryptionSpec.
#[prost(message, optional, tag = "5")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// The service account that the DeploymentResourcePool's container(s) run as.
/// Specify the email address of the service account. If this service account
/// is not specified, the container(s) run as a service account that doesn't
/// have access to the resource project.
///
/// Users deploying the Models to this DeploymentResourcePool must have the
/// `iam.serviceAccounts.actAs` permission on this service account.
#[prost(string, tag = "6")]
pub service_account: ::prost::alloc::string::String,
/// If the DeploymentResourcePool is deployed with custom-trained Models or
/// AutoML Tabular Models, the container(s) of the DeploymentResourcePool will
/// send `stderr` and `stdout` streams to Cloud Logging by default.
/// Please note that the logs incur cost, which are subject to [Cloud Logging
/// pricing](<https://cloud.google.com/logging/pricing>).
///
/// User can disable container logging by setting this flag to true.
#[prost(bool, tag = "7")]
pub disable_container_logging: bool,
/// Output only. Timestamp when this DeploymentResourcePool was created.
#[prost(message, optional, tag = "4")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "8")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "9")]
pub satisfies_pzi: bool,
}
/// Metadata describing the Model's input and output for explanation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplanationMetadata {
/// Required. Map from feature names to feature input metadata. Keys are the
/// name of the features. Values are the specification of the feature.
///
/// An empty InputMetadata is valid. It describes a text feature which has the
/// name specified as the key in
/// [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
/// The baseline of the empty feature is chosen by Vertex AI.
///
/// For Vertex AI-provided Tensorflow images, the key can be any friendly
/// name of the feature. Once specified,
/// [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
/// are keyed by this key (if not grouped with another feature).
///
/// For custom images, the key must match with the key in
/// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
#[prost(btree_map = "string, message", tag = "1")]
pub inputs: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
explanation_metadata::InputMetadata,
>,
/// Required. Map from output names to output metadata.
///
/// For Vertex AI-provided Tensorflow images, keys can be any user defined
/// string that consists of any UTF-8 characters.
///
/// For custom images, keys are the name of the output field in the prediction
/// to be explained.
///
/// Currently only one key is allowed.
#[prost(btree_map = "string, message", tag = "2")]
pub outputs: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
explanation_metadata::OutputMetadata,
>,
/// Points to a YAML file stored on Google Cloud Storage describing the format
/// of the [feature
/// attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
/// The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// AutoML tabular Models always have this field populated by Vertex AI.
/// Note: The URI given on output may be different, including the URI scheme,
/// than the one given on input. The output URI will point to a location where
/// the user only has a read access.
#[prost(string, tag = "3")]
pub feature_attributions_schema_uri: ::prost::alloc::string::String,
/// Name of the source to generate embeddings for example based explanations.
#[prost(string, tag = "5")]
pub latent_space_source: ::prost::alloc::string::String,
}
/// Nested message and enum types in `ExplanationMetadata`.
pub mod explanation_metadata {
/// Metadata of the input of a feature.
///
/// Fields other than
/// [InputMetadata.input_baselines][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.input_baselines]
/// are applicable only for Models that are using Vertex AI-provided images for
/// Tensorflow.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InputMetadata {
/// Baseline inputs for this feature.
///
/// If no baseline is specified, Vertex AI chooses the baseline for this
/// feature. If multiple baselines are specified, Vertex AI returns the
/// average attributions across them in
/// [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
///
/// For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape
/// of each baseline must match the shape of the input tensor. If a scalar is
/// provided, we broadcast to the same shape as the input tensor.
///
/// For custom images, the element of the baselines must be in the same
/// format as the feature's input in the
/// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances][]. The
/// schema of any single instance may be specified via Endpoint's
/// DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
#[prost(message, repeated, tag = "1")]
pub input_baselines: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// Name of the input tensor for this feature. Required and is only
/// applicable to Vertex AI-provided images for Tensorflow.
#[prost(string, tag = "2")]
pub input_tensor_name: ::prost::alloc::string::String,
/// Defines how the feature is encoded into the input tensor. Defaults to
/// IDENTITY.
#[prost(enumeration = "input_metadata::Encoding", tag = "3")]
pub encoding: i32,
/// Modality of the feature. Valid values are: numeric, image. Defaults to
/// numeric.
#[prost(string, tag = "4")]
pub modality: ::prost::alloc::string::String,
/// The domain details of the input feature value. Like min/max, original
/// mean or standard deviation if normalized.
#[prost(message, optional, tag = "5")]
pub feature_value_domain: ::core::option::Option<
input_metadata::FeatureValueDomain,
>,
/// Specifies the index of the values of the input tensor.
/// Required when the input tensor is a sparse representation. Refer to
/// Tensorflow documentation for more details:
/// <https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.>
#[prost(string, tag = "6")]
pub indices_tensor_name: ::prost::alloc::string::String,
/// Specifies the shape of the values of the input if the input is a sparse
/// representation. Refer to Tensorflow documentation for more details:
/// <https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.>
#[prost(string, tag = "7")]
pub dense_shape_tensor_name: ::prost::alloc::string::String,
/// A list of feature names for each index in the input tensor.
/// Required when the input
/// [InputMetadata.encoding][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoding]
/// is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
#[prost(string, repeated, tag = "8")]
pub index_feature_mapping: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// Encoded tensor is a transformation of the input tensor. Must be provided
/// if choosing
/// [Integrated Gradients
/// attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]
/// or [XRAI
/// attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution]
/// and the input tensor is not differentiable.
///
/// An encoded tensor is generated if the input tensor is encoded by a lookup
/// table.
#[prost(string, tag = "9")]
pub encoded_tensor_name: ::prost::alloc::string::String,
/// A list of baselines for the encoded tensor.
///
/// The shape of each baseline should match the shape of the encoded tensor.
/// If a scalar is provided, Vertex AI broadcasts to the same shape as the
/// encoded tensor.
#[prost(message, repeated, tag = "10")]
pub encoded_baselines: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// Visualization configurations for image explanation.
#[prost(message, optional, tag = "11")]
pub visualization: ::core::option::Option<input_metadata::Visualization>,
/// Name of the group that the input belongs to. Features with the same group
/// name will be treated as one feature when computing attributions. Features
/// grouped together can have different shapes in value. If provided, there
/// will be one single attribution generated in
/// [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions],
/// keyed by the group name.
#[prost(string, tag = "12")]
pub group_name: ::prost::alloc::string::String,
}
/// Nested message and enum types in `InputMetadata`.
pub mod input_metadata {
/// Domain details of the input feature value. Provides numeric information
/// about the feature, such as its range (min, max). If the feature has been
/// pre-processed, for example with z-scoring, then it provides information
/// about how to recover the original feature. For example, if the input
/// feature is an image and it has been pre-processed to obtain 0-mean and
/// stddev = 1 values, then original_mean, and original_stddev refer to the
/// mean and stddev of the original feature (e.g. image tensor) from which
/// input feature (with mean = 0 and stddev = 1) was obtained.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FeatureValueDomain {
/// The minimum permissible value for this feature.
#[prost(float, tag = "1")]
pub min_value: f32,
/// The maximum permissible value for this feature.
#[prost(float, tag = "2")]
pub max_value: f32,
/// If this input feature has been normalized to a mean value of 0,
/// the original_mean specifies the mean value of the domain prior to
/// normalization.
#[prost(float, tag = "3")]
pub original_mean: f32,
/// If this input feature has been normalized to a standard deviation of
/// 1.0, the original_stddev specifies the standard deviation of the domain
/// prior to normalization.
#[prost(float, tag = "4")]
pub original_stddev: f32,
}
/// Visualization configurations for image explanation.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Visualization {
/// Type of the image visualization. Only applicable to
/// [Integrated Gradients
/// attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
/// OUTLINES shows regions of attribution, while PIXELS shows per-pixel
/// attribution. Defaults to OUTLINES.
#[prost(enumeration = "visualization::Type", tag = "1")]
pub r#type: i32,
/// Whether to only highlight pixels with positive contributions, negative
/// or both. Defaults to POSITIVE.
#[prost(enumeration = "visualization::Polarity", tag = "2")]
pub polarity: i32,
/// The color scheme used for the highlighted areas.
///
/// Defaults to PINK_GREEN for
/// [Integrated Gradients
/// attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
/// which shows positive attributions in green and negative in pink.
///
/// Defaults to VIRIDIS for
/// [XRAI
/// attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
/// which highlights the most influential regions in yellow and the least
/// influential in blue.
#[prost(enumeration = "visualization::ColorMap", tag = "3")]
pub color_map: i32,
/// Excludes attributions above the specified percentile from the
/// highlighted areas. Using the clip_percent_upperbound and
/// clip_percent_lowerbound together can be useful for filtering out noise
/// and making it easier to see areas of strong attribution. Defaults to
/// 99.9.
#[prost(float, tag = "4")]
pub clip_percent_upperbound: f32,
/// Excludes attributions below the specified percentile, from the
/// highlighted areas. Defaults to 62.
#[prost(float, tag = "5")]
pub clip_percent_lowerbound: f32,
/// How the original image is displayed in the visualization.
/// Adjusting the overlay can help increase visual clarity if the original
/// image makes it difficult to view the visualization. Defaults to NONE.
#[prost(enumeration = "visualization::OverlayType", tag = "6")]
pub overlay_type: i32,
}
/// Nested message and enum types in `Visualization`.
pub mod visualization {
/// Type of the image visualization. Only applicable to
/// [Integrated Gradients
/// attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// Should not be used.
Unspecified = 0,
/// Shows which pixel contributed to the image prediction.
Pixels = 1,
/// Shows which region contributed to the image prediction by outlining
/// the region.
Outlines = 2,
}
impl Type {
/// 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 {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::Pixels => "PIXELS",
Type::Outlines => "OUTLINES",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"PIXELS" => Some(Self::Pixels),
"OUTLINES" => Some(Self::Outlines),
_ => None,
}
}
}
/// Whether to only highlight pixels with positive contributions, negative
/// or both. Defaults to POSITIVE.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Polarity {
/// Default value. This is the same as POSITIVE.
Unspecified = 0,
/// Highlights the pixels/outlines that were most influential to the
/// model's prediction.
Positive = 1,
/// Setting polarity to negative highlights areas that does not lead to
/// the models's current prediction.
Negative = 2,
/// Shows both positive and negative attributions.
Both = 3,
}
impl Polarity {
/// 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 {
Polarity::Unspecified => "POLARITY_UNSPECIFIED",
Polarity::Positive => "POSITIVE",
Polarity::Negative => "NEGATIVE",
Polarity::Both => "BOTH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"POLARITY_UNSPECIFIED" => Some(Self::Unspecified),
"POSITIVE" => Some(Self::Positive),
"NEGATIVE" => Some(Self::Negative),
"BOTH" => Some(Self::Both),
_ => None,
}
}
}
/// The color scheme used for highlighting areas.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ColorMap {
/// Should not be used.
Unspecified = 0,
/// Positive: green. Negative: pink.
PinkGreen = 1,
/// Viridis color map: A perceptually uniform color mapping which is
/// easier to see by those with colorblindness and progresses from yellow
/// to green to blue. Positive: yellow. Negative: blue.
Viridis = 2,
/// Positive: red. Negative: red.
Red = 3,
/// Positive: green. Negative: green.
Green = 4,
/// Positive: green. Negative: red.
RedGreen = 6,
/// PiYG palette.
PinkWhiteGreen = 5,
}
impl ColorMap {
/// 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 {
ColorMap::Unspecified => "COLOR_MAP_UNSPECIFIED",
ColorMap::PinkGreen => "PINK_GREEN",
ColorMap::Viridis => "VIRIDIS",
ColorMap::Red => "RED",
ColorMap::Green => "GREEN",
ColorMap::RedGreen => "RED_GREEN",
ColorMap::PinkWhiteGreen => "PINK_WHITE_GREEN",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"COLOR_MAP_UNSPECIFIED" => Some(Self::Unspecified),
"PINK_GREEN" => Some(Self::PinkGreen),
"VIRIDIS" => Some(Self::Viridis),
"RED" => Some(Self::Red),
"GREEN" => Some(Self::Green),
"RED_GREEN" => Some(Self::RedGreen),
"PINK_WHITE_GREEN" => Some(Self::PinkWhiteGreen),
_ => None,
}
}
}
/// How the original image is displayed in the visualization.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum OverlayType {
/// Default value. This is the same as NONE.
Unspecified = 0,
/// No overlay.
None = 1,
/// The attributions are shown on top of the original image.
Original = 2,
/// The attributions are shown on top of grayscaled version of the
/// original image.
Grayscale = 3,
/// The attributions are used as a mask to reveal predictive parts of
/// the image and hide the un-predictive parts.
MaskBlack = 4,
}
impl OverlayType {
/// 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 {
OverlayType::Unspecified => "OVERLAY_TYPE_UNSPECIFIED",
OverlayType::None => "NONE",
OverlayType::Original => "ORIGINAL",
OverlayType::Grayscale => "GRAYSCALE",
OverlayType::MaskBlack => "MASK_BLACK",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OVERLAY_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"NONE" => Some(Self::None),
"ORIGINAL" => Some(Self::Original),
"GRAYSCALE" => Some(Self::Grayscale),
"MASK_BLACK" => Some(Self::MaskBlack),
_ => None,
}
}
}
}
/// Defines how a feature is encoded. Defaults to IDENTITY.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Encoding {
/// Default value. This is the same as IDENTITY.
Unspecified = 0,
/// The tensor represents one feature.
Identity = 1,
/// The tensor represents a bag of features where each index maps to
/// a feature.
/// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
/// must be provided for this encoding. For example:
/// ```
/// input = \[27, 6.0, 150\]
/// index_feature_mapping = \["age", "height", "weight"\]
/// ```
BagOfFeatures = 2,
/// The tensor represents a bag of features where each index maps to a
/// feature. Zero values in the tensor indicates feature being
/// non-existent.
/// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
/// must be provided for this encoding. For example:
/// ```
/// input = \[2, 0, 5, 0, 1\]
/// index_feature_mapping = \["a", "b", "c", "d", "e"\]
/// ```
BagOfFeaturesSparse = 3,
/// The tensor is a list of binaries representing whether a feature exists
/// or not (1 indicates existence).
/// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
/// must be provided for this encoding. For example:
/// ```
/// input = \[1, 0, 1, 0, 1\]
/// index_feature_mapping = \["a", "b", "c", "d", "e"\]
/// ```
Indicator = 4,
/// The tensor is encoded into a 1-dimensional array represented by an
/// encoded tensor.
/// [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
/// must be provided for this encoding. For example:
/// ```
/// input = \["This", "is", "a", "test", "."\]
/// encoded = \[0.1, 0.2, 0.3, 0.4, 0.5\]
/// ```
CombinedEmbedding = 5,
/// Select this encoding when the input tensor is encoded into a
/// 2-dimensional array represented by an encoded tensor.
/// [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
/// must be provided for this encoding. The first dimension of the encoded
/// tensor's shape is the same as the input tensor's shape. For example:
/// ```
/// input = \["This", "is", "a", "test", "."\]
/// encoded = \[[0.1, 0.2, 0.3, 0.4, 0.5\],
/// \[0.2, 0.1, 0.4, 0.3, 0.5\],
/// \[0.5, 0.1, 0.3, 0.5, 0.4\],
/// \[0.5, 0.3, 0.1, 0.2, 0.4\],
/// \[0.4, 0.3, 0.2, 0.5, 0.1]\]
/// ```
ConcatEmbedding = 6,
}
impl Encoding {
/// 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 {
Encoding::Unspecified => "ENCODING_UNSPECIFIED",
Encoding::Identity => "IDENTITY",
Encoding::BagOfFeatures => "BAG_OF_FEATURES",
Encoding::BagOfFeaturesSparse => "BAG_OF_FEATURES_SPARSE",
Encoding::Indicator => "INDICATOR",
Encoding::CombinedEmbedding => "COMBINED_EMBEDDING",
Encoding::ConcatEmbedding => "CONCAT_EMBEDDING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ENCODING_UNSPECIFIED" => Some(Self::Unspecified),
"IDENTITY" => Some(Self::Identity),
"BAG_OF_FEATURES" => Some(Self::BagOfFeatures),
"BAG_OF_FEATURES_SPARSE" => Some(Self::BagOfFeaturesSparse),
"INDICATOR" => Some(Self::Indicator),
"COMBINED_EMBEDDING" => Some(Self::CombinedEmbedding),
"CONCAT_EMBEDDING" => Some(Self::ConcatEmbedding),
_ => None,
}
}
}
}
/// Metadata of the prediction output to be explained.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OutputMetadata {
/// Name of the output tensor. Required and is only applicable to Vertex
/// AI provided images for Tensorflow.
#[prost(string, tag = "3")]
pub output_tensor_name: ::prost::alloc::string::String,
/// Defines how to map
/// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
/// to
/// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name].
///
/// If neither of the fields are specified,
/// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
/// will not be populated.
#[prost(oneof = "output_metadata::DisplayNameMapping", tags = "1, 2")]
pub display_name_mapping: ::core::option::Option<
output_metadata::DisplayNameMapping,
>,
}
/// Nested message and enum types in `OutputMetadata`.
pub mod output_metadata {
/// Defines how to map
/// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
/// to
/// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name].
///
/// If neither of the fields are specified,
/// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
/// will not be populated.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum DisplayNameMapping {
/// Static mapping between the index and display name.
///
/// Use this if the outputs are a deterministic n-dimensional array, e.g. a
/// list of scores of all the classes in a pre-defined order for a
/// multi-classification Model. It's not feasible if the outputs are
/// non-deterministic, e.g. the Model produces top-k classes or sort the
/// outputs by their values.
///
/// The shape of the value must be an n-dimensional array of strings. The
/// number of dimensions must match that of the outputs to be explained.
/// The
/// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
/// is populated by locating in the mapping with
/// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index].
#[prost(message, tag = "1")]
IndexDisplayNameMapping(::prost_types::Value),
/// Specify a field name in the prediction to look for the display name.
///
/// Use this if the prediction contains the display names for the outputs.
///
/// The display names in the prediction must have the same shape of the
/// outputs, so that it can be located by
/// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
/// for a specific output.
#[prost(string, tag = "2")]
DisplayNameMappingKey(::prost::alloc::string::String),
}
}
}
/// Explanation of a prediction (provided in
/// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions])
/// produced by the Model on a given
/// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Explanation {
/// Output only. Feature attributions grouped by predicted outputs.
///
/// For Models that predict only one output, such as regression Models that
/// predict only one score, there is only one attibution that explains the
/// predicted output. For Models that predict multiple outputs, such as
/// multiclass Models that predict multiple classes, each element explains one
/// specific item.
/// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
/// can be used to identify which output this attribution is explaining.
///
/// By default, we provide Shapley values for the predicted class. However,
/// you can configure the explanation request to generate Shapley values for
/// any other classes too. For example, if a model predicts a probability of
/// `0.4` for approving a loan application, the model's decision is to reject
/// the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default
/// Shapley values would be computed for rejection decision and not approval,
/// even though the latter might be the positive class.
///
/// If users set
/// [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
/// the attributions are sorted by
/// [instance_output_value][Attributions.instance_output_value] in descending
/// order. If
/// [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices]
/// is specified, the attributions are stored by
/// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
/// in the same order as they appear in the output_indices.
#[prost(message, repeated, tag = "1")]
pub attributions: ::prost::alloc::vec::Vec<Attribution>,
/// Output only. List of the nearest neighbors for example-based explanations.
///
/// For models deployed with the examples explanations feature enabled, the
/// attributions field is empty and instead the neighbors field is populated.
#[prost(message, repeated, tag = "2")]
pub neighbors: ::prost::alloc::vec::Vec<Neighbor>,
}
/// Aggregated explanation metrics for a Model over a set of instances.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelExplanation {
/// Output only. Aggregated attributions explaining the Model's prediction
/// outputs over the set of instances. The attributions are grouped by outputs.
///
/// For Models that predict only one output, such as regression Models that
/// predict only one score, there is only one attibution that explains the
/// predicted output. For Models that predict multiple outputs, such as
/// multiclass Models that predict multiple classes, each element explains one
/// specific item.
/// [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
/// can be used to identify which output this attribution is explaining.
///
/// The
/// [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
/// [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value]
/// and
/// [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
/// fields are averaged over the test data.
///
/// NOTE: Currently AutoML tabular classification Models produce only one
/// attribution, which averages attributions over all the classes it predicts.
/// [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error]
/// is not populated.
#[prost(message, repeated, tag = "1")]
pub mean_attributions: ::prost::alloc::vec::Vec<Attribution>,
}
/// Attribution that explains a particular prediction output.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Attribution {
/// Output only. Model predicted output if the input instance is constructed
/// from the baselines of all the features defined in
/// [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
/// The field name of the output is determined by the key in
/// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
///
/// If the Model's predicted output has multiple dimensions (rank > 1), this is
/// the value in the output located by
/// [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
///
/// If there are multiple baselines, their output values are averaged.
#[prost(double, tag = "1")]
pub baseline_output_value: f64,
/// Output only. Model predicted output on the corresponding [explanation
/// instance][ExplainRequest.instances]. The field name of the output is
/// determined by the key in
/// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
///
/// If the Model predicted output has multiple dimensions, this is the value in
/// the output located by
/// [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
#[prost(double, tag = "2")]
pub instance_output_value: f64,
/// Output only. Attributions of each explained feature. Features are extracted
/// from the [prediction
/// instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
/// to [explanation metadata for
/// inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
///
/// The value is a struct, whose keys are the name of the feature. The values
/// are how much the feature in the
/// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
/// to the predicted result.
///
/// The format of the value is determined by the feature's input format:
///
/// * If the feature is a scalar value, the attribution value is a
/// [floating number][google.protobuf.Value.number_value].
///
/// * If the feature is an array of scalar values, the attribution value is
/// an [array][google.protobuf.Value.list_value].
///
/// * If the feature is a struct, the attribution value is a
/// [struct][google.protobuf.Value.struct_value]. The keys in the
/// attribution value struct are the same as the keys in the feature
/// struct. The formats of the values in the attribution struct are
/// determined by the formats of the values in the feature struct.
///
/// The
/// [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
/// field, pointed to by the
/// [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
/// [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
/// object, points to the schema file that describes the features and their
/// attribution values (if it is populated).
#[prost(message, optional, tag = "3")]
pub feature_attributions: ::core::option::Option<::prost_types::Value>,
/// Output only. The index that locates the explained prediction output.
///
/// If the prediction output is a scalar value, output_index is not populated.
/// If the prediction output has multiple dimensions, the length of the
/// output_index list is the same as the number of dimensions of the output.
/// The i-th element in output_index is the element index of the i-th dimension
/// of the output vector. Indices start from 0.
#[prost(int32, repeated, packed = "false", tag = "4")]
pub output_index: ::prost::alloc::vec::Vec<i32>,
/// Output only. The display name of the output identified by
/// [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For
/// example, the predicted class name by a multi-classification Model.
///
/// This field is only populated iff the Model predicts display names as a
/// separate field along with the explained output. The predicted display name
/// must has the same shape of the explained output, and can be located using
/// output_index.
#[prost(string, tag = "5")]
pub output_display_name: ::prost::alloc::string::String,
/// Output only. Error of
/// [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
/// caused by approximation used in the explanation method. Lower value means
/// more precise attributions.
///
/// * For Sampled Shapley
/// [attribution][google.cloud.aiplatform.v1.ExplanationParameters.sampled_shapley_attribution],
/// increasing
/// [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count]
/// might reduce the error.
/// * For Integrated Gradients
/// [attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
/// increasing
/// [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count]
/// might reduce the error.
/// * For [XRAI
/// attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
/// increasing
/// [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might
/// reduce the error.
///
/// See [this introduction](/vertex-ai/docs/explainable-ai/overview)
/// for more information.
#[prost(double, tag = "6")]
pub approximation_error: f64,
/// Output only. Name of the explain output. Specified as the key in
/// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
#[prost(string, tag = "7")]
pub output_name: ::prost::alloc::string::String,
}
/// Neighbors for example-based explanations.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Neighbor {
/// Output only. The neighbor id.
#[prost(string, tag = "1")]
pub neighbor_id: ::prost::alloc::string::String,
/// Output only. The neighbor distance.
#[prost(double, tag = "2")]
pub neighbor_distance: f64,
}
/// Specification of Model explanation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplanationSpec {
/// Required. Parameters that configure explaining of the Model's predictions.
#[prost(message, optional, tag = "1")]
pub parameters: ::core::option::Option<ExplanationParameters>,
/// Optional. Metadata describing the Model's input and output for explanation.
#[prost(message, optional, tag = "2")]
pub metadata: ::core::option::Option<ExplanationMetadata>,
}
/// Parameters to configure explaining for Model's predictions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplanationParameters {
/// If populated, returns attributions for top K indices of outputs
/// (defaults to 1). Only applies to Models that predicts more than one outputs
/// (e,g, multi-class Models). When set to -1, returns explanations for all
/// outputs.
#[prost(int32, tag = "4")]
pub top_k: i32,
/// If populated, only returns attributions that have
/// [output_index][google.cloud.aiplatform.v1.Attribution.output_index]
/// contained in output_indices. It must be an ndarray of integers, with the
/// same shape of the output it's explaining.
///
/// If not populated, returns attributions for
/// [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of
/// outputs. If neither top_k nor output_indices is populated, returns the
/// argmax index of the outputs.
///
/// Only applicable to Models that predict multiple outputs (e,g, multi-class
/// Models that predict multiple classes).
#[prost(message, optional, tag = "5")]
pub output_indices: ::core::option::Option<::prost_types::ListValue>,
#[prost(oneof = "explanation_parameters::Method", tags = "1, 2, 3, 7")]
pub method: ::core::option::Option<explanation_parameters::Method>,
}
/// Nested message and enum types in `ExplanationParameters`.
pub mod explanation_parameters {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Method {
/// An attribution method that approximates Shapley values for features that
/// contribute to the label being predicted. A sampling strategy is used to
/// approximate the value rather than considering all subsets of features.
/// Refer to this paper for model details: <https://arxiv.org/abs/1306.4265.>
#[prost(message, tag = "1")]
SampledShapleyAttribution(super::SampledShapleyAttribution),
/// An attribution method that computes Aumann-Shapley values taking
/// advantage of the model's fully differentiable structure. Refer to this
/// paper for more details: <https://arxiv.org/abs/1703.01365>
#[prost(message, tag = "2")]
IntegratedGradientsAttribution(super::IntegratedGradientsAttribution),
/// An attribution method that redistributes Integrated Gradients
/// attribution to segmented regions, taking advantage of the model's fully
/// differentiable structure. Refer to this paper for
/// more details: <https://arxiv.org/abs/1906.02825>
///
/// XRAI currently performs better on natural images, like a picture of a
/// house or an animal. If the images are taken in artificial environments,
/// like a lab or manufacturing line, or from diagnostic equipment, like
/// x-rays or quality-control cameras, use Integrated Gradients instead.
#[prost(message, tag = "3")]
XraiAttribution(super::XraiAttribution),
/// Example-based explanations that returns the nearest neighbors from the
/// provided dataset.
#[prost(message, tag = "7")]
Examples(super::Examples),
}
}
/// An attribution method that approximates Shapley values for features that
/// contribute to the label being predicted. A sampling strategy is used to
/// approximate the value rather than considering all subsets of features.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SampledShapleyAttribution {
/// Required. The number of feature permutations to consider when approximating
/// the Shapley values.
///
/// Valid range of its value is \[1, 50\], inclusively.
#[prost(int32, tag = "1")]
pub path_count: i32,
}
/// An attribution method that computes the Aumann-Shapley value taking advantage
/// of the model's fully differentiable structure. Refer to this paper for
/// more details: <https://arxiv.org/abs/1703.01365>
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IntegratedGradientsAttribution {
/// Required. The number of steps for approximating the path integral.
/// A good value to start is 50 and gradually increase until the
/// sum to diff property is within the desired error range.
///
/// Valid range of its value is \[1, 100\], inclusively.
#[prost(int32, tag = "1")]
pub step_count: i32,
/// Config for SmoothGrad approximation of gradients.
///
/// When enabled, the gradients are approximated by averaging the gradients
/// from noisy samples in the vicinity of the inputs. Adding
/// noise can help improve the computed gradients. Refer to this paper for more
/// details: <https://arxiv.org/pdf/1706.03825.pdf>
#[prost(message, optional, tag = "2")]
pub smooth_grad_config: ::core::option::Option<SmoothGradConfig>,
/// Config for IG with blur baseline.
///
/// When enabled, a linear path from the maximally blurred image to the input
/// image is created. Using a blurred baseline instead of zero (black image) is
/// motivated by the BlurIG approach explained here:
/// <https://arxiv.org/abs/2004.03383>
#[prost(message, optional, tag = "3")]
pub blur_baseline_config: ::core::option::Option<BlurBaselineConfig>,
}
/// An explanation method that redistributes Integrated Gradients
/// attributions to segmented regions, taking advantage of the model's fully
/// differentiable structure. Refer to this paper for more details:
/// <https://arxiv.org/abs/1906.02825>
///
/// Supported only by image Models.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct XraiAttribution {
/// Required. The number of steps for approximating the path integral.
/// A good value to start is 50 and gradually increase until the
/// sum to diff property is met within the desired error range.
///
/// Valid range of its value is \[1, 100\], inclusively.
#[prost(int32, tag = "1")]
pub step_count: i32,
/// Config for SmoothGrad approximation of gradients.
///
/// When enabled, the gradients are approximated by averaging the gradients
/// from noisy samples in the vicinity of the inputs. Adding
/// noise can help improve the computed gradients. Refer to this paper for more
/// details: <https://arxiv.org/pdf/1706.03825.pdf>
#[prost(message, optional, tag = "2")]
pub smooth_grad_config: ::core::option::Option<SmoothGradConfig>,
/// Config for XRAI with blur baseline.
///
/// When enabled, a linear path from the maximally blurred image to the input
/// image is created. Using a blurred baseline instead of zero (black image) is
/// motivated by the BlurIG approach explained here:
/// <https://arxiv.org/abs/2004.03383>
#[prost(message, optional, tag = "3")]
pub blur_baseline_config: ::core::option::Option<BlurBaselineConfig>,
}
/// Config for SmoothGrad approximation of gradients.
///
/// When enabled, the gradients are approximated by averaging the gradients from
/// noisy samples in the vicinity of the inputs. Adding noise can help improve
/// the computed gradients. Refer to this paper for more details:
/// <https://arxiv.org/pdf/1706.03825.pdf>
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SmoothGradConfig {
/// The number of gradient samples to use for
/// approximation. The higher this number, the more accurate the gradient
/// is, but the runtime complexity increases by this factor as well.
/// Valid range of its value is \[1, 50\]. Defaults to 3.
#[prost(int32, tag = "3")]
pub noisy_sample_count: i32,
/// Represents the standard deviation of the gaussian kernel
/// that will be used to add noise to the interpolated inputs
/// prior to computing gradients.
#[prost(oneof = "smooth_grad_config::GradientNoiseSigma", tags = "1, 2")]
pub gradient_noise_sigma: ::core::option::Option<
smooth_grad_config::GradientNoiseSigma,
>,
}
/// Nested message and enum types in `SmoothGradConfig`.
pub mod smooth_grad_config {
/// Represents the standard deviation of the gaussian kernel
/// that will be used to add noise to the interpolated inputs
/// prior to computing gradients.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum GradientNoiseSigma {
/// This is a single float value and will be used to add noise to all the
/// features. Use this field when all features are normalized to have the
/// same distribution: scale to range \[0, 1\], \[-1, 1\] or z-scoring, where
/// features are normalized to have 0-mean and 1-variance. Learn more about
/// [normalization](<https://developers.google.com/machine-learning/data-prep/transform/normalization>).
///
/// For best results the recommended value is about 10% - 20% of the standard
/// deviation of the input feature. Refer to section 3.2 of the SmoothGrad
/// paper: <https://arxiv.org/pdf/1706.03825.pdf.> Defaults to 0.1.
///
/// If the distribution is different per feature, set
/// [feature_noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.feature_noise_sigma]
/// instead for each feature.
#[prost(float, tag = "1")]
NoiseSigma(f32),
/// This is similar to
/// [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma],
/// but provides additional flexibility. A separate noise sigma can be
/// provided for each feature, which is useful if their distributions are
/// different. No noise is added to features that are not set. If this field
/// is unset,
/// [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
/// will be used for all features.
#[prost(message, tag = "2")]
FeatureNoiseSigma(super::FeatureNoiseSigma),
}
}
/// Noise sigma by features. Noise sigma represents the standard deviation of the
/// gaussian kernel that will be used to add noise to interpolated inputs prior
/// to computing gradients.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureNoiseSigma {
/// Noise sigma per feature. No noise is added to features that are not set.
#[prost(message, repeated, tag = "1")]
pub noise_sigma: ::prost::alloc::vec::Vec<feature_noise_sigma::NoiseSigmaForFeature>,
}
/// Nested message and enum types in `FeatureNoiseSigma`.
pub mod feature_noise_sigma {
/// Noise sigma for a single feature.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NoiseSigmaForFeature {
/// The name of the input feature for which noise sigma is provided. The
/// features are defined in
/// [explanation metadata
/// inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// This represents the standard deviation of the Gaussian kernel that will
/// be used to add noise to the feature prior to computing gradients. Similar
/// to [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
/// but represents the noise added to the current feature. Defaults to 0.1.
#[prost(float, tag = "2")]
pub sigma: f32,
}
}
/// Config for blur baseline.
///
/// When enabled, a linear path from the maximally blurred image to the input
/// image is created. Using a blurred baseline instead of zero (black image) is
/// motivated by the BlurIG approach explained here:
/// <https://arxiv.org/abs/2004.03383>
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BlurBaselineConfig {
/// The standard deviation of the blur kernel for the blurred baseline. The
/// same blurring parameter is used for both the height and the width
/// dimension. If not set, the method defaults to the zero (i.e. black for
/// images) baseline.
#[prost(float, tag = "1")]
pub max_blur_sigma: f32,
}
/// Example-based explainability that returns the nearest neighbors from the
/// provided dataset.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Examples {
/// The number of neighbors to return when querying for examples.
#[prost(int32, tag = "3")]
pub neighbor_count: i32,
#[prost(oneof = "examples::Source", tags = "5")]
pub source: ::core::option::Option<examples::Source>,
#[prost(oneof = "examples::Config", tags = "2, 4")]
pub config: ::core::option::Option<examples::Config>,
}
/// Nested message and enum types in `Examples`.
pub mod examples {
/// The Cloud Storage input instances.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExampleGcsSource {
/// The format in which instances are given, if not specified, assume it's
/// JSONL format. Currently only JSONL format is supported.
#[prost(enumeration = "example_gcs_source::DataFormat", tag = "1")]
pub data_format: i32,
/// The Cloud Storage location for the input instances.
#[prost(message, optional, tag = "2")]
pub gcs_source: ::core::option::Option<super::GcsSource>,
}
/// Nested message and enum types in `ExampleGcsSource`.
pub mod example_gcs_source {
/// The format of the input example instances.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DataFormat {
/// Format unspecified, used when unset.
Unspecified = 0,
/// Examples are stored in JSONL files.
Jsonl = 1,
}
impl DataFormat {
/// 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 {
DataFormat::Unspecified => "DATA_FORMAT_UNSPECIFIED",
DataFormat::Jsonl => "JSONL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DATA_FORMAT_UNSPECIFIED" => Some(Self::Unspecified),
"JSONL" => Some(Self::Jsonl),
_ => None,
}
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// The Cloud Storage input instances.
#[prost(message, tag = "5")]
ExampleGcsSource(ExampleGcsSource),
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Config {
/// The full configuration for the generated index, the semantics are the
/// same as [metadata][google.cloud.aiplatform.v1.Index.metadata] and should
/// match
/// [NearestNeighborSearchConfig](<https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config>).
#[prost(message, tag = "2")]
NearestNeighborSearchConfig(::prost_types::Value),
/// Simplified preset configuration, which automatically sets configuration
/// values based on the desired query speed-precision trade-off and modality.
#[prost(message, tag = "4")]
Presets(super::Presets),
}
}
/// Preset configuration for example-based explanations
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Presets {
/// Preset option controlling parameters for speed-precision trade-off when
/// querying for examples. If omitted, defaults to `PRECISE`.
#[prost(enumeration = "presets::Query", optional, tag = "1")]
pub query: ::core::option::Option<i32>,
/// The modality of the uploaded model, which automatically configures the
/// distance measurement and feature normalization for the underlying example
/// index and queries. If your model does not precisely fit one of these types,
/// it is okay to choose the closest type.
#[prost(enumeration = "presets::Modality", tag = "2")]
pub modality: i32,
}
/// Nested message and enum types in `Presets`.
pub mod presets {
/// Preset option controlling parameters for query speed-precision trade-off
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Query {
/// More precise neighbors as a trade-off against slower response.
Precise = 0,
/// Faster response as a trade-off against less precise neighbors.
Fast = 1,
}
impl Query {
/// 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 {
Query::Precise => "PRECISE",
Query::Fast => "FAST",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PRECISE" => Some(Self::Precise),
"FAST" => Some(Self::Fast),
_ => None,
}
}
}
/// Preset option controlling parameters for different modalities
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Modality {
/// Should not be set. Added as a recommended best practice for enums
Unspecified = 0,
/// IMAGE modality
Image = 1,
/// TEXT modality
Text = 2,
/// TABULAR modality
Tabular = 3,
}
impl Modality {
/// 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 {
Modality::Unspecified => "MODALITY_UNSPECIFIED",
Modality::Image => "IMAGE",
Modality::Text => "TEXT",
Modality::Tabular => "TABULAR",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MODALITY_UNSPECIFIED" => Some(Self::Unspecified),
"IMAGE" => Some(Self::Image),
"TEXT" => Some(Self::Text),
"TABULAR" => Some(Self::Tabular),
_ => None,
}
}
}
}
/// The [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] entries
/// that can be overridden at [online
/// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplanationSpecOverride {
/// The parameters to be overridden. Note that the
/// attribution method cannot be changed. If not specified,
/// no parameter is overridden.
#[prost(message, optional, tag = "1")]
pub parameters: ::core::option::Option<ExplanationParameters>,
/// The metadata to be overridden. If not specified, no metadata is overridden.
#[prost(message, optional, tag = "2")]
pub metadata: ::core::option::Option<ExplanationMetadataOverride>,
/// The example-based explanations parameter overrides.
#[prost(message, optional, tag = "3")]
pub examples_override: ::core::option::Option<ExamplesOverride>,
}
/// The [ExplanationMetadata][google.cloud.aiplatform.v1.ExplanationMetadata]
/// entries that can be overridden at [online
/// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplanationMetadataOverride {
/// Required. Overrides the [input
/// metadata][google.cloud.aiplatform.v1.ExplanationMetadata.inputs] of the
/// features. The key is the name of the feature to be overridden. The keys
/// specified here must exist in the input metadata to be overridden. If a
/// feature is not specified here, the corresponding feature's input metadata
/// is not overridden.
#[prost(btree_map = "string, message", tag = "1")]
pub inputs: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
explanation_metadata_override::InputMetadataOverride,
>,
}
/// Nested message and enum types in `ExplanationMetadataOverride`.
pub mod explanation_metadata_override {
/// The [input
/// metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata]
/// entries to be overridden.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InputMetadataOverride {
/// Baseline inputs for this feature.
///
/// This overrides the `input_baseline` field of the
/// [ExplanationMetadata.InputMetadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata]
/// object of the corresponding feature's input metadata. If it's not
/// specified, the original baselines are not overridden.
#[prost(message, repeated, tag = "1")]
pub input_baselines: ::prost::alloc::vec::Vec<::prost_types::Value>,
}
}
/// Overrides for example-based explanations.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExamplesOverride {
/// The number of neighbors to return.
#[prost(int32, tag = "1")]
pub neighbor_count: i32,
/// The number of neighbors to return that have the same crowding tag.
#[prost(int32, tag = "2")]
pub crowding_count: i32,
/// Restrict the resulting nearest neighbors to respect these constraints.
#[prost(message, repeated, tag = "3")]
pub restrictions: ::prost::alloc::vec::Vec<ExamplesRestrictionsNamespace>,
/// If true, return the embeddings instead of neighbors.
#[prost(bool, tag = "4")]
pub return_embeddings: bool,
/// The format of the data being provided with each call.
#[prost(enumeration = "examples_override::DataFormat", tag = "5")]
pub data_format: i32,
}
/// Nested message and enum types in `ExamplesOverride`.
pub mod examples_override {
/// Data format enum.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DataFormat {
/// Unspecified format. Must not be used.
Unspecified = 0,
/// Provided data is a set of model inputs.
Instances = 1,
/// Provided data is a set of embeddings.
Embeddings = 2,
}
impl DataFormat {
/// 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 {
DataFormat::Unspecified => "DATA_FORMAT_UNSPECIFIED",
DataFormat::Instances => "INSTANCES",
DataFormat::Embeddings => "EMBEDDINGS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DATA_FORMAT_UNSPECIFIED" => Some(Self::Unspecified),
"INSTANCES" => Some(Self::Instances),
"EMBEDDINGS" => Some(Self::Embeddings),
_ => None,
}
}
}
}
/// Restrictions namespace for example-based explanations overrides.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExamplesRestrictionsNamespace {
/// The namespace name.
#[prost(string, tag = "1")]
pub namespace_name: ::prost::alloc::string::String,
/// The list of allowed tags.
#[prost(string, repeated, tag = "2")]
pub allow: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The list of deny tags.
#[prost(string, repeated, tag = "3")]
pub deny: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Represents configuration for private service connect.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PrivateServiceConnectConfig {
/// Required. If true, expose the IndexEndpoint via private service connect.
#[prost(bool, tag = "1")]
pub enable_private_service_connect: bool,
/// A list of Projects from which the forwarding rule will target the service
/// attachment.
#[prost(string, repeated, tag = "2")]
pub project_allowlist: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Output only. The name of the generated service attachment resource.
/// This is only populated if the endpoint is deployed with
/// PrivateServiceConnect.
#[prost(string, tag = "5")]
pub service_attachment: ::prost::alloc::string::String,
}
/// PscAutomatedEndpoints defines the output of the forwarding rule
/// automatically created by each PscAutomationConfig.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PscAutomatedEndpoints {
/// Corresponding project_id in pscAutomationConfigs
#[prost(string, tag = "1")]
pub project_id: ::prost::alloc::string::String,
/// Corresponding network in pscAutomationConfigs.
#[prost(string, tag = "2")]
pub network: ::prost::alloc::string::String,
/// Ip Address created by the automated forwarding rule.
#[prost(string, tag = "3")]
pub match_address: ::prost::alloc::string::String,
}
/// Models are deployed into it, and afterwards Endpoint is called to obtain
/// predictions and explanations.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Endpoint {
/// Output only. The resource name of the Endpoint.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The display name of the Endpoint.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The description of the Endpoint.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. The models deployed in this Endpoint.
/// To add or remove DeployedModels use
/// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]
/// and
/// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]
/// respectively.
#[prost(message, repeated, tag = "4")]
pub deployed_models: ::prost::alloc::vec::Vec<DeployedModel>,
/// A map from a DeployedModel's ID to the percentage of this Endpoint's
/// traffic that should be forwarded to that DeployedModel.
///
/// If a DeployedModel's ID is not listed in this map, then it receives no
/// traffic.
///
/// The traffic percentage values must add up to 100, or map must be empty if
/// the Endpoint is to not accept any traffic at a moment.
#[prost(btree_map = "string, int32", tag = "5")]
pub traffic_split: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
i32,
>,
/// Used to perform consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "6")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize your Endpoints.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "7")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this Endpoint was created.
#[prost(message, optional, tag = "8")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Endpoint was last updated.
#[prost(message, optional, tag = "9")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Customer-managed encryption key spec for an Endpoint. If set, this
/// Endpoint and all sub-resources of this Endpoint will be secured by
/// this key.
#[prost(message, optional, tag = "10")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Optional. The full name of the Google Compute Engine
/// [network](<https://cloud.google.com//compute/docs/networks-and-firewalls#networks>)
/// to which the Endpoint should be peered.
///
/// Private services access must already be configured for the network. If left
/// unspecified, the Endpoint is not peered with any network.
///
/// Only one of the fields,
/// [network][google.cloud.aiplatform.v1.Endpoint.network] or
/// [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
/// can be set.
///
/// [Format](<https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert>):
/// `projects/{project}/global/networks/{network}`.
/// Where `{project}` is a project number, as in `12345`, and `{network}` is
/// network name.
#[prost(string, tag = "13")]
pub network: ::prost::alloc::string::String,
/// Deprecated: If true, expose the Endpoint via private service connect.
///
/// Only one of the fields,
/// [network][google.cloud.aiplatform.v1.Endpoint.network] or
/// [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
/// can be set.
#[deprecated]
#[prost(bool, tag = "17")]
pub enable_private_service_connect: bool,
/// Optional. Configuration for private service connect.
///
/// [network][google.cloud.aiplatform.v1.Endpoint.network] and
/// [private_service_connect_config][google.cloud.aiplatform.v1.Endpoint.private_service_connect_config]
/// are mutually exclusive.
#[prost(message, optional, tag = "21")]
pub private_service_connect_config: ::core::option::Option<
PrivateServiceConnectConfig,
>,
/// Output only. Resource name of the Model Monitoring job associated with this
/// Endpoint if monitoring is enabled by
/// [JobService.CreateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob].
/// Format:
/// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
#[prost(string, tag = "14")]
pub model_deployment_monitoring_job: ::prost::alloc::string::String,
/// Configures the request-response logging for online prediction.
#[prost(message, optional, tag = "18")]
pub predict_request_response_logging_config: ::core::option::Option<
PredictRequestResponseLoggingConfig,
>,
/// If true, the endpoint will be exposed through a dedicated
/// DNS \[Endpoint.dedicated_endpoint_dns\]. Your request to the dedicated DNS
/// will be isolated from other users' traffic and will have better performance
/// and reliability.
/// Note: Once you enabled dedicated endpoint, you won't be able to send
/// request to the shared DNS {region}-aiplatform.googleapis.com. The
/// limitation will be removed soon.
#[prost(bool, tag = "24")]
pub dedicated_endpoint_enabled: bool,
/// Output only. DNS of the dedicated endpoint. Will only be populated if
/// dedicated_endpoint_enabled is true.
/// Format:
/// `<https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.>
#[prost(string, tag = "25")]
pub dedicated_endpoint_dns: ::prost::alloc::string::String,
/// Output only. Reserved for future use.
#[prost(bool, tag = "27")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "28")]
pub satisfies_pzi: bool,
}
/// A deployment of a Model. Endpoints contain one or more DeployedModels.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployedModel {
/// Immutable. The ID of the DeployedModel. If not provided upon deployment,
/// Vertex AI will generate a value for this ID.
///
/// This value should be 1-10 characters, and valid characters are `/\[0-9\]/`.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Required. The resource name of the Model that this is the deployment of.
/// Note that the Model may be in a different location than the DeployedModel's
/// Endpoint.
///
/// The resource name may contain version id or version alias to specify the
/// version.
/// Example: `projects/{project}/locations/{location}/models/{model}@2`
/// or
/// `projects/{project}/locations/{location}/models/{model}@golden`
/// if no version is specified, the default version will be deployed.
#[prost(string, tag = "2")]
pub model: ::prost::alloc::string::String,
/// Output only. The version ID of the model that is deployed.
#[prost(string, tag = "18")]
pub model_version_id: ::prost::alloc::string::String,
/// The display name of the DeployedModel. If not provided upon creation,
/// the Model's display_name is used.
#[prost(string, tag = "3")]
pub display_name: ::prost::alloc::string::String,
/// Output only. Timestamp when the DeployedModel was created.
#[prost(message, optional, tag = "6")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Explanation configuration for this DeployedModel.
///
/// When deploying a Model using
/// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel],
/// this value overrides the value of
/// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
/// All fields of
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
/// are optional in the request. If a field of
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
/// is not populated, the value of the same field of
/// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
/// is inherited. If the corresponding
/// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
/// is not populated, all fields of the
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
/// will be used for the explanation configuration.
#[prost(message, optional, tag = "9")]
pub explanation_spec: ::core::option::Option<ExplanationSpec>,
/// If true, deploy the model without explainable feature, regardless the
/// existence of
/// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
/// or
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec].
#[prost(bool, tag = "19")]
pub disable_explanations: bool,
/// The service account that the DeployedModel's container runs as. Specify the
/// email address of the service account. If this service account is not
/// specified, the container runs as a service account that doesn't have access
/// to the resource project.
///
/// Users deploying the Model must have the `iam.serviceAccounts.actAs`
/// permission on this service account.
#[prost(string, tag = "11")]
pub service_account: ::prost::alloc::string::String,
/// For custom-trained Models and AutoML Tabular Models, the container of the
/// DeployedModel instances will send `stderr` and `stdout` streams to
/// Cloud Logging by default. Please note that the logs incur cost,
/// which are subject to [Cloud Logging
/// pricing](<https://cloud.google.com/logging/pricing>).
///
/// User can disable container logging by setting this flag to true.
#[prost(bool, tag = "15")]
pub disable_container_logging: bool,
/// If true, online prediction access logs are sent to Cloud
/// Logging.
/// These logs are like standard server access logs, containing
/// information like timestamp and latency for each prediction request.
///
/// Note that logs may incur a cost, especially if your project
/// receives prediction requests at a high queries per second rate (QPS).
/// Estimate your costs before enabling this option.
#[prost(bool, tag = "13")]
pub enable_access_logging: bool,
/// Output only. Provide paths for users to send predict/explain/health
/// requests directly to the deployed model services running on Cloud via
/// private services access. This field is populated if
/// [network][google.cloud.aiplatform.v1.Endpoint.network] is configured.
#[prost(message, optional, tag = "14")]
pub private_endpoints: ::core::option::Option<PrivateEndpoints>,
/// The prediction (for example, the machine) resources that the DeployedModel
/// uses. The user is billed for the resources (at least their minimal amount)
/// even if the DeployedModel receives no traffic.
/// Not all Models support all resources types. See
/// [Model.supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types].
/// Required except for Large Model Deploy use cases.
#[prost(oneof = "deployed_model::PredictionResources", tags = "7, 8, 17")]
pub prediction_resources: ::core::option::Option<
deployed_model::PredictionResources,
>,
}
/// Nested message and enum types in `DeployedModel`.
pub mod deployed_model {
/// The prediction (for example, the machine) resources that the DeployedModel
/// uses. The user is billed for the resources (at least their minimal amount)
/// even if the DeployedModel receives no traffic.
/// Not all Models support all resources types. See
/// [Model.supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types].
/// Required except for Large Model Deploy use cases.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum PredictionResources {
/// A description of resources that are dedicated to the DeployedModel, and
/// that need a higher degree of manual configuration.
#[prost(message, tag = "7")]
DedicatedResources(super::DedicatedResources),
/// A description of resources that to large degree are decided by Vertex
/// AI, and require only a modest additional configuration.
#[prost(message, tag = "8")]
AutomaticResources(super::AutomaticResources),
/// The resource name of the shared DeploymentResourcePool to deploy on.
/// Format:
/// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
#[prost(string, tag = "17")]
SharedResources(::prost::alloc::string::String),
}
}
/// PrivateEndpoints proto is used to provide paths for users to send
/// requests privately.
/// To send request via private service access, use predict_http_uri,
/// explain_http_uri or health_http_uri. To send request via private service
/// connect, use service_attachment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PrivateEndpoints {
/// Output only. Http(s) path to send prediction requests.
#[prost(string, tag = "1")]
pub predict_http_uri: ::prost::alloc::string::String,
/// Output only. Http(s) path to send explain requests.
#[prost(string, tag = "2")]
pub explain_http_uri: ::prost::alloc::string::String,
/// Output only. Http(s) path to send health check requests.
#[prost(string, tag = "3")]
pub health_http_uri: ::prost::alloc::string::String,
/// Output only. The name of the service attachment resource. Populated if
/// private service connect is enabled.
#[prost(string, tag = "4")]
pub service_attachment: ::prost::alloc::string::String,
}
/// Configuration for logging request-response to a BigQuery table.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PredictRequestResponseLoggingConfig {
/// If logging is enabled or not.
#[prost(bool, tag = "1")]
pub enabled: bool,
/// Percentage of requests to be logged, expressed as a fraction in
/// range(0,1].
#[prost(double, tag = "2")]
pub sampling_rate: f64,
/// BigQuery table for logging.
/// If only given a project, a new dataset will be created with name
/// `logging_<endpoint-display-name>_<endpoint-id>` where
/// <endpoint-display-name> will be made BigQuery-dataset-name compatible (e.g.
/// most special characters will become underscores). If no table name is
/// given, a new table will be created with name `request_response_logging`
#[prost(message, optional, tag = "3")]
pub bigquery_destination: ::core::option::Option<BigQueryDestination>,
}
/// Request message for CreateDeploymentResourcePool method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDeploymentResourcePoolRequest {
/// Required. The parent location resource where this DeploymentResourcePool
/// will be created. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The DeploymentResourcePool to create.
#[prost(message, optional, tag = "2")]
pub deployment_resource_pool: ::core::option::Option<DeploymentResourcePool>,
/// Required. The ID to use for the DeploymentResourcePool, which
/// will become the final component of the DeploymentResourcePool's resource
/// name.
///
/// The maximum length is 63 characters, and valid characters
/// are `/^[a-z](\[a-z0-9-\]{0,61}\[a-z0-9\])?$/`.
#[prost(string, tag = "3")]
pub deployment_resource_pool_id: ::prost::alloc::string::String,
}
/// Runtime operation information for CreateDeploymentResourcePool method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDeploymentResourcePoolOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for GetDeploymentResourcePool method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetDeploymentResourcePoolRequest {
/// Required. The name of the DeploymentResourcePool to retrieve.
/// Format:
/// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for ListDeploymentResourcePools method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeploymentResourcePoolsRequest {
/// Required. The parent Location which owns this collection of
/// DeploymentResourcePools. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of DeploymentResourcePools to return. The service may
/// return fewer than this value.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous `ListDeploymentResourcePools` call.
/// Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// `ListDeploymentResourcePools` must match the call that provided the page
/// token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for ListDeploymentResourcePools method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeploymentResourcePoolsResponse {
/// The DeploymentResourcePools from the specified location.
#[prost(message, repeated, tag = "1")]
pub deployment_resource_pools: ::prost::alloc::vec::Vec<DeploymentResourcePool>,
/// A token, which can be sent as `page_token` to retrieve the next page.
/// If this field is omitted, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for UpdateDeploymentResourcePool method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateDeploymentResourcePoolRequest {
/// Required. The DeploymentResourcePool to update.
///
/// The DeploymentResourcePool's `name` field is used to identify the
/// DeploymentResourcePool to update.
/// Format:
/// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
#[prost(message, optional, tag = "1")]
pub deployment_resource_pool: ::core::option::Option<DeploymentResourcePool>,
/// Required. The list of fields to update.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Runtime operation information for UpdateDeploymentResourcePool method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateDeploymentResourcePoolOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for DeleteDeploymentResourcePool method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDeploymentResourcePoolRequest {
/// Required. The name of the DeploymentResourcePool to delete.
/// Format:
/// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for QueryDeployedModels method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryDeployedModelsRequest {
/// Required. The name of the target DeploymentResourcePool to query.
/// Format:
/// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
#[prost(string, tag = "1")]
pub deployment_resource_pool: ::prost::alloc::string::String,
/// The maximum number of DeployedModels to return. The service may return
/// fewer than this value.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous `QueryDeployedModels` call.
/// Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// `QueryDeployedModels` must match the call that provided the page
/// token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for QueryDeployedModels method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryDeployedModelsResponse {
/// DEPRECATED Use deployed_model_refs instead.
#[deprecated]
#[prost(message, repeated, tag = "1")]
pub deployed_models: ::prost::alloc::vec::Vec<DeployedModel>,
/// A token, which can be sent as `page_token` to retrieve the next page.
/// If this field is omitted, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
/// References to the DeployedModels that share the specified
/// deploymentResourcePool.
#[prost(message, repeated, tag = "3")]
pub deployed_model_refs: ::prost::alloc::vec::Vec<DeployedModelRef>,
/// The total number of DeployedModels on this DeploymentResourcePool.
#[prost(int32, tag = "4")]
pub total_deployed_model_count: i32,
/// The total number of Endpoints that have DeployedModels on this
/// DeploymentResourcePool.
#[prost(int32, tag = "5")]
pub total_endpoint_count: i32,
}
/// Generated client implementations.
pub mod deployment_resource_pool_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service that manages the DeploymentResourcePool resource.
#[derive(Debug, Clone)]
pub struct DeploymentResourcePoolServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> DeploymentResourcePoolServiceClient<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,
) -> DeploymentResourcePoolServiceClient<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,
{
DeploymentResourcePoolServiceClient::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
}
/// Create a DeploymentResourcePool.
pub async fn create_deployment_resource_pool(
&mut self,
request: impl tonic::IntoRequest<super::CreateDeploymentResourcePoolRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DeploymentResourcePoolService/CreateDeploymentResourcePool",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DeploymentResourcePoolService",
"CreateDeploymentResourcePool",
),
);
self.inner.unary(req, path, codec).await
}
/// Get a DeploymentResourcePool.
pub async fn get_deployment_resource_pool(
&mut self,
request: impl tonic::IntoRequest<super::GetDeploymentResourcePoolRequest>,
) -> std::result::Result<
tonic::Response<super::DeploymentResourcePool>,
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.aiplatform.v1.DeploymentResourcePoolService/GetDeploymentResourcePool",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DeploymentResourcePoolService",
"GetDeploymentResourcePool",
),
);
self.inner.unary(req, path, codec).await
}
/// List DeploymentResourcePools in a location.
pub async fn list_deployment_resource_pools(
&mut self,
request: impl tonic::IntoRequest<super::ListDeploymentResourcePoolsRequest>,
) -> std::result::Result<
tonic::Response<super::ListDeploymentResourcePoolsResponse>,
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.aiplatform.v1.DeploymentResourcePoolService/ListDeploymentResourcePools",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DeploymentResourcePoolService",
"ListDeploymentResourcePools",
),
);
self.inner.unary(req, path, codec).await
}
/// Update a DeploymentResourcePool.
pub async fn update_deployment_resource_pool(
&mut self,
request: impl tonic::IntoRequest<super::UpdateDeploymentResourcePoolRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DeploymentResourcePoolService/UpdateDeploymentResourcePool",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DeploymentResourcePoolService",
"UpdateDeploymentResourcePool",
),
);
self.inner.unary(req, path, codec).await
}
/// Delete a DeploymentResourcePool.
pub async fn delete_deployment_resource_pool(
&mut self,
request: impl tonic::IntoRequest<super::DeleteDeploymentResourcePoolRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DeploymentResourcePoolService/DeleteDeploymentResourcePool",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DeploymentResourcePoolService",
"DeleteDeploymentResourcePool",
),
);
self.inner.unary(req, path, codec).await
}
/// List DeployedModels that have been deployed on this DeploymentResourcePool.
pub async fn query_deployed_models(
&mut self,
request: impl tonic::IntoRequest<super::QueryDeployedModelsRequest>,
) -> std::result::Result<
tonic::Response<super::QueryDeployedModelsResponse>,
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.aiplatform.v1.DeploymentResourcePoolService/QueryDeployedModels",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DeploymentResourcePoolService",
"QueryDeployedModels",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// NotebookExecutionJob represents an instance of a notebook execution.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NotebookExecutionJob {
/// Output only. The resource name of this NotebookExecutionJob. Format:
/// `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The display name of the NotebookExecutionJob. The name can be up to 128
/// characters long and can consist of any UTF-8 characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Max running time of the execution job in seconds (default 86400s / 24 hrs).
#[prost(message, optional, tag = "5")]
pub execution_timeout: ::core::option::Option<::prost_types::Duration>,
/// Output only. The Schedule resource name if this job is triggered by one.
/// Format:
/// `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
#[prost(string, tag = "6")]
pub schedule_resource_name: ::prost::alloc::string::String,
/// Output only. The state of the NotebookExecutionJob.
#[prost(enumeration = "JobState", tag = "10")]
pub job_state: i32,
/// Output only. Populated when the NotebookExecutionJob is completed. When
/// there is an error during notebook execution, the error details are
/// populated.
#[prost(message, optional, tag = "11")]
pub status: ::core::option::Option<super::super::super::rpc::Status>,
/// Output only. Timestamp when this NotebookExecutionJob was created.
#[prost(message, optional, tag = "12")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this NotebookExecutionJob was most recently
/// updated.
#[prost(message, optional, tag = "13")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The labels with user-defined metadata to organize NotebookExecutionJobs.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "19")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Customer-managed encryption key spec for the notebook execution job.
/// This field is auto-populated if the
/// [NotebookService.NotebookRuntimeTemplate][] has an encryption spec.
#[prost(message, optional, tag = "22")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// The input notebook.
#[prost(oneof = "notebook_execution_job::NotebookSource", tags = "3, 4, 17")]
pub notebook_source: ::core::option::Option<notebook_execution_job::NotebookSource>,
/// The compute config to use for an execution job.
#[prost(oneof = "notebook_execution_job::EnvironmentSpec", tags = "14")]
pub environment_spec: ::core::option::Option<
notebook_execution_job::EnvironmentSpec,
>,
/// The location to store the notebook execution result.
#[prost(oneof = "notebook_execution_job::ExecutionSink", tags = "8")]
pub execution_sink: ::core::option::Option<notebook_execution_job::ExecutionSink>,
/// The identity to run the execution as.
#[prost(oneof = "notebook_execution_job::ExecutionIdentity", tags = "9, 18")]
pub execution_identity: ::core::option::Option<
notebook_execution_job::ExecutionIdentity,
>,
}
/// Nested message and enum types in `NotebookExecutionJob`.
pub mod notebook_execution_job {
/// The Dataform Repository containing the input notebook.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataformRepositorySource {
/// The resource name of the Dataform Repository. Format:
/// `projects/{project_id}/locations/{location}/repositories/{repository_id}`
#[prost(string, tag = "1")]
pub dataform_repository_resource_name: ::prost::alloc::string::String,
/// The commit SHA to read repository with. If unset, the file will be read
/// at HEAD.
#[prost(string, tag = "2")]
pub commit_sha: ::prost::alloc::string::String,
}
/// The Cloud Storage uri for the input notebook.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GcsNotebookSource {
/// The Cloud Storage uri pointing to the ipynb file. Format:
/// `gs://bucket/notebook_file.ipynb`
#[prost(string, tag = "1")]
pub uri: ::prost::alloc::string::String,
/// The version of the Cloud Storage object to read. If unset, the current
/// version of the object is read. See
/// <https://cloud.google.com/storage/docs/metadata#generation-number.>
#[prost(string, tag = "2")]
pub generation: ::prost::alloc::string::String,
}
/// The content of the input notebook in ipynb format.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DirectNotebookSource {
/// The base64-encoded contents of the input notebook file.
#[prost(bytes = "bytes", tag = "1")]
pub content: ::prost::bytes::Bytes,
}
/// The input notebook.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum NotebookSource {
/// The Dataform Repository pointing to a single file notebook repository.
#[prost(message, tag = "3")]
DataformRepositorySource(DataformRepositorySource),
/// The Cloud Storage url pointing to the ipynb file. Format:
/// `gs://bucket/notebook_file.ipynb`
#[prost(message, tag = "4")]
GcsNotebookSource(GcsNotebookSource),
/// The contents of an input notebook file.
#[prost(message, tag = "17")]
DirectNotebookSource(DirectNotebookSource),
}
/// The compute config to use for an execution job.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum EnvironmentSpec {
/// The NotebookRuntimeTemplate to source compute configuration from.
#[prost(string, tag = "14")]
NotebookRuntimeTemplateResourceName(::prost::alloc::string::String),
}
/// The location to store the notebook execution result.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ExecutionSink {
/// The Cloud Storage location to upload the result to. Format:
/// `gs://bucket-name`
#[prost(string, tag = "8")]
GcsOutputUri(::prost::alloc::string::String),
}
/// The identity to run the execution as.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ExecutionIdentity {
/// The user email to run the execution as. Only supported by Colab runtimes.
#[prost(string, tag = "9")]
ExecutionUser(::prost::alloc::string::String),
/// The service account to run the execution as.
#[prost(string, tag = "18")]
ServiceAccount(::prost::alloc::string::String),
}
}
/// Network spec.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NetworkSpec {
/// Whether to enable public internet access. Default false.
#[prost(bool, tag = "1")]
pub enable_internet_access: bool,
/// The full name of the Google Compute Engine
/// [network](<https://cloud.google.com//compute/docs/networks-and-firewalls#networks>)
#[prost(string, tag = "2")]
pub network: ::prost::alloc::string::String,
/// The name of the subnet that this instance is in.
/// Format:
/// `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
#[prost(string, tag = "3")]
pub subnetwork: ::prost::alloc::string::String,
}
/// The euc configuration of NotebookRuntimeTemplate.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct NotebookEucConfig {
/// Input only. Whether EUC is disabled in this NotebookRuntimeTemplate.
/// In proto3, the default value of a boolean is false. In this way, by default
/// EUC will be enabled for NotebookRuntimeTemplate.
#[prost(bool, tag = "1")]
pub euc_disabled: bool,
/// Output only. Whether ActAs check is bypassed for service account attached
/// to the VM. If false, we need ActAs check for the default Compute Engine
/// Service account. When a Runtime is created, a VM is allocated using Default
/// Compute Engine Service Account. Any user requesting to use this Runtime
/// requires Service Account User (ActAs) permission over this SA. If true,
/// Runtime owner is using EUC and does not require the above permission as VM
/// no longer use default Compute Engine SA, but a P4SA.
#[prost(bool, tag = "2")]
pub bypass_actas_check: bool,
}
/// The idle shutdown configuration of NotebookRuntimeTemplate, which contains
/// the idle_timeout as required field.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct NotebookIdleShutdownConfig {
/// Required. Duration is accurate to the second. In Notebook, Idle Timeout is
/// accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440
/// * 60.
#[prost(message, optional, tag = "1")]
pub idle_timeout: ::core::option::Option<::prost_types::Duration>,
/// Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
#[prost(bool, tag = "2")]
pub idle_shutdown_disabled: bool,
}
/// Points to a NotebookRuntimeTemplateRef.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NotebookRuntimeTemplateRef {
/// Immutable. A resource name of the NotebookRuntimeTemplate.
#[prost(string, tag = "1")]
pub notebook_runtime_template: ::prost::alloc::string::String,
}
/// A template that specifies runtime configurations such as machine type,
/// runtime version, network configurations, etc.
/// Multiple runtimes can be created from a runtime template.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NotebookRuntimeTemplate {
/// The resource name of the NotebookRuntimeTemplate.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The display name of the NotebookRuntimeTemplate.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The description of the NotebookRuntimeTemplate.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. The default template to use if not specified.
#[prost(bool, tag = "4")]
pub is_default: bool,
/// Optional. Immutable. The specification of a single machine for the
/// template.
#[prost(message, optional, tag = "5")]
pub machine_spec: ::core::option::Option<MachineSpec>,
/// Optional. The specification of [persistent
/// disk][<https://cloud.google.com/compute/docs/disks/persistent-disks]>
/// attached to the runtime as data disk storage.
#[prost(message, optional, tag = "8")]
pub data_persistent_disk_spec: ::core::option::Option<PersistentDiskSpec>,
/// Optional. Network spec.
#[prost(message, optional, tag = "12")]
pub network_spec: ::core::option::Option<NetworkSpec>,
/// The service account that the runtime workload runs as.
/// You can use any service account within the same project, but you
/// must have the service account user permission to use the instance.
///
/// If not specified, the [Compute Engine default service
/// account](<https://cloud.google.com/compute/docs/access/service-accounts#default_service_account>)
/// is used.
#[prost(string, tag = "13")]
pub service_account: ::prost::alloc::string::String,
/// Used to perform consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "14")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize the
/// NotebookRuntimeTemplates.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "15")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// The idle shutdown configuration of NotebookRuntimeTemplate. This config
/// will only be set when idle shutdown is enabled.
#[prost(message, optional, tag = "17")]
pub idle_shutdown_config: ::core::option::Option<NotebookIdleShutdownConfig>,
/// EUC configuration of the NotebookRuntimeTemplate.
#[prost(message, optional, tag = "18")]
pub euc_config: ::core::option::Option<NotebookEucConfig>,
/// Output only. Timestamp when this NotebookRuntimeTemplate was created.
#[prost(message, optional, tag = "10")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this NotebookRuntimeTemplate was most recently
/// updated.
#[prost(message, optional, tag = "11")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Immutable. The type of the notebook runtime template.
#[prost(enumeration = "NotebookRuntimeType", tag = "19")]
pub notebook_runtime_type: i32,
/// Optional. Immutable. Runtime Shielded VM spec.
#[prost(message, optional, tag = "20")]
pub shielded_vm_config: ::core::option::Option<ShieldedVmConfig>,
/// Optional. The Compute Engine tags to add to runtime (see [Tagging
/// instances](<https://cloud.google.com/vpc/docs/add-remove-network-tags>)).
#[prost(string, repeated, tag = "21")]
pub network_tags: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Customer-managed encryption key spec for the notebook runtime.
#[prost(message, optional, tag = "23")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
}
/// A runtime is a virtual machine allocated to a particular user for a
/// particular Notebook file on temporary basis with lifetime limited to 24
/// hours.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NotebookRuntime {
/// Output only. The resource name of the NotebookRuntime.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user email of the NotebookRuntime.
#[prost(string, tag = "2")]
pub runtime_user: ::prost::alloc::string::String,
/// Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is
/// created from.
#[prost(message, optional, tag = "3")]
pub notebook_runtime_template_ref: ::core::option::Option<
NotebookRuntimeTemplateRef,
>,
/// Output only. The proxy endpoint used to access the NotebookRuntime.
#[prost(string, tag = "5")]
pub proxy_uri: ::prost::alloc::string::String,
/// Output only. Timestamp when this NotebookRuntime was created.
#[prost(message, optional, tag = "6")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this NotebookRuntime was most recently updated.
#[prost(message, optional, tag = "7")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The health state of the NotebookRuntime.
#[prost(enumeration = "notebook_runtime::HealthState", tag = "8")]
pub health_state: i32,
/// Required. The display name of the NotebookRuntime.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "10")]
pub display_name: ::prost::alloc::string::String,
/// The description of the NotebookRuntime.
#[prost(string, tag = "11")]
pub description: ::prost::alloc::string::String,
/// Output only. The service account that the NotebookRuntime workload runs as.
#[prost(string, tag = "13")]
pub service_account: ::prost::alloc::string::String,
/// Output only. The runtime (instance) state of the NotebookRuntime.
#[prost(enumeration = "notebook_runtime::RuntimeState", tag = "14")]
pub runtime_state: i32,
/// Output only. Whether NotebookRuntime is upgradable.
#[prost(bool, tag = "15")]
pub is_upgradable: bool,
/// The labels with user-defined metadata to organize your
/// NotebookRuntime.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one NotebookRuntime
/// (System labels are excluded).
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable. Following system labels exist for NotebookRuntime:
///
/// * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output
/// only, its value is the Compute Engine instance id.
/// * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is
/// either "bigquery" or "vertex"; if absent, it should be "vertex". This is to
/// describe the entry service, either BigQuery or Vertex.
#[prost(btree_map = "string, string", tag = "16")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this NotebookRuntime will be expired:
/// 1. System Predefined NotebookRuntime: 24 hours after creation. After
/// expiration, system predifined runtime will be deleted.
/// 2. User created NotebookRuntime: 6 months after last upgrade. After
/// expiration, user created runtime will be stopped and allowed for upgrade.
#[prost(message, optional, tag = "17")]
pub expiration_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The VM os image version of NotebookRuntime.
#[prost(string, tag = "18")]
pub version: ::prost::alloc::string::String,
/// Output only. The type of the notebook runtime.
#[prost(enumeration = "NotebookRuntimeType", tag = "19")]
pub notebook_runtime_type: i32,
/// Output only. The idle shutdown configuration of the notebook runtime.
#[prost(message, optional, tag = "23")]
pub idle_shutdown_config: ::core::option::Option<NotebookIdleShutdownConfig>,
/// Optional. The Compute Engine tags to add to runtime (see [Tagging
/// instances](<https://cloud.google.com/vpc/docs/add-remove-network-tags>)).
#[prost(string, repeated, tag = "25")]
pub network_tags: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Output only. Customer-managed encryption key spec for the notebook runtime.
#[prost(message, optional, tag = "28")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "29")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "30")]
pub satisfies_pzi: bool,
}
/// Nested message and enum types in `NotebookRuntime`.
pub mod notebook_runtime {
/// The substate of the NotebookRuntime to display health information.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum HealthState {
/// Unspecified health state.
Unspecified = 0,
/// NotebookRuntime is in healthy state. Applies to ACTIVE state.
Healthy = 1,
/// NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
Unhealthy = 2,
}
impl HealthState {
/// 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 {
HealthState::Unspecified => "HEALTH_STATE_UNSPECIFIED",
HealthState::Healthy => "HEALTHY",
HealthState::Unhealthy => "UNHEALTHY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"HEALTH_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"HEALTHY" => Some(Self::Healthy),
"UNHEALTHY" => Some(Self::Unhealthy),
_ => None,
}
}
}
/// The substate of the NotebookRuntime to display state of runtime.
/// The resource of NotebookRuntime is in ACTIVE state for these sub state.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum RuntimeState {
/// Unspecified runtime state.
Unspecified = 0,
/// NotebookRuntime is in running state.
Running = 1,
/// NotebookRuntime is in starting state.
BeingStarted = 2,
/// NotebookRuntime is in stopping state.
BeingStopped = 3,
/// NotebookRuntime is in stopped state.
Stopped = 4,
/// NotebookRuntime is in upgrading state. It is in the middle of upgrading
/// process.
BeingUpgraded = 5,
/// NotebookRuntime was unable to start/stop properly.
Error = 100,
/// NotebookRuntime is in invalid state. Cannot be recovered.
Invalid = 101,
}
impl RuntimeState {
/// 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 {
RuntimeState::Unspecified => "RUNTIME_STATE_UNSPECIFIED",
RuntimeState::Running => "RUNNING",
RuntimeState::BeingStarted => "BEING_STARTED",
RuntimeState::BeingStopped => "BEING_STOPPED",
RuntimeState::Stopped => "STOPPED",
RuntimeState::BeingUpgraded => "BEING_UPGRADED",
RuntimeState::Error => "ERROR",
RuntimeState::Invalid => "INVALID",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RUNTIME_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"RUNNING" => Some(Self::Running),
"BEING_STARTED" => Some(Self::BeingStarted),
"BEING_STOPPED" => Some(Self::BeingStopped),
"STOPPED" => Some(Self::Stopped),
"BEING_UPGRADED" => Some(Self::BeingUpgraded),
"ERROR" => Some(Self::Error),
"INVALID" => Some(Self::Invalid),
_ => None,
}
}
}
}
/// Represents a notebook runtime type.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum NotebookRuntimeType {
/// Unspecified notebook runtime type, NotebookRuntimeType will default to
/// USER_DEFINED.
Unspecified = 0,
/// runtime or template with coustomized configurations from user.
UserDefined = 1,
/// runtime or template with system defined configurations.
OneClick = 2,
}
impl NotebookRuntimeType {
/// 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 {
NotebookRuntimeType::Unspecified => "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED",
NotebookRuntimeType::UserDefined => "USER_DEFINED",
NotebookRuntimeType::OneClick => "ONE_CLICK",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"USER_DEFINED" => Some(Self::UserDefined),
"ONE_CLICK" => Some(Self::OneClick),
_ => None,
}
}
}
/// Request message for
/// [NotebookService.CreateNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.CreateNotebookRuntimeTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateNotebookRuntimeTemplateRequest {
/// Required. The resource name of the Location to create the
/// NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The NotebookRuntimeTemplate to create.
#[prost(message, optional, tag = "2")]
pub notebook_runtime_template: ::core::option::Option<NotebookRuntimeTemplate>,
/// Optional. User specified ID for the notebook runtime template.
#[prost(string, tag = "3")]
pub notebook_runtime_template_id: ::prost::alloc::string::String,
}
/// Metadata information for
/// [NotebookService.CreateNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.CreateNotebookRuntimeTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateNotebookRuntimeTemplateOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [NotebookService.GetNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.GetNotebookRuntimeTemplate]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetNotebookRuntimeTemplateRequest {
/// Required. The name of the NotebookRuntimeTemplate resource.
/// Format:
/// `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [NotebookService.ListNotebookRuntimeTemplates][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimeTemplates].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNotebookRuntimeTemplatesRequest {
/// Required. The resource name of the Location from which to list the
/// NotebookRuntimeTemplates.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. An expression for filtering the results of the request. For field
/// names both snake_case and camelCase are supported.
///
/// * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
/// represents the NotebookRuntimeTemplate ID,
/// i.e. the last segment of the NotebookRuntimeTemplate's \[resource name\]
/// \[google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name\].
/// * `display_name` supports = and !=
/// * `labels` supports general map functions that is:
/// * `labels.key=value` - key:value equality
/// * `labels.key:* or labels:key - key existence
/// * A key including a space must be quoted. `labels."a key"`.
/// * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
/// \[USER_DEFINED, ONE_CLICK\].
///
/// Some examples:
///
/// * `notebookRuntimeTemplate=notebookRuntimeTemplate123`
/// * `displayName="myDisplayName"`
/// * `labels.myKey="myValue"`
/// * `notebookRuntimeType=USER_DEFINED`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. The standard list page token.
/// Typically obtained via
/// [ListNotebookRuntimeTemplatesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimeTemplatesResponse.next_page_token]
/// of the previous
/// [NotebookService.ListNotebookRuntimeTemplates][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimeTemplates]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Optional. Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Optional. A comma-separated list of fields to order by, sorted in ascending
/// order. Use "desc" after a field name for descending. Supported fields:
///
/// * `display_name`
/// * `create_time`
/// * `update_time`
///
/// Example: `display_name, create_time desc`.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [NotebookService.ListNotebookRuntimeTemplates][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimeTemplates].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNotebookRuntimeTemplatesResponse {
/// List of NotebookRuntimeTemplates in the requested page.
#[prost(message, repeated, tag = "1")]
pub notebook_runtime_templates: ::prost::alloc::vec::Vec<NotebookRuntimeTemplate>,
/// A token to retrieve next page of results.
/// Pass to
/// [ListNotebookRuntimeTemplatesRequest.page_token][google.cloud.aiplatform.v1.ListNotebookRuntimeTemplatesRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [NotebookService.DeleteNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.DeleteNotebookRuntimeTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteNotebookRuntimeTemplateRequest {
/// Required. The name of the NotebookRuntimeTemplate resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [NotebookService.UpdateNotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookService.UpdateNotebookRuntimeTemplate].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateNotebookRuntimeTemplateRequest {
/// Required. The NotebookRuntimeTemplate to update.
#[prost(message, optional, tag = "1")]
pub notebook_runtime_template: ::core::option::Option<NotebookRuntimeTemplate>,
/// Required. The update mask applies to the resource.
/// For the `FieldMask` definition, see
/// [google.protobuf.FieldMask][google.protobuf.FieldMask]. Input format:
/// `{paths: "${updated_filed}"}` Updatable fields:
///
/// * `encryption_spec.kms_key_name`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [NotebookService.AssignNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.AssignNotebookRuntime].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AssignNotebookRuntimeRequest {
/// Required. The resource name of the Location to get the NotebookRuntime
/// assignment. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The resource name of the NotebookRuntimeTemplate based on which a
/// NotebookRuntime will be assigned (reuse or create a new one).
#[prost(string, tag = "2")]
pub notebook_runtime_template: ::prost::alloc::string::String,
/// Required. Provide runtime specific information (e.g. runtime owner,
/// notebook id) used for NotebookRuntime assignment.
#[prost(message, optional, tag = "3")]
pub notebook_runtime: ::core::option::Option<NotebookRuntime>,
/// Optional. User specified ID for the notebook runtime.
#[prost(string, tag = "4")]
pub notebook_runtime_id: ::prost::alloc::string::String,
}
/// Metadata information for
/// [NotebookService.AssignNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.AssignNotebookRuntime].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AssignNotebookRuntimeOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// A human-readable message that shows the intermediate progress details of
/// NotebookRuntime.
#[prost(string, tag = "2")]
pub progress_message: ::prost::alloc::string::String,
}
/// Request message for
/// [NotebookService.GetNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.GetNotebookRuntime]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetNotebookRuntimeRequest {
/// Required. The name of the NotebookRuntime resource.
/// Instead of checking whether the name is in valid NotebookRuntime resource
/// name format, directly throw NotFound exception if there is no such
/// NotebookRuntime in spanner.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNotebookRuntimesRequest {
/// Required. The resource name of the Location from which to list the
/// NotebookRuntimes.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. An expression for filtering the results of the request. For field
/// names both snake_case and camelCase are supported.
///
/// * `notebookRuntime` supports = and !=. `notebookRuntime` represents the
/// NotebookRuntime ID,
/// i.e. the last segment of the NotebookRuntime's \[resource name\]
/// \[google.cloud.aiplatform.v1.NotebookRuntime.name\].
/// * `displayName` supports = and != and regex.
/// * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
/// represents the NotebookRuntimeTemplate ID,
/// i.e. the last segment of the NotebookRuntimeTemplate's \[resource name\]
/// \[google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name\].
/// * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
/// HEALTH_STATE_UNSPECIFIED].
/// * `runtimeState` supports = and !=. runtimeState enum:
/// [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
/// STOPPED, BEING_UPGRADED, ERROR, INVALID].
/// * `runtimeUser` supports = and !=.
/// * API version is UI only: `uiState` supports = and !=. uiState enum:
/// [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
/// UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
/// UI_RESOURCE_STATE_CREATION_FAILED].
/// * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
/// \[USER_DEFINED, ONE_CLICK\].
///
/// Some examples:
///
/// * `notebookRuntime="notebookRuntime123"`
/// * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
/// * `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
/// * `healthState=HEALTHY`
/// * `runtimeState=RUNNING`
/// * `runtimeUser="test@google.com"`
/// * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
/// * `notebookRuntimeType=USER_DEFINED`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. The standard list page token.
/// Typically obtained via
/// [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token]
/// of the previous
/// [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Optional. Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Optional. A comma-separated list of fields to order by, sorted in ascending
/// order. Use "desc" after a field name for descending. Supported fields:
///
/// * `display_name`
/// * `create_time`
/// * `update_time`
///
/// Example: `display_name, create_time desc`.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNotebookRuntimesResponse {
/// List of NotebookRuntimes in the requested page.
#[prost(message, repeated, tag = "1")]
pub notebook_runtimes: ::prost::alloc::vec::Vec<NotebookRuntime>,
/// A token to retrieve next page of results.
/// Pass to
/// [ListNotebookRuntimesRequest.page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [NotebookService.DeleteNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.DeleteNotebookRuntime].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteNotebookRuntimeRequest {
/// Required. The name of the NotebookRuntime resource to be deleted.
/// Instead of checking whether the name is in valid NotebookRuntime resource
/// name format, directly throw NotFound exception if there is no such
/// NotebookRuntime in spanner.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [NotebookService.UpgradeNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.UpgradeNotebookRuntime].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpgradeNotebookRuntimeRequest {
/// Required. The name of the NotebookRuntime resource to be upgrade.
/// Instead of checking whether the name is in valid NotebookRuntime resource
/// name format, directly throw NotFound exception if there is no such
/// NotebookRuntime in spanner.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Metadata information for
/// [NotebookService.UpgradeNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.UpgradeNotebookRuntime].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpgradeNotebookRuntimeOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// A human-readable message that shows the intermediate progress details of
/// NotebookRuntime.
#[prost(string, tag = "2")]
pub progress_message: ::prost::alloc::string::String,
}
/// Response message for
/// [NotebookService.UpgradeNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.UpgradeNotebookRuntime].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UpgradeNotebookRuntimeResponse {}
/// Request message for
/// [NotebookService.StartNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StartNotebookRuntime].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StartNotebookRuntimeRequest {
/// Required. The name of the NotebookRuntime resource to be started.
/// Instead of checking whether the name is in valid NotebookRuntime resource
/// name format, directly throw NotFound exception if there is no such
/// NotebookRuntime in spanner.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Metadata information for
/// [NotebookService.StartNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StartNotebookRuntime].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StartNotebookRuntimeOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// A human-readable message that shows the intermediate progress details of
/// NotebookRuntime.
#[prost(string, tag = "2")]
pub progress_message: ::prost::alloc::string::String,
}
/// Response message for
/// [NotebookService.StartNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StartNotebookRuntime].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct StartNotebookRuntimeResponse {}
/// Request message for \[NotebookService.CreateNotebookExecutionJob\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateNotebookExecutionJobRequest {
/// Required. The resource name of the Location to create the
/// NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The NotebookExecutionJob to create.
#[prost(message, optional, tag = "2")]
pub notebook_execution_job: ::core::option::Option<NotebookExecutionJob>,
/// Optional. User specified ID for the NotebookExecutionJob.
#[prost(string, tag = "3")]
pub notebook_execution_job_id: ::prost::alloc::string::String,
}
/// Metadata information for
/// [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateNotebookExecutionJobOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// A human-readable message that shows the intermediate progress details of
/// NotebookRuntime.
#[prost(string, tag = "2")]
pub progress_message: ::prost::alloc::string::String,
}
/// Request message for \[NotebookService.GetNotebookExecutionJob\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetNotebookExecutionJobRequest {
/// Required. The name of the NotebookExecutionJob resource.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The NotebookExecutionJob view. Defaults to BASIC.
#[prost(enumeration = "NotebookExecutionJobView", tag = "6")]
pub view: i32,
}
/// Request message for \[NotebookService.ListNotebookExecutionJobs\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNotebookExecutionJobsRequest {
/// Required. The resource name of the Location from which to list the
/// NotebookExecutionJobs.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. An expression for filtering the results of the request. For field
/// names both snake_case and camelCase are supported.
///
/// * `notebookExecutionJob` supports = and !=. `notebookExecutionJob`
/// represents the NotebookExecutionJob ID.
/// * `displayName` supports = and != and regex.
/// * `schedule` supports = and != and regex.
///
/// Some examples:
/// * `notebookExecutionJob="123"`
/// * `notebookExecutionJob="my-execution-job"`
/// * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. The standard list page token.
/// Typically obtained via
/// [ListNotebookExecutionJobs.next_page_token][] of the previous
/// [NotebookService.ListNotebookExecutionJobs][google.cloud.aiplatform.v1.NotebookService.ListNotebookExecutionJobs]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Optional. A comma-separated list of fields to order by, sorted in ascending
/// order. Use "desc" after a field name for descending. Supported fields:
///
/// * `display_name`
/// * `create_time`
/// * `update_time`
///
/// Example: `display_name, create_time desc`.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Optional. The NotebookExecutionJob view. Defaults to BASIC.
#[prost(enumeration = "NotebookExecutionJobView", tag = "6")]
pub view: i32,
}
/// Response message for \[NotebookService.CreateNotebookExecutionJob\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNotebookExecutionJobsResponse {
/// List of NotebookExecutionJobs in the requested page.
#[prost(message, repeated, tag = "1")]
pub notebook_execution_jobs: ::prost::alloc::vec::Vec<NotebookExecutionJob>,
/// A token to retrieve next page of results.
/// Pass to [ListNotebookExecutionJobs.page_token][] to obtain that
/// page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for \[NotebookService.DeleteNotebookExecutionJob\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteNotebookExecutionJobRequest {
/// Required. The name of the NotebookExecutionJob resource to be deleted.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Views for Get/List NotebookExecutionJob
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum NotebookExecutionJobView {
/// When unspecified, the API defaults to the BASIC view.
Unspecified = 0,
/// Includes all fields except for direct notebook inputs.
Basic = 1,
/// Includes all fields.
Full = 2,
}
impl NotebookExecutionJobView {
/// 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 {
NotebookExecutionJobView::Unspecified => {
"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED"
}
NotebookExecutionJobView::Basic => "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
NotebookExecutionJobView::Full => "NOTEBOOK_EXECUTION_JOB_VIEW_FULL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED" => Some(Self::Unspecified),
"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC" => Some(Self::Basic),
"NOTEBOOK_EXECUTION_JOB_VIEW_FULL" => Some(Self::Full),
_ => None,
}
}
}
/// Generated client implementations.
pub mod notebook_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The interface for Vertex Notebook service (a.k.a. Colab on Workbench).
#[derive(Debug, Clone)]
pub struct NotebookServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> NotebookServiceClient<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,
) -> NotebookServiceClient<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,
{
NotebookServiceClient::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 NotebookRuntimeTemplate.
pub async fn create_notebook_runtime_template(
&mut self,
request: impl tonic::IntoRequest<super::CreateNotebookRuntimeTemplateRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.NotebookService/CreateNotebookRuntimeTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"CreateNotebookRuntimeTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a NotebookRuntimeTemplate.
pub async fn get_notebook_runtime_template(
&mut self,
request: impl tonic::IntoRequest<super::GetNotebookRuntimeTemplateRequest>,
) -> std::result::Result<
tonic::Response<super::NotebookRuntimeTemplate>,
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.aiplatform.v1.NotebookService/GetNotebookRuntimeTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"GetNotebookRuntimeTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists NotebookRuntimeTemplates in a Location.
pub async fn list_notebook_runtime_templates(
&mut self,
request: impl tonic::IntoRequest<super::ListNotebookRuntimeTemplatesRequest>,
) -> std::result::Result<
tonic::Response<super::ListNotebookRuntimeTemplatesResponse>,
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.aiplatform.v1.NotebookService/ListNotebookRuntimeTemplates",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"ListNotebookRuntimeTemplates",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a NotebookRuntimeTemplate.
pub async fn delete_notebook_runtime_template(
&mut self,
request: impl tonic::IntoRequest<super::DeleteNotebookRuntimeTemplateRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.NotebookService/DeleteNotebookRuntimeTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"DeleteNotebookRuntimeTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a NotebookRuntimeTemplate.
pub async fn update_notebook_runtime_template(
&mut self,
request: impl tonic::IntoRequest<super::UpdateNotebookRuntimeTemplateRequest>,
) -> std::result::Result<
tonic::Response<super::NotebookRuntimeTemplate>,
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.aiplatform.v1.NotebookService/UpdateNotebookRuntimeTemplate",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"UpdateNotebookRuntimeTemplate",
),
);
self.inner.unary(req, path, codec).await
}
/// Assigns a NotebookRuntime to a user for a particular Notebook file. This
/// method will either returns an existing assignment or generates a new one.
pub async fn assign_notebook_runtime(
&mut self,
request: impl tonic::IntoRequest<super::AssignNotebookRuntimeRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.NotebookService/AssignNotebookRuntime",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"AssignNotebookRuntime",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a NotebookRuntime.
pub async fn get_notebook_runtime(
&mut self,
request: impl tonic::IntoRequest<super::GetNotebookRuntimeRequest>,
) -> std::result::Result<
tonic::Response<super::NotebookRuntime>,
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.aiplatform.v1.NotebookService/GetNotebookRuntime",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"GetNotebookRuntime",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists NotebookRuntimes in a Location.
pub async fn list_notebook_runtimes(
&mut self,
request: impl tonic::IntoRequest<super::ListNotebookRuntimesRequest>,
) -> std::result::Result<
tonic::Response<super::ListNotebookRuntimesResponse>,
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.aiplatform.v1.NotebookService/ListNotebookRuntimes",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"ListNotebookRuntimes",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a NotebookRuntime.
pub async fn delete_notebook_runtime(
&mut self,
request: impl tonic::IntoRequest<super::DeleteNotebookRuntimeRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.NotebookService/DeleteNotebookRuntime",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"DeleteNotebookRuntime",
),
);
self.inner.unary(req, path, codec).await
}
/// Upgrades a NotebookRuntime.
pub async fn upgrade_notebook_runtime(
&mut self,
request: impl tonic::IntoRequest<super::UpgradeNotebookRuntimeRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.NotebookService/UpgradeNotebookRuntime",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"UpgradeNotebookRuntime",
),
);
self.inner.unary(req, path, codec).await
}
/// Starts a NotebookRuntime.
pub async fn start_notebook_runtime(
&mut self,
request: impl tonic::IntoRequest<super::StartNotebookRuntimeRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.NotebookService/StartNotebookRuntime",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"StartNotebookRuntime",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a NotebookExecutionJob.
pub async fn create_notebook_execution_job(
&mut self,
request: impl tonic::IntoRequest<super::CreateNotebookExecutionJobRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.NotebookService/CreateNotebookExecutionJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"CreateNotebookExecutionJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a NotebookExecutionJob.
pub async fn get_notebook_execution_job(
&mut self,
request: impl tonic::IntoRequest<super::GetNotebookExecutionJobRequest>,
) -> std::result::Result<
tonic::Response<super::NotebookExecutionJob>,
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.aiplatform.v1.NotebookService/GetNotebookExecutionJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"GetNotebookExecutionJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists NotebookExecutionJobs in a Location.
pub async fn list_notebook_execution_jobs(
&mut self,
request: impl tonic::IntoRequest<super::ListNotebookExecutionJobsRequest>,
) -> std::result::Result<
tonic::Response<super::ListNotebookExecutionJobsResponse>,
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.aiplatform.v1.NotebookService/ListNotebookExecutionJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"ListNotebookExecutionJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a NotebookExecutionJob.
pub async fn delete_notebook_execution_job(
&mut self,
request: impl tonic::IntoRequest<super::DeleteNotebookExecutionJobRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.NotebookService/DeleteNotebookExecutionJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.NotebookService",
"DeleteNotebookExecutionJob",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Instance of a general artifact.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Artifact {
/// Output only. The resource name of the Artifact.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// User provided display name of the Artifact.
/// May be up to 128 Unicode characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The uniform resource identifier of the artifact file.
/// May be empty if there is no actual artifact file.
#[prost(string, tag = "6")]
pub uri: ::prost::alloc::string::String,
/// An eTag used to perform consistent read-modify-write updates. If not set, a
/// blind "overwrite" update happens.
#[prost(string, tag = "9")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize your Artifacts.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one Artifact (System
/// labels are excluded).
#[prost(btree_map = "string, string", tag = "10")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this Artifact was created.
#[prost(message, optional, tag = "11")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Artifact was last updated.
#[prost(message, optional, tag = "12")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The state of this Artifact. This is a property of the Artifact, and does
/// not imply or capture any ongoing process. This property is managed by
/// clients (such as Vertex AI Pipelines), and the system does not prescribe
/// or check the validity of state transitions.
#[prost(enumeration = "artifact::State", tag = "13")]
pub state: i32,
/// The title of the schema describing the metadata.
///
/// Schema title and version is expected to be registered in earlier Create
/// Schema calls. And both are used together as unique identifiers to identify
/// schemas within the local metadata store.
#[prost(string, tag = "14")]
pub schema_title: ::prost::alloc::string::String,
/// The version of the schema in schema_name to use.
///
/// Schema title and version is expected to be registered in earlier Create
/// Schema calls. And both are used together as unique identifiers to identify
/// schemas within the local metadata store.
#[prost(string, tag = "15")]
pub schema_version: ::prost::alloc::string::String,
/// Properties of the Artifact.
/// Top level metadata keys' heading and trailing spaces will be trimmed.
/// The size of this field should not exceed 200KB.
#[prost(message, optional, tag = "16")]
pub metadata: ::core::option::Option<::prost_types::Struct>,
/// Description of the Artifact
#[prost(string, tag = "17")]
pub description: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Artifact`.
pub mod artifact {
/// Describes the state of the Artifact.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified state for the Artifact.
Unspecified = 0,
/// A state used by systems like Vertex AI Pipelines to indicate that the
/// underlying data item represented by this Artifact is being created.
Pending = 1,
/// A state indicating that the Artifact should exist, unless something
/// external to the system deletes it.
Live = 2,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Pending => "PENDING",
State::Live => "LIVE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"PENDING" => Some(Self::Pending),
"LIVE" => Some(Self::Live),
_ => None,
}
}
}
}
/// Instance of a general context.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Context {
/// Immutable. The resource name of the Context.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// User provided display name of the Context.
/// May be up to 128 Unicode characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// An eTag used to perform consistent read-modify-write updates. If not set, a
/// blind "overwrite" update happens.
#[prost(string, tag = "8")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize your Contexts.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one Context (System
/// labels are excluded).
#[prost(btree_map = "string, string", tag = "9")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this Context was created.
#[prost(message, optional, tag = "10")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Context was last updated.
#[prost(message, optional, tag = "11")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. A list of resource names of Contexts that are parents of this
/// Context. A Context may have at most 10 parent_contexts.
#[prost(string, repeated, tag = "12")]
pub parent_contexts: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The title of the schema describing the metadata.
///
/// Schema title and version is expected to be registered in earlier Create
/// Schema calls. And both are used together as unique identifiers to identify
/// schemas within the local metadata store.
#[prost(string, tag = "13")]
pub schema_title: ::prost::alloc::string::String,
/// The version of the schema in schema_name to use.
///
/// Schema title and version is expected to be registered in earlier Create
/// Schema calls. And both are used together as unique identifiers to identify
/// schemas within the local metadata store.
#[prost(string, tag = "14")]
pub schema_version: ::prost::alloc::string::String,
/// Properties of the Context.
/// Top level metadata keys' heading and trailing spaces will be trimmed.
/// The size of this field should not exceed 200KB.
#[prost(message, optional, tag = "15")]
pub metadata: ::core::option::Option<::prost_types::Struct>,
/// Description of the Context
#[prost(string, tag = "16")]
pub description: ::prost::alloc::string::String,
}
/// Instance of a general execution.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Execution {
/// Output only. The resource name of the Execution.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// User provided display name of the Execution.
/// May be up to 128 Unicode characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The state of this Execution. This is a property of the Execution, and does
/// not imply or capture any ongoing process. This property is managed by
/// clients (such as Vertex AI Pipelines) and the system does not prescribe
/// or check the validity of state transitions.
#[prost(enumeration = "execution::State", tag = "6")]
pub state: i32,
/// An eTag used to perform consistent read-modify-write updates. If not set, a
/// blind "overwrite" update happens.
#[prost(string, tag = "9")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize your Executions.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one Execution (System
/// labels are excluded).
#[prost(btree_map = "string, string", tag = "10")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this Execution was created.
#[prost(message, optional, tag = "11")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Execution was last updated.
#[prost(message, optional, tag = "12")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The title of the schema describing the metadata.
///
/// Schema title and version is expected to be registered in earlier Create
/// Schema calls. And both are used together as unique identifiers to identify
/// schemas within the local metadata store.
#[prost(string, tag = "13")]
pub schema_title: ::prost::alloc::string::String,
/// The version of the schema in `schema_title` to use.
///
/// Schema title and version is expected to be registered in earlier Create
/// Schema calls. And both are used together as unique identifiers to identify
/// schemas within the local metadata store.
#[prost(string, tag = "14")]
pub schema_version: ::prost::alloc::string::String,
/// Properties of the Execution.
/// Top level metadata keys' heading and trailing spaces will be trimmed.
/// The size of this field should not exceed 200KB.
#[prost(message, optional, tag = "15")]
pub metadata: ::core::option::Option<::prost_types::Struct>,
/// Description of the Execution
#[prost(string, tag = "16")]
pub description: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Execution`.
pub mod execution {
/// Describes the state of the Execution.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified Execution state
Unspecified = 0,
/// The Execution is new
New = 1,
/// The Execution is running
Running = 2,
/// The Execution has finished running
Complete = 3,
/// The Execution has failed
Failed = 4,
/// The Execution completed through Cache hit.
Cached = 5,
/// The Execution was cancelled.
Cancelled = 6,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::New => "NEW",
State::Running => "RUNNING",
State::Complete => "COMPLETE",
State::Failed => "FAILED",
State::Cached => "CACHED",
State::Cancelled => "CANCELLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"NEW" => Some(Self::New),
"RUNNING" => Some(Self::Running),
"COMPLETE" => Some(Self::Complete),
"FAILED" => Some(Self::Failed),
"CACHED" => Some(Self::Cached),
"CANCELLED" => Some(Self::Cancelled),
_ => None,
}
}
}
}
/// Represents the failure policy of a pipeline. Currently, the default of a
/// pipeline is that the pipeline will continue to run until no more tasks can be
/// executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a
/// pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling
/// any new tasks when a task has failed. Any scheduled tasks will continue to
/// completion.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PipelineFailurePolicy {
/// Default value, and follows fail slow behavior.
Unspecified = 0,
/// Indicates that the pipeline should continue to run until all possible
/// tasks have been scheduled and completed.
FailSlow = 1,
/// Indicates that the pipeline should stop scheduling new tasks after a task
/// has failed.
FailFast = 2,
}
impl PipelineFailurePolicy {
/// 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 {
PipelineFailurePolicy::Unspecified => "PIPELINE_FAILURE_POLICY_UNSPECIFIED",
PipelineFailurePolicy::FailSlow => "PIPELINE_FAILURE_POLICY_FAIL_SLOW",
PipelineFailurePolicy::FailFast => "PIPELINE_FAILURE_POLICY_FAIL_FAST",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PIPELINE_FAILURE_POLICY_UNSPECIFIED" => Some(Self::Unspecified),
"PIPELINE_FAILURE_POLICY_FAIL_SLOW" => Some(Self::FailSlow),
"PIPELINE_FAILURE_POLICY_FAIL_FAST" => Some(Self::FailFast),
_ => None,
}
}
}
/// Describes the state of a pipeline.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PipelineState {
/// The pipeline state is unspecified.
Unspecified = 0,
/// The pipeline has been created or resumed, and processing has not yet
/// begun.
Queued = 1,
/// The service is preparing to run the pipeline.
Pending = 2,
/// The pipeline is in progress.
Running = 3,
/// The pipeline completed successfully.
Succeeded = 4,
/// The pipeline failed.
Failed = 5,
/// The pipeline is being cancelled. From this state, the pipeline may only go
/// to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or
/// PIPELINE_STATE_CANCELLED.
Cancelling = 6,
/// The pipeline has been cancelled.
Cancelled = 7,
/// The pipeline has been stopped, and can be resumed.
Paused = 8,
}
impl PipelineState {
/// 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 {
PipelineState::Unspecified => "PIPELINE_STATE_UNSPECIFIED",
PipelineState::Queued => "PIPELINE_STATE_QUEUED",
PipelineState::Pending => "PIPELINE_STATE_PENDING",
PipelineState::Running => "PIPELINE_STATE_RUNNING",
PipelineState::Succeeded => "PIPELINE_STATE_SUCCEEDED",
PipelineState::Failed => "PIPELINE_STATE_FAILED",
PipelineState::Cancelling => "PIPELINE_STATE_CANCELLING",
PipelineState::Cancelled => "PIPELINE_STATE_CANCELLED",
PipelineState::Paused => "PIPELINE_STATE_PAUSED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PIPELINE_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"PIPELINE_STATE_QUEUED" => Some(Self::Queued),
"PIPELINE_STATE_PENDING" => Some(Self::Pending),
"PIPELINE_STATE_RUNNING" => Some(Self::Running),
"PIPELINE_STATE_SUCCEEDED" => Some(Self::Succeeded),
"PIPELINE_STATE_FAILED" => Some(Self::Failed),
"PIPELINE_STATE_CANCELLING" => Some(Self::Cancelling),
"PIPELINE_STATE_CANCELLED" => Some(Self::Cancelled),
"PIPELINE_STATE_PAUSED" => Some(Self::Paused),
_ => None,
}
}
}
/// Value is the value of the field.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Value {
#[prost(oneof = "value::Value", tags = "1, 2, 3")]
pub value: ::core::option::Option<value::Value>,
}
/// Nested message and enum types in `Value`.
pub mod value {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Value {
/// An integer value.
#[prost(int64, tag = "1")]
IntValue(i64),
/// A double value.
#[prost(double, tag = "2")]
DoubleValue(f64),
/// A string value.
#[prost(string, tag = "3")]
StringValue(::prost::alloc::string::String),
}
}
/// An instance of a machine learning PipelineJob.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PipelineJob {
/// Output only. The resource name of the PipelineJob.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The display name of the Pipeline.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Output only. Pipeline creation time.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Pipeline start time.
#[prost(message, optional, tag = "4")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Pipeline end time.
#[prost(message, optional, tag = "5")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this PipelineJob was most recently updated.
#[prost(message, optional, tag = "6")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The spec of the pipeline.
#[prost(message, optional, tag = "7")]
pub pipeline_spec: ::core::option::Option<::prost_types::Struct>,
/// Output only. The detailed state of the job.
#[prost(enumeration = "PipelineState", tag = "8")]
pub state: i32,
/// Output only. The details of pipeline run. Not available in the list view.
#[prost(message, optional, tag = "9")]
pub job_detail: ::core::option::Option<PipelineJobDetail>,
/// Output only. The error that occurred during pipeline execution.
/// Only populated when the pipeline's state is FAILED or CANCELLED.
#[prost(message, optional, tag = "10")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// The labels with user-defined metadata to organize PipelineJob.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
///
/// Note there is some reserved label key for Vertex AI Pipelines.
/// - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
#[prost(btree_map = "string, string", tag = "11")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Runtime config of the pipeline.
#[prost(message, optional, tag = "12")]
pub runtime_config: ::core::option::Option<pipeline_job::RuntimeConfig>,
/// Customer-managed encryption key spec for a pipelineJob. If set, this
/// PipelineJob and all of its sub-resources will be secured by this key.
#[prost(message, optional, tag = "16")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// The service account that the pipeline workload runs as.
/// If not specified, the Compute Engine default service account in the project
/// will be used.
/// See
/// <https://cloud.google.com/compute/docs/access/service-accounts#default_service_account>
///
/// Users starting the pipeline must have the `iam.serviceAccounts.actAs`
/// permission on this service account.
#[prost(string, tag = "17")]
pub service_account: ::prost::alloc::string::String,
/// The full name of the Compute Engine
/// [network](/compute/docs/networks-and-firewalls#networks) to which the
/// Pipeline Job's workload should be peered. For example,
/// `projects/12345/global/networks/myVPC`.
/// [Format](/compute/docs/reference/rest/v1/networks/insert)
/// is of the form `projects/{project}/global/networks/{network}`.
/// Where {project} is a project number, as in `12345`, and {network} is a
/// network name.
///
/// Private services access must already be configured for the network.
/// Pipeline job will apply the network configuration to the Google Cloud
/// resources being launched, if applied, such as Vertex AI
/// Training or Dataflow job. If left unspecified, the workload is not peered
/// with any network.
#[prost(string, tag = "18")]
pub network: ::prost::alloc::string::String,
/// A list of names for the reserved ip ranges under the VPC network
/// that can be used for this Pipeline Job's workload.
///
/// If set, we will deploy the Pipeline Job's workload within the provided ip
/// ranges. Otherwise, the job will be deployed to any ip ranges under the
/// provided VPC network.
///
/// Example: \['vertex-ai-ip-range'\].
#[prost(string, repeated, tag = "25")]
pub reserved_ip_ranges: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// A template uri from where the
/// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec],
/// if empty, will be downloaded. Currently, only uri from Vertex Template
/// Registry & Gallery is supported. Reference to
/// <https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.>
#[prost(string, tag = "19")]
pub template_uri: ::prost::alloc::string::String,
/// Output only. Pipeline template metadata. Will fill up fields if
/// [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
/// is from supported template registry.
#[prost(message, optional, tag = "20")]
pub template_metadata: ::core::option::Option<PipelineTemplateMetadata>,
/// Output only. The schedule resource name.
/// Only returned if the Pipeline is created by Schedule API.
#[prost(string, tag = "22")]
pub schedule_name: ::prost::alloc::string::String,
/// Optional. Whether to do component level validations before job creation.
#[prost(bool, tag = "26")]
pub preflight_validations: bool,
}
/// Nested message and enum types in `PipelineJob`.
pub mod pipeline_job {
/// The runtime config of a PipelineJob.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RuntimeConfig {
/// Deprecated. Use
/// [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values]
/// instead. The runtime parameters of the PipelineJob. The parameters will
/// be passed into
/// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
/// to replace the placeholders at runtime. This field is used by pipelines
/// built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
/// such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
#[prost(btree_map = "string, message", tag = "1")]
pub parameters: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
super::Value,
>,
/// Required. A path in a Cloud Storage bucket, which will be treated as the
/// root output directory of the pipeline. It is used by the system to
/// generate the paths of output artifacts. The artifact paths are generated
/// with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
/// specified output directory. The service account specified in this
/// pipeline must have the `storage.objects.get` and `storage.objects.create`
/// permissions for this bucket.
#[prost(string, tag = "2")]
pub gcs_output_directory: ::prost::alloc::string::String,
/// The runtime parameters of the PipelineJob. The parameters will be
/// passed into
/// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
/// to replace the placeholders at runtime. This field is used by pipelines
/// built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
/// pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
/// DSL.
#[prost(btree_map = "string, message", tag = "3")]
pub parameter_values: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost_types::Value,
>,
/// Represents the failure policy of a pipeline. Currently, the default of a
/// pipeline is that the pipeline will continue to run until no more tasks
/// can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
/// However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
/// will stop scheduling any new tasks when a task has failed. Any scheduled
/// tasks will continue to completion.
#[prost(enumeration = "super::PipelineFailurePolicy", tag = "4")]
pub failure_policy: i32,
/// The runtime artifacts of the PipelineJob. The key will be the input
/// artifact name and the value would be one of the InputArtifact.
#[prost(btree_map = "string, message", tag = "5")]
pub input_artifacts: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
runtime_config::InputArtifact,
>,
}
/// Nested message and enum types in `RuntimeConfig`.
pub mod runtime_config {
/// The type of an input artifact.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InputArtifact {
#[prost(oneof = "input_artifact::Kind", tags = "1")]
pub kind: ::core::option::Option<input_artifact::Kind>,
}
/// Nested message and enum types in `InputArtifact`.
pub mod input_artifact {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
/// Artifact resource id from MLMD. Which is the last portion of an
/// artifact resource name:
/// `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
/// The artifact must stay within the same project, location and default
/// metadatastore as the pipeline.
#[prost(string, tag = "1")]
ArtifactId(::prost::alloc::string::String),
}
}
}
}
/// Pipeline template metadata if
/// [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
/// is from supported template registry. Currently, the only supported registry
/// is Artifact Registry.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PipelineTemplateMetadata {
/// The version_name in artifact registry.
///
/// Will always be presented in output if the
/// [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
/// is from supported template registry.
///
/// Format is "sha256:abcdef123456...".
#[prost(string, tag = "3")]
pub version: ::prost::alloc::string::String,
}
/// The runtime detail of PipelineJob.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PipelineJobDetail {
/// Output only. The context of the pipeline.
#[prost(message, optional, tag = "1")]
pub pipeline_context: ::core::option::Option<Context>,
/// Output only. The context of the current pipeline run.
#[prost(message, optional, tag = "2")]
pub pipeline_run_context: ::core::option::Option<Context>,
/// Output only. The runtime details of the tasks under the pipeline.
#[prost(message, repeated, tag = "3")]
pub task_details: ::prost::alloc::vec::Vec<PipelineTaskDetail>,
}
/// The runtime detail of a task execution.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PipelineTaskDetail {
/// Output only. The system generated ID of the task.
#[prost(int64, tag = "1")]
pub task_id: i64,
/// Output only. The id of the parent task if the task is within a component
/// scope. Empty if the task is at the root level.
#[prost(int64, tag = "12")]
pub parent_task_id: i64,
/// Output only. The user specified name of the task that is defined in
/// [pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec].
#[prost(string, tag = "2")]
pub task_name: ::prost::alloc::string::String,
/// Output only. Task create time.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Task start time.
#[prost(message, optional, tag = "4")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Task end time.
#[prost(message, optional, tag = "5")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The detailed execution info.
#[prost(message, optional, tag = "6")]
pub executor_detail: ::core::option::Option<PipelineTaskExecutorDetail>,
/// Output only. State of the task.
#[prost(enumeration = "pipeline_task_detail::State", tag = "7")]
pub state: i32,
/// Output only. The execution metadata of the task.
#[prost(message, optional, tag = "8")]
pub execution: ::core::option::Option<Execution>,
/// Output only. The error that occurred during task execution.
/// Only populated when the task's state is FAILED or CANCELLED.
#[prost(message, optional, tag = "9")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// Output only. A list of task status. This field keeps a record of task
/// status evolving over time.
#[prost(message, repeated, tag = "13")]
pub pipeline_task_status: ::prost::alloc::vec::Vec<
pipeline_task_detail::PipelineTaskStatus,
>,
/// Output only. The runtime input artifacts of the task.
#[prost(btree_map = "string, message", tag = "10")]
pub inputs: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
pipeline_task_detail::ArtifactList,
>,
/// Output only. The runtime output artifacts of the task.
#[prost(btree_map = "string, message", tag = "11")]
pub outputs: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
pipeline_task_detail::ArtifactList,
>,
}
/// Nested message and enum types in `PipelineTaskDetail`.
pub mod pipeline_task_detail {
/// A single record of the task status.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PipelineTaskStatus {
/// Output only. Update time of this status.
#[prost(message, optional, tag = "1")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The state of the task.
#[prost(enumeration = "State", tag = "2")]
pub state: i32,
/// Output only. The error that occurred during the state. May be set when
/// the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or
/// FAILED state. If the state is FAILED, the error here is final and not
/// going to be retried. If the state is a non-final state, the error
/// indicates a system-error being retried.
#[prost(message, optional, tag = "3")]
pub error: ::core::option::Option<super::super::super::super::rpc::Status>,
}
/// A list of artifact metadata.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ArtifactList {
/// Output only. A list of artifact metadata.
#[prost(message, repeated, tag = "1")]
pub artifacts: ::prost::alloc::vec::Vec<super::Artifact>,
}
/// Specifies state of TaskExecution
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified.
Unspecified = 0,
/// Specifies pending state for the task.
Pending = 1,
/// Specifies task is being executed.
Running = 2,
/// Specifies task completed successfully.
Succeeded = 3,
/// Specifies Task cancel is in pending state.
CancelPending = 4,
/// Specifies task is being cancelled.
Cancelling = 5,
/// Specifies task was cancelled.
Cancelled = 6,
/// Specifies task failed.
Failed = 7,
/// Specifies task was skipped due to cache hit.
Skipped = 8,
/// Specifies that the task was not triggered because the task's trigger
/// policy is not satisfied. The trigger policy is specified in the
/// `condition` field of
/// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec].
NotTriggered = 9,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Pending => "PENDING",
State::Running => "RUNNING",
State::Succeeded => "SUCCEEDED",
State::CancelPending => "CANCEL_PENDING",
State::Cancelling => "CANCELLING",
State::Cancelled => "CANCELLED",
State::Failed => "FAILED",
State::Skipped => "SKIPPED",
State::NotTriggered => "NOT_TRIGGERED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"PENDING" => Some(Self::Pending),
"RUNNING" => Some(Self::Running),
"SUCCEEDED" => Some(Self::Succeeded),
"CANCEL_PENDING" => Some(Self::CancelPending),
"CANCELLING" => Some(Self::Cancelling),
"CANCELLED" => Some(Self::Cancelled),
"FAILED" => Some(Self::Failed),
"SKIPPED" => Some(Self::Skipped),
"NOT_TRIGGERED" => Some(Self::NotTriggered),
_ => None,
}
}
}
}
/// The runtime detail of a pipeline executor.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PipelineTaskExecutorDetail {
#[prost(oneof = "pipeline_task_executor_detail::Details", tags = "1, 2")]
pub details: ::core::option::Option<pipeline_task_executor_detail::Details>,
}
/// Nested message and enum types in `PipelineTaskExecutorDetail`.
pub mod pipeline_task_executor_detail {
/// The detail of a container execution. It contains the job names of the
/// lifecycle of a container execution.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ContainerDetail {
/// Output only. The name of the
/// [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container
/// execution.
#[prost(string, tag = "1")]
pub main_job: ::prost::alloc::string::String,
/// Output only. The name of the
/// [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the
/// pre-caching-check container execution. This job will be available if the
/// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
/// specifies the `pre_caching_check` hook in the lifecycle events.
#[prost(string, tag = "2")]
pub pre_caching_check_job: ::prost::alloc::string::String,
/// Output only. The names of the previously failed
/// [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container
/// executions. The list includes the all attempts in chronological order.
#[prost(string, repeated, tag = "3")]
pub failed_main_jobs: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Output only. The names of the previously failed
/// [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the
/// pre-caching-check container executions. This job will be available if the
/// [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
/// specifies the `pre_caching_check` hook in the lifecycle events. The list
/// includes the all attempts in chronological order.
#[prost(string, repeated, tag = "4")]
pub failed_pre_caching_check_jobs: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
/// The detailed info for a custom job executor.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CustomJobDetail {
/// Output only. The name of the
/// [CustomJob][google.cloud.aiplatform.v1.CustomJob].
#[prost(string, tag = "1")]
pub job: ::prost::alloc::string::String,
/// Output only. The names of the previously failed
/// [CustomJob][google.cloud.aiplatform.v1.CustomJob]. The list includes the
/// all attempts in chronological order.
#[prost(string, repeated, tag = "3")]
pub failed_jobs: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Details {
/// Output only. The detailed info for a container executor.
#[prost(message, tag = "1")]
ContainerDetail(ContainerDetail),
/// Output only. The detailed info for a custom job executor.
#[prost(message, tag = "2")]
CustomJobDetail(CustomJobDetail),
}
}
/// Represents an environment variable present in a Container or Python Module.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnvVar {
/// Required. Name of the environment variable. Must be a valid C identifier.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. Variables that reference a $(VAR_NAME) are expanded
/// using the previous defined environment variables in the container and
/// any service environment variables. If a variable cannot be resolved,
/// the reference in the input string will be unchanged. The $(VAR_NAME)
/// syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped
/// references will never be expanded, regardless of whether the variable
/// exists or not.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
}
/// A trained machine learning Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Model {
/// The resource name of the Model.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Immutable. The version ID of the model.
/// A new version is committed when a new model version is uploaded or
/// trained under an existing model id. It is an auto-incrementing decimal
/// number in string representation.
#[prost(string, tag = "28")]
pub version_id: ::prost::alloc::string::String,
/// User provided version aliases so that a model version can be referenced via
/// alias (i.e.
/// `projects/{project}/locations/{location}/models/{model_id}@{version_alias}`
/// instead of auto-generated version id (i.e.
/// `projects/{project}/locations/{location}/models/{model_id}@{version_id})`.
/// The format is [a-z][a-zA-Z0-9-]{0,126}\[a-z0-9\] to distinguish from
/// version_id. A default version alias will be created for the first version
/// of the model, and there must be exactly one default version alias for a
/// model.
#[prost(string, repeated, tag = "29")]
pub version_aliases: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Output only. Timestamp when this version was created.
#[prost(message, optional, tag = "31")]
pub version_create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this version was most recently updated.
#[prost(message, optional, tag = "32")]
pub version_update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Required. The display name of the Model.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The description of the Model.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// The description of this version.
#[prost(string, tag = "30")]
pub version_description: ::prost::alloc::string::String,
/// The schemata that describe formats of the Model's predictions and
/// explanations as given and returned via
/// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
/// and
/// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
#[prost(message, optional, tag = "4")]
pub predict_schemata: ::core::option::Option<PredictSchemata>,
/// Immutable. Points to a YAML file stored on Google Cloud Storage describing
/// additional information about the Model, that is specific to it. Unset if
/// the Model does not have any additional information. The schema is defined
/// as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// AutoML Models always have this field populated by Vertex AI, if no
/// additional metadata is needed, this field is set to an empty string.
/// Note: The URI given on output will be immutable and probably different,
/// including the URI scheme, than the one given on input. The output URI will
/// point to a location where the user only has a read access.
#[prost(string, tag = "5")]
pub metadata_schema_uri: ::prost::alloc::string::String,
/// Immutable. An additional information about the Model; the schema of the
/// metadata can be found in
/// [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri].
/// Unset if the Model does not have any additional information.
#[prost(message, optional, tag = "6")]
pub metadata: ::core::option::Option<::prost_types::Value>,
/// Output only. The formats in which this Model may be exported. If empty,
/// this Model is not available for export.
#[prost(message, repeated, tag = "20")]
pub supported_export_formats: ::prost::alloc::vec::Vec<model::ExportFormat>,
/// Output only. The resource name of the TrainingPipeline that uploaded this
/// Model, if any.
#[prost(string, tag = "7")]
pub training_pipeline: ::prost::alloc::string::String,
/// Optional. This field is populated if the model is produced by a pipeline
/// job.
#[prost(string, tag = "47")]
pub pipeline_job: ::prost::alloc::string::String,
/// Input only. The specification of the container that is to be used when
/// deploying this Model. The specification is ingested upon
/// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel],
/// and all binaries it contains are copied and stored internally by Vertex AI.
/// Not required for AutoML Models.
#[prost(message, optional, tag = "9")]
pub container_spec: ::core::option::Option<ModelContainerSpec>,
/// Immutable. The path to the directory containing the Model artifact and any
/// of its supporting files. Not required for AutoML Models.
#[prost(string, tag = "26")]
pub artifact_uri: ::prost::alloc::string::String,
/// Output only. When this Model is deployed, its prediction resources are
/// described by the `prediction_resources` field of the
/// [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
/// object. Because not all Models support all resource configuration types,
/// the configuration types this Model supports are listed here. If no
/// configuration types are listed, the Model cannot be deployed to an
/// [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support
/// online predictions
/// ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
/// or
/// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]).
/// Such a Model can serve predictions by using a
/// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it
/// has at least one entry each in
/// [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats]
/// and
/// [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
#[prost(
enumeration = "model::DeploymentResourcesType",
repeated,
packed = "false",
tag = "10"
)]
pub supported_deployment_resources_types: ::prost::alloc::vec::Vec<i32>,
/// Output only. The formats this Model supports in
/// [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
/// If
/// [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
/// exists, the instances should be given as per that schema.
///
/// The possible formats are:
///
/// * `jsonl`
/// The JSON Lines format, where each instance is a single line. Uses
/// [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
///
/// * `csv`
/// The CSV format, where each instance is a single comma-separated line.
/// The first line in the file is the header, containing comma-separated field
/// names. Uses
/// [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
///
/// * `tf-record`
/// The TFRecord format, where each instance is a single record in tfrecord
/// syntax. Uses
/// [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
///
/// * `tf-record-gzip`
/// Similar to `tf-record`, but the file is gzipped. Uses
/// [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
///
/// * `bigquery`
/// Each instance is a single row in BigQuery. Uses
/// [BigQuerySource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.bigquery_source].
///
/// * `file-list`
/// Each line of the file is the location of an instance to process, uses
/// `gcs_source` field of the
/// [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig]
/// object.
///
///
/// If this Model doesn't support any of these formats it means it cannot be
/// used with a
/// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
/// However, if it has
/// [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types],
/// it could serve online predictions by using
/// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
/// or
/// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
#[prost(string, repeated, tag = "11")]
pub supported_input_storage_formats: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// Output only. The formats this Model supports in
/// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
/// If both
/// [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
/// and
/// [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri]
/// exist, the predictions are returned together with their instances. In other
/// words, the prediction has the original instance data first, followed by the
/// actual prediction content (as per the schema).
///
/// The possible formats are:
///
/// * `jsonl`
/// The JSON Lines format, where each prediction is a single line. Uses
/// [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination].
///
/// * `csv`
/// The CSV format, where each prediction is a single comma-separated line.
/// The first line in the file is the header, containing comma-separated field
/// names. Uses
/// [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination].
///
/// * `bigquery`
/// Each prediction is a single row in a BigQuery table, uses
/// [BigQueryDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.bigquery_destination]
/// .
///
///
/// If this Model doesn't support any of these formats it means it cannot be
/// used with a
/// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
/// However, if it has
/// [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types],
/// it could serve online predictions by using
/// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
/// or
/// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
#[prost(string, repeated, tag = "12")]
pub supported_output_storage_formats: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this Model was uploaded into Vertex AI.
#[prost(message, optional, tag = "13")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Model was most recently updated.
#[prost(message, optional, tag = "14")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The pointers to DeployedModels created from this Model. Note
/// that Model could have been deployed to Endpoints in different Locations.
#[prost(message, repeated, tag = "15")]
pub deployed_models: ::prost::alloc::vec::Vec<DeployedModelRef>,
/// The default explanation specification for this Model.
///
/// The Model can be used for
/// [requesting
/// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after
/// being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if
/// it is populated. The Model can be used for [batch
/// explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
/// if it is populated.
///
/// All fields of the explanation_spec can be overridden by
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
/// of
/// [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model],
/// or
/// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
/// of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
///
/// If the default explanation specification is not set for this Model, this
/// Model can still be used for
/// [requesting
/// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by
/// setting
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
/// of
/// [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model]
/// and for [batch
/// explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
/// by setting
/// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
/// of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
#[prost(message, optional, tag = "23")]
pub explanation_spec: ::core::option::Option<ExplanationSpec>,
/// Used to perform consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "16")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize your Models.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "17")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Stats of data used for training or evaluating the Model.
///
/// Only populated when the Model is trained by a TrainingPipeline with
/// [data_input_config][TrainingPipeline.data_input_config].
#[prost(message, optional, tag = "21")]
pub data_stats: ::core::option::Option<model::DataStats>,
/// Customer-managed encryption key spec for a Model. If set, this
/// Model and all sub-resources of this Model will be secured by this key.
#[prost(message, optional, tag = "24")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. Source of a model. It can either be automl training pipeline,
/// custom training pipeline, BigQuery ML, or saved and tuned from Genie or
/// Model Garden.
#[prost(message, optional, tag = "38")]
pub model_source_info: ::core::option::Option<ModelSourceInfo>,
/// Output only. If this Model is a copy of another Model, this contains info
/// about the original.
#[prost(message, optional, tag = "34")]
pub original_model_info: ::core::option::Option<model::OriginalModelInfo>,
/// Output only. The resource name of the Artifact that was created in
/// MetadataStore when creating the Model. The Artifact resource name pattern
/// is
/// `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
#[prost(string, tag = "44")]
pub metadata_artifact: ::prost::alloc::string::String,
/// Optional. User input field to specify the base model source. Currently it
/// only supports specifing the Model Garden models and Genie models.
#[prost(message, optional, tag = "50")]
pub base_model_source: ::core::option::Option<model::BaseModelSource>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "51")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "52")]
pub satisfies_pzi: bool,
}
/// Nested message and enum types in `Model`.
pub mod model {
/// Represents export format supported by the Model.
/// All formats export to Google Cloud Storage.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportFormat {
/// Output only. The ID of the export format.
/// The possible format IDs are:
///
/// * `tflite`
/// Used for Android mobile devices.
///
/// * `edgetpu-tflite`
/// Used for [Edge TPU](<https://cloud.google.com/edge-tpu/>) devices.
///
/// * `tf-saved-model`
/// A tensorflow model in SavedModel format.
///
/// * `tf-js`
/// A [TensorFlow.js](<https://www.tensorflow.org/js>) model that can be used
/// in the browser and in Node.js using JavaScript.
///
/// * `core-ml`
/// Used for iOS mobile devices.
///
/// * `custom-trained`
/// A Model that was uploaded or trained by custom code.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Output only. The content of this Model that may be exported.
#[prost(
enumeration = "export_format::ExportableContent",
repeated,
packed = "false",
tag = "2"
)]
pub exportable_contents: ::prost::alloc::vec::Vec<i32>,
}
/// Nested message and enum types in `ExportFormat`.
pub mod export_format {
/// The Model content that can be exported.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ExportableContent {
/// Should not be used.
Unspecified = 0,
/// Model artifact and any of its supported files. Will be exported to the
/// location specified by the `artifactDestination` field of the
/// [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config]
/// object.
Artifact = 1,
/// The container image that is to be used when deploying this Model. Will
/// be exported to the location specified by the `imageDestination` field
/// of the
/// [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config]
/// object.
Image = 2,
}
impl ExportableContent {
/// 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 {
ExportableContent::Unspecified => "EXPORTABLE_CONTENT_UNSPECIFIED",
ExportableContent::Artifact => "ARTIFACT",
ExportableContent::Image => "IMAGE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"EXPORTABLE_CONTENT_UNSPECIFIED" => Some(Self::Unspecified),
"ARTIFACT" => Some(Self::Artifact),
"IMAGE" => Some(Self::Image),
_ => None,
}
}
}
}
/// Stats of data used for train or evaluate the Model.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DataStats {
/// Number of DataItems that were used for training this Model.
#[prost(int64, tag = "1")]
pub training_data_items_count: i64,
/// Number of DataItems that were used for validating this Model during
/// training.
#[prost(int64, tag = "2")]
pub validation_data_items_count: i64,
/// Number of DataItems that were used for evaluating this Model. If the
/// Model is evaluated multiple times, this will be the number of test
/// DataItems used by the first evaluation. If the Model is not evaluated,
/// the number is 0.
#[prost(int64, tag = "3")]
pub test_data_items_count: i64,
/// Number of Annotations that are used for training this Model.
#[prost(int64, tag = "4")]
pub training_annotations_count: i64,
/// Number of Annotations that are used for validating this Model during
/// training.
#[prost(int64, tag = "5")]
pub validation_annotations_count: i64,
/// Number of Annotations that are used for evaluating this Model. If the
/// Model is evaluated multiple times, this will be the number of test
/// Annotations used by the first evaluation. If the Model is not evaluated,
/// the number is 0.
#[prost(int64, tag = "6")]
pub test_annotations_count: i64,
}
/// Contains information about the original Model if this Model is a copy.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OriginalModelInfo {
/// Output only. The resource name of the Model this Model is a copy of,
/// including the revision. Format:
/// `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
#[prost(string, tag = "1")]
pub model: ::prost::alloc::string::String,
}
/// User input field to specify the base model source. Currently it only
/// supports specifing the Model Garden models and Genie models.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BaseModelSource {
#[prost(oneof = "base_model_source::Source", tags = "1, 2")]
pub source: ::core::option::Option<base_model_source::Source>,
}
/// Nested message and enum types in `BaseModelSource`.
pub mod base_model_source {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// Source information of Model Garden models.
#[prost(message, tag = "1")]
ModelGardenSource(super::super::ModelGardenSource),
/// Information about the base model of Genie models.
#[prost(message, tag = "2")]
GenieSource(super::super::GenieSource),
}
}
/// Identifies a type of Model's prediction resources.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DeploymentResourcesType {
/// Should not be used.
Unspecified = 0,
/// Resources that are dedicated to the
/// [DeployedModel][google.cloud.aiplatform.v1.DeployedModel], and that need
/// a higher degree of manual configuration.
DedicatedResources = 1,
/// Resources that to large degree are decided by Vertex AI, and require
/// only a modest additional configuration.
AutomaticResources = 2,
/// Resources that can be shared by multiple
/// [DeployedModels][google.cloud.aiplatform.v1.DeployedModel]. A
/// pre-configured
/// [DeploymentResourcePool][google.cloud.aiplatform.v1.DeploymentResourcePool]
/// is required.
SharedResources = 3,
}
impl DeploymentResourcesType {
/// 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 {
DeploymentResourcesType::Unspecified => {
"DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED"
}
DeploymentResourcesType::DedicatedResources => "DEDICATED_RESOURCES",
DeploymentResourcesType::AutomaticResources => "AUTOMATIC_RESOURCES",
DeploymentResourcesType::SharedResources => "SHARED_RESOURCES",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"DEDICATED_RESOURCES" => Some(Self::DedicatedResources),
"AUTOMATIC_RESOURCES" => Some(Self::AutomaticResources),
"SHARED_RESOURCES" => Some(Self::SharedResources),
_ => None,
}
}
}
}
/// Contains information about the Large Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LargeModelReference {
/// Required. The unique name of the large Foundation or pre-built model. Like
/// "chat-bison", "text-bison". Or model name with version ID, like
/// "chat-bison@001", "text-bison@005", etc.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Contains information about the source of the models generated from Model
/// Garden.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelGardenSource {
/// Required. The model garden source model resource name.
#[prost(string, tag = "1")]
pub public_model_name: ::prost::alloc::string::String,
}
/// Contains information about the source of the models generated from Generative
/// AI Studio.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GenieSource {
/// Required. The public base model URI.
#[prost(string, tag = "1")]
pub base_model_uri: ::prost::alloc::string::String,
}
/// Contains the schemata used in Model's predictions and explanations via
/// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict],
/// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]
/// and [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PredictSchemata {
/// Immutable. Points to a YAML file stored on Google Cloud Storage describing
/// the format of a single instance, which are used in
/// [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
/// [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
/// and
/// [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
/// The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// AutoML Models always have this field populated by Vertex AI.
/// Note: The URI given on output will be immutable and probably different,
/// including the URI scheme, than the one given on input. The output URI will
/// point to a location where the user only has a read access.
#[prost(string, tag = "1")]
pub instance_schema_uri: ::prost::alloc::string::String,
/// Immutable. Points to a YAML file stored on Google Cloud Storage describing
/// the parameters of prediction and explanation via
/// [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
/// [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
/// and
/// [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
/// The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// AutoML Models always have this field populated by Vertex AI, if no
/// parameters are supported, then it is set to an empty string.
/// Note: The URI given on output will be immutable and probably different,
/// including the URI scheme, than the one given on input. The output URI will
/// point to a location where the user only has a read access.
#[prost(string, tag = "2")]
pub parameters_schema_uri: ::prost::alloc::string::String,
/// Immutable. Points to a YAML file stored on Google Cloud Storage describing
/// the format of a single prediction produced by this Model, which are
/// returned via
/// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions],
/// [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
/// and
/// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
/// The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// AutoML Models always have this field populated by Vertex AI.
/// Note: The URI given on output will be immutable and probably different,
/// including the URI scheme, than the one given on input. The output URI will
/// point to a location where the user only has a read access.
#[prost(string, tag = "3")]
pub prediction_schema_uri: ::prost::alloc::string::String,
}
/// Specification of a container for serving predictions. Some fields in this
/// message correspond to fields in the [Kubernetes Container v1 core
/// specification](<https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelContainerSpec {
/// Required. Immutable. URI of the Docker image to be used as the custom
/// container for serving predictions. This URI must identify an image in
/// Artifact Registry or Container Registry. Learn more about the [container
/// publishing
/// requirements](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing>),
/// including permissions requirements for the Vertex AI Service Agent.
///
/// The container image is ingested upon
/// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel],
/// stored internally, and this original path is afterwards not used.
///
/// To learn about the requirements for the Docker image itself, see
/// [Custom container
/// requirements](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#>).
///
/// You can use the URI to one of Vertex AI's [pre-built container images for
/// prediction](<https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers>)
/// in this field.
#[prost(string, tag = "1")]
pub image_uri: ::prost::alloc::string::String,
/// Immutable. Specifies the command that runs when the container starts. This
/// overrides the container's
/// [ENTRYPOINT](<https://docs.docker.com/engine/reference/builder/#entrypoint>).
/// Specify this field as an array of executable and arguments, similar to a
/// Docker `ENTRYPOINT`'s "exec" form, not its "shell" form.
///
/// If you do not specify this field, then the container's `ENTRYPOINT` runs,
/// in conjunction with the
/// [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] field or the
/// container's [`CMD`](<https://docs.docker.com/engine/reference/builder/#cmd>),
/// if either exists. If this field is not specified and the container does not
/// have an `ENTRYPOINT`, then refer to the Docker documentation about [how
/// `CMD` and `ENTRYPOINT`
/// interact](<https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact>).
///
/// If you specify this field, then you can also specify the `args` field to
/// provide additional arguments for this command. However, if you specify this
/// field, then the container's `CMD` is ignored. See the
/// [Kubernetes documentation about how the
/// `command` and `args` fields interact with a container's `ENTRYPOINT` and
/// `CMD`](<https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes>).
///
/// In this field, you can reference [environment variables set by Vertex
/// AI](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables>)
/// and environment variables set in the
/// [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. You cannot
/// reference environment variables set in the Docker image. In order for
/// environment variables to be expanded, reference them by using the following
/// syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs
/// from Bash variable expansion, which does not use parentheses. If a variable
/// cannot be resolved, the reference in the input string is used unchanged. To
/// avoid variable expansion, you can escape this syntax with `$$`; for
/// example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds
/// to the `command` field of the Kubernetes Containers [v1 core
/// API](<https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core>).
#[prost(string, repeated, tag = "2")]
pub command: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Immutable. Specifies arguments for the command that runs when the container
/// starts. This overrides the container's
/// [`CMD`](<https://docs.docker.com/engine/reference/builder/#cmd>). Specify
/// this field as an array of executable and arguments, similar to a Docker
/// `CMD`'s "default parameters" form.
///
/// If you don't specify this field but do specify the
/// [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] field,
/// then the command from the `command` field runs without any additional
/// arguments. See the [Kubernetes documentation about how the `command` and
/// `args` fields interact with a container's `ENTRYPOINT` and
/// `CMD`](<https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes>).
///
/// If you don't specify this field and don't specify the `command` field,
/// then the container's
/// [`ENTRYPOINT`](<https://docs.docker.com/engine/reference/builder/#cmd>) and
/// `CMD` determine what runs based on their default behavior. See the Docker
/// documentation about [how `CMD` and `ENTRYPOINT`
/// interact](<https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact>).
///
/// In this field, you can reference [environment variables
/// set by Vertex
/// AI](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables>)
/// and environment variables set in the
/// [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. You cannot
/// reference environment variables set in the Docker image. In order for
/// environment variables to be expanded, reference them by using the following
/// syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs
/// from Bash variable expansion, which does not use parentheses. If a variable
/// cannot be resolved, the reference in the input string is used unchanged. To
/// avoid variable expansion, you can escape this syntax with `$$`; for
/// example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds
/// to the `args` field of the Kubernetes Containers [v1 core
/// API](<https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core>).
#[prost(string, repeated, tag = "3")]
pub args: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Immutable. List of environment variables to set in the container. After the
/// container starts running, code running in the container can read these
/// environment variables.
///
/// Additionally, the
/// [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] and
/// [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] fields can
/// reference these variables. Later entries in this list can also reference
/// earlier entries. For example, the following example sets the variable
/// `VAR_2` to have the value `foo bar`:
///
/// ```json
/// [
/// {
/// "name": "VAR_1",
/// "value": "foo"
/// },
/// {
/// "name": "VAR_2",
/// "value": "$(VAR_1) bar"
/// }
/// ]
/// ```
///
/// If you switch the order of the variables in the example, then the expansion
/// does not occur.
///
/// This field corresponds to the `env` field of the Kubernetes Containers
/// [v1 core
/// API](<https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core>).
#[prost(message, repeated, tag = "4")]
pub env: ::prost::alloc::vec::Vec<EnvVar>,
/// Immutable. List of ports to expose from the container. Vertex AI sends any
/// prediction requests that it receives to the first port on this list. Vertex
/// AI also sends
/// [liveness and health
/// checks](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness>)
/// to this port.
///
/// If you do not specify this field, it defaults to following value:
///
/// ```json
/// [
/// {
/// "containerPort": 8080
/// }
/// ]
/// ```
///
/// Vertex AI does not use ports other than the first one listed. This field
/// corresponds to the `ports` field of the Kubernetes Containers
/// [v1 core
/// API](<https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core>).
#[prost(message, repeated, tag = "5")]
pub ports: ::prost::alloc::vec::Vec<Port>,
/// Immutable. HTTP path on the container to send prediction requests to.
/// Vertex AI forwards requests sent using
/// [projects.locations.endpoints.predict][google.cloud.aiplatform.v1.PredictionService.Predict]
/// to this path on the container's IP address and port. Vertex AI then returns
/// the container's response in the API response.
///
/// For example, if you set this field to `/foo`, then when Vertex AI
/// receives a prediction request, it forwards the request body in a POST
/// request to the `/foo` path on the port of your container specified by the
/// first value of this `ModelContainerSpec`'s
/// [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field.
///
/// If you don't specify this field, it defaults to the following value when
/// you [deploy this Model to an
/// Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]:
/// <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code>
/// The placeholders in this value are replaced as follows:
///
/// * <var>ENDPOINT</var>: The last segment (following `endpoints/`)of the
/// Endpoint.name][] field of the Endpoint where this Model has been
/// deployed. (Vertex AI makes this value available to your container code
/// as the [`AIP_ENDPOINT_ID` environment
/// variable](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables>).)
///
/// * <var>DEPLOYED_MODEL</var>:
/// [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the
/// `DeployedModel`.
/// (Vertex AI makes this value available to your container code
/// as the [`AIP_DEPLOYED_MODEL_ID` environment
/// variable](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables>).)
#[prost(string, tag = "6")]
pub predict_route: ::prost::alloc::string::String,
/// Immutable. HTTP path on the container to send health checks to. Vertex AI
/// intermittently sends GET requests to this path on the container's IP
/// address and port to check that the container is healthy. Read more about
/// [health
/// checks](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health>).
///
/// For example, if you set this field to `/bar`, then Vertex AI
/// intermittently sends a GET request to the `/bar` path on the port of your
/// container specified by the first value of this `ModelContainerSpec`'s
/// [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field.
///
/// If you don't specify this field, it defaults to the following value when
/// you [deploy this Model to an
/// Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]:
/// <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code>
/// The placeholders in this value are replaced as follows:
///
/// * <var>ENDPOINT</var>: The last segment (following `endpoints/`)of the
/// Endpoint.name][] field of the Endpoint where this Model has been
/// deployed. (Vertex AI makes this value available to your container code
/// as the [`AIP_ENDPOINT_ID` environment
/// variable](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables>).)
///
/// * <var>DEPLOYED_MODEL</var>:
/// [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the
/// `DeployedModel`.
/// (Vertex AI makes this value available to your container code as the
/// [`AIP_DEPLOYED_MODEL_ID` environment
/// variable](<https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables>).)
#[prost(string, tag = "7")]
pub health_route: ::prost::alloc::string::String,
/// Immutable. List of ports to expose from the container. Vertex AI sends gRPC
/// prediction requests that it receives to the first port on this list. Vertex
/// AI also sends liveness and health checks to this port.
///
/// If you do not specify this field, gRPC requests to the container will be
/// disabled.
///
/// Vertex AI does not use ports other than the first one listed. This field
/// corresponds to the `ports` field of the Kubernetes Containers v1 core API.
#[prost(message, repeated, tag = "9")]
pub grpc_ports: ::prost::alloc::vec::Vec<Port>,
/// Immutable. Deployment timeout.
/// Limit for deployment timeout is 2 hours.
#[prost(message, optional, tag = "10")]
pub deployment_timeout: ::core::option::Option<::prost_types::Duration>,
/// Immutable. The amount of the VM memory to reserve as the shared memory for
/// the model in megabytes.
#[prost(int64, tag = "11")]
pub shared_memory_size_mb: i64,
/// Immutable. Specification for Kubernetes startup probe.
#[prost(message, optional, tag = "12")]
pub startup_probe: ::core::option::Option<Probe>,
/// Immutable. Specification for Kubernetes readiness probe.
#[prost(message, optional, tag = "13")]
pub health_probe: ::core::option::Option<Probe>,
}
/// Represents a network port in a container.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Port {
/// The number of the port to expose on the pod's IP address.
/// Must be a valid port number, between 1 and 65535 inclusive.
#[prost(int32, tag = "3")]
pub container_port: i32,
}
/// Detail description of the source information of the model.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ModelSourceInfo {
/// Type of the model source.
#[prost(enumeration = "model_source_info::ModelSourceType", tag = "1")]
pub source_type: i32,
/// If this Model is copy of another Model. If true then
/// [source_type][google.cloud.aiplatform.v1.ModelSourceInfo.source_type]
/// pertains to the original.
#[prost(bool, tag = "2")]
pub copy: bool,
}
/// Nested message and enum types in `ModelSourceInfo`.
pub mod model_source_info {
/// Source of the model.
/// Different from `objective` field, this `ModelSourceType` enum
/// indicates the source from which the model was accessed or obtained,
/// whereas the `objective` indicates the overall aim or function of this
/// model.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ModelSourceType {
/// Should not be used.
Unspecified = 0,
/// The Model is uploaded by automl training pipeline.
Automl = 1,
/// The Model is uploaded by user or custom training pipeline.
Custom = 2,
/// The Model is registered and sync'ed from BigQuery ML.
Bqml = 3,
/// The Model is saved or tuned from Model Garden.
ModelGarden = 4,
/// The Model is saved or tuned from Genie.
Genie = 5,
/// The Model is uploaded by text embedding finetuning pipeline.
CustomTextEmbedding = 6,
/// The Model is saved or tuned from Marketplace.
Marketplace = 7,
}
impl ModelSourceType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ModelSourceType::Unspecified => "MODEL_SOURCE_TYPE_UNSPECIFIED",
ModelSourceType::Automl => "AUTOML",
ModelSourceType::Custom => "CUSTOM",
ModelSourceType::Bqml => "BQML",
ModelSourceType::ModelGarden => "MODEL_GARDEN",
ModelSourceType::Genie => "GENIE",
ModelSourceType::CustomTextEmbedding => "CUSTOM_TEXT_EMBEDDING",
ModelSourceType::Marketplace => "MARKETPLACE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MODEL_SOURCE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"AUTOML" => Some(Self::Automl),
"CUSTOM" => Some(Self::Custom),
"BQML" => Some(Self::Bqml),
"MODEL_GARDEN" => Some(Self::ModelGarden),
"GENIE" => Some(Self::Genie),
"CUSTOM_TEXT_EMBEDDING" => Some(Self::CustomTextEmbedding),
"MARKETPLACE" => Some(Self::Marketplace),
_ => None,
}
}
}
}
/// Probe describes a health check to be performed against a container to
/// determine whether it is alive or ready to receive traffic.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Probe {
/// How often (in seconds) to perform the probe. Default to 10 seconds.
/// Minimum value is 1. Must be less than timeout_seconds.
///
/// Maps to Kubernetes probe argument 'periodSeconds'.
#[prost(int32, tag = "2")]
pub period_seconds: i32,
/// Number of seconds after which the probe times out. Defaults to 1 second.
/// Minimum value is 1. Must be greater or equal to period_seconds.
///
/// Maps to Kubernetes probe argument 'timeoutSeconds'.
#[prost(int32, tag = "3")]
pub timeout_seconds: i32,
#[prost(oneof = "probe::ProbeType", tags = "1")]
pub probe_type: ::core::option::Option<probe::ProbeType>,
}
/// Nested message and enum types in `Probe`.
pub mod probe {
/// ExecAction specifies a command to execute.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecAction {
/// Command is the command line to execute inside the container, the working
/// directory for the command is root ('/') in the container's filesystem.
/// The command is simply exec'd, it is not run inside a shell, so
/// traditional shell instructions ('|', etc) won't work. To use a shell, you
/// need to explicitly call out to that shell. Exit status of 0 is treated as
/// live/healthy and non-zero is unhealthy.
#[prost(string, repeated, tag = "1")]
pub command: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ProbeType {
/// ExecAction probes the health of a container by executing a command.
#[prost(message, tag = "1")]
Exec(ExecAction),
}
}
/// The TrainingPipeline orchestrates tasks associated with training a Model. It
/// always executes the training task, and optionally may also
/// export data from Vertex AI's Dataset which becomes the training input,
/// [upload][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to
/// Vertex AI, and evaluate the Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TrainingPipeline {
/// Output only. Resource name of the TrainingPipeline.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user-defined name of this TrainingPipeline.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Specifies Vertex AI owned input data that may be used for training the
/// Model. The TrainingPipeline's
/// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
/// should make clear whether this config is used and if there are any special
/// requirements on how it should be filled. If nothing about this config is
/// mentioned in the
/// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition],
/// then it should be assumed that the TrainingPipeline does not depend on this
/// configuration.
#[prost(message, optional, tag = "3")]
pub input_data_config: ::core::option::Option<InputDataConfig>,
/// Required. A Google Cloud Storage path to the YAML file that defines the
/// training task which is responsible for producing the model artifact, and
/// may also include additional auxiliary work. The definition files that can
/// be used here are found in
/// gs://google-cloud-aiplatform/schema/trainingjob/definition/.
/// Note: The URI given on output will be immutable and probably different,
/// including the URI scheme, than the one given on input. The output URI will
/// point to a location where the user only has a read access.
#[prost(string, tag = "4")]
pub training_task_definition: ::prost::alloc::string::String,
/// Required. The training task's parameter(s), as specified in the
/// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s
/// `inputs`.
#[prost(message, optional, tag = "5")]
pub training_task_inputs: ::core::option::Option<::prost_types::Value>,
/// Output only. The metadata information as specified in the
/// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s
/// `metadata`. This metadata is an auxiliary runtime and final information
/// about the training task. While the pipeline is running this information is
/// populated only at a best effort basis. Only present if the
/// pipeline's
/// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
/// contains `metadata` object.
#[prost(message, optional, tag = "6")]
pub training_task_metadata: ::core::option::Option<::prost_types::Value>,
/// Describes the Model that may be uploaded (via
/// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel])
/// by this TrainingPipeline. The TrainingPipeline's
/// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
/// should make clear whether this Model description should be populated, and
/// if there are any special requirements regarding how it should be filled. If
/// nothing is mentioned in the
/// [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition],
/// then it should be assumed that this field should not be filled and the
/// training task either uploads the Model without a need of this information,
/// or that training task does not support uploading a Model as part of the
/// pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and
/// the trained Model had been uploaded into Vertex AI, then the
/// model_to_upload's resource [name][google.cloud.aiplatform.v1.Model.name] is
/// populated. The Model is always uploaded into the Project and Location in
/// which this pipeline is.
#[prost(message, optional, tag = "7")]
pub model_to_upload: ::core::option::Option<Model>,
/// Optional. The ID to use for the uploaded Model, which will become the final
/// component of the model resource name.
///
/// This value may be up to 63 characters, and valid characters are
/// `\[a-z0-9_-\]`. The first character cannot be a number or hyphen.
#[prost(string, tag = "22")]
pub model_id: ::prost::alloc::string::String,
/// Optional. When specify this field, the `model_to_upload` will not be
/// uploaded as a new model, instead, it will become a new version of this
/// `parent_model`.
#[prost(string, tag = "21")]
pub parent_model: ::prost::alloc::string::String,
/// Output only. The detailed state of the pipeline.
#[prost(enumeration = "PipelineState", tag = "9")]
pub state: i32,
/// Output only. Only populated when the pipeline's state is
/// `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
#[prost(message, optional, tag = "10")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// Output only. Time when the TrainingPipeline was created.
#[prost(message, optional, tag = "11")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the TrainingPipeline for the first time entered the
/// `PIPELINE_STATE_RUNNING` state.
#[prost(message, optional, tag = "12")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the TrainingPipeline entered any of the following
/// states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`,
/// `PIPELINE_STATE_CANCELLED`.
#[prost(message, optional, tag = "13")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the TrainingPipeline was most recently updated.
#[prost(message, optional, tag = "14")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The labels with user-defined metadata to organize TrainingPipelines.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "15")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Customer-managed encryption key spec for a TrainingPipeline. If set, this
/// TrainingPipeline will be secured by this key.
///
/// Note: Model trained by this TrainingPipeline is also secured by this key if
/// [model_to_upload][google.cloud.aiplatform.v1.TrainingPipeline.encryption_spec]
/// is not set separately.
#[prost(message, optional, tag = "18")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
}
/// Specifies Vertex AI owned input data to be used for training, and
/// possibly evaluating, the Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InputDataConfig {
/// Required. The ID of the Dataset in the same Project and Location which data
/// will be used to train the Model. The Dataset must use schema compatible
/// with Model being trained, and what is compatible should be described in the
/// used TrainingPipeline's \[training_task_definition\]
/// \[google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition\].
/// For tabular Datasets, all their data is exported to training, to pick
/// and choose from.
#[prost(string, tag = "1")]
pub dataset_id: ::prost::alloc::string::String,
/// Applicable only to Datasets that have DataItems and Annotations.
///
/// A filter on Annotations of the Dataset. Only Annotations that both
/// match this filter and belong to DataItems not ignored by the split method
/// are used in respectively training, validation or test role, depending on
/// the role of the DataItem they are on (for the auto-assigned that role is
/// decided by Vertex AI). A filter with same syntax as the one used in
/// [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations]
/// may be used, but note here it filters across all Annotations of the
/// Dataset, and not just within a single DataItem.
#[prost(string, tag = "6")]
pub annotations_filter: ::prost::alloc::string::String,
/// Applicable only to custom training with Datasets that have DataItems and
/// Annotations.
///
/// Cloud Storage URI that points to a YAML file describing the annotation
/// schema. The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// The schema files that can be used here are found in
/// gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the
/// chosen schema must be consistent with
/// [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the
/// Dataset specified by
/// [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id].
///
/// Only Annotations that both match this schema and belong to DataItems not
/// ignored by the split method are used in respectively training, validation
/// or test role, depending on the role of the DataItem they are on.
///
/// When used in conjunction with
/// [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter],
/// the Annotations used for training are filtered by both
/// [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter]
/// and
/// [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri].
#[prost(string, tag = "9")]
pub annotation_schema_uri: ::prost::alloc::string::String,
/// Only applicable to Datasets that have SavedQueries.
///
/// The ID of a SavedQuery (annotation set) under the Dataset specified by
/// [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id] used
/// for filtering Annotations for training.
///
/// Only Annotations that are associated with this SavedQuery are used in
/// respectively training. When used in conjunction with
/// [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter],
/// the Annotations used for training are filtered by both
/// [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id]
/// and
/// [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter].
///
/// Only one of
/// [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id]
/// and
/// [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri]
/// should be specified as both of them represent the same thing: problem type.
#[prost(string, tag = "7")]
pub saved_query_id: ::prost::alloc::string::String,
/// Whether to persist the ML use assignment to data item system labels.
#[prost(bool, tag = "11")]
pub persist_ml_use_assignment: bool,
/// The instructions how the input data should be split between the
/// training, validation and test sets.
/// If no split type is provided, the
/// [fraction_split][google.cloud.aiplatform.v1.InputDataConfig.fraction_split]
/// is used by default.
#[prost(oneof = "input_data_config::Split", tags = "2, 3, 4, 5, 12")]
pub split: ::core::option::Option<input_data_config::Split>,
/// Only applicable to Custom and Hyperparameter Tuning TrainingPipelines.
///
/// The destination of the training data to be written to.
///
/// Supported destination file formats:
/// * For non-tabular data: "jsonl".
/// * For tabular data: "csv" and "bigquery".
///
/// The following Vertex AI environment variables are passed to containers
/// or python modules of the training task when this field is set:
///
/// * AIP_DATA_FORMAT : Exported data format.
/// * AIP_TRAINING_DATA_URI : Sharded exported training data uris.
/// * AIP_VALIDATION_DATA_URI : Sharded exported validation data uris.
/// * AIP_TEST_DATA_URI : Sharded exported test data uris.
#[prost(oneof = "input_data_config::Destination", tags = "8, 10")]
pub destination: ::core::option::Option<input_data_config::Destination>,
}
/// Nested message and enum types in `InputDataConfig`.
pub mod input_data_config {
/// The instructions how the input data should be split between the
/// training, validation and test sets.
/// If no split type is provided, the
/// [fraction_split][google.cloud.aiplatform.v1.InputDataConfig.fraction_split]
/// is used by default.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Split {
/// Split based on fractions defining the size of each set.
#[prost(message, tag = "2")]
FractionSplit(super::FractionSplit),
/// Split based on the provided filters for each set.
#[prost(message, tag = "3")]
FilterSplit(super::FilterSplit),
/// Supported only for tabular Datasets.
///
/// Split based on a predefined key.
#[prost(message, tag = "4")]
PredefinedSplit(super::PredefinedSplit),
/// Supported only for tabular Datasets.
///
/// Split based on the timestamp of the input data pieces.
#[prost(message, tag = "5")]
TimestampSplit(super::TimestampSplit),
/// Supported only for tabular Datasets.
///
/// Split based on the distribution of the specified column.
#[prost(message, tag = "12")]
StratifiedSplit(super::StratifiedSplit),
}
/// Only applicable to Custom and Hyperparameter Tuning TrainingPipelines.
///
/// The destination of the training data to be written to.
///
/// Supported destination file formats:
/// * For non-tabular data: "jsonl".
/// * For tabular data: "csv" and "bigquery".
///
/// The following Vertex AI environment variables are passed to containers
/// or python modules of the training task when this field is set:
///
/// * AIP_DATA_FORMAT : Exported data format.
/// * AIP_TRAINING_DATA_URI : Sharded exported training data uris.
/// * AIP_VALIDATION_DATA_URI : Sharded exported validation data uris.
/// * AIP_TEST_DATA_URI : Sharded exported test data uris.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Destination {
/// The Cloud Storage location where the training data is to be
/// written to. In the given directory a new directory is created with
/// name:
/// `dataset-<dataset-id>-<annotation-type>-<timestamp-of-training-call>`
/// where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format.
/// All training input data is written into that directory.
///
/// The Vertex AI environment variables representing Cloud Storage
/// data URIs are represented in the Cloud Storage wildcard
/// format to support sharded data. e.g.: "gs://.../training-*.jsonl"
///
/// * AIP_DATA_FORMAT = "jsonl" for non-tabular data, "csv" for tabular data
/// * AIP_TRAINING_DATA_URI =
/// "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/training-*.${AIP_DATA_FORMAT}"
///
/// * AIP_VALIDATION_DATA_URI =
/// "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/validation-*.${AIP_DATA_FORMAT}"
///
/// * AIP_TEST_DATA_URI =
/// "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/test-*.${AIP_DATA_FORMAT}"
#[prost(message, tag = "8")]
GcsDestination(super::GcsDestination),
/// Only applicable to custom training with tabular Dataset with BigQuery
/// source.
///
/// The BigQuery project location where the training data is to be written
/// to. In the given project a new dataset is created with name
/// `dataset_<dataset-id>_<annotation-type>_<timestamp-of-training-call>`
/// where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training
/// input data is written into that dataset. In the dataset three
/// tables are created, `training`, `validation` and `test`.
///
/// * AIP_DATA_FORMAT = "bigquery".
/// * AIP_TRAINING_DATA_URI =
/// "bigquery_destination.dataset_<dataset-id>_<annotation-type>_<time>.training"
///
/// * AIP_VALIDATION_DATA_URI =
/// "bigquery_destination.dataset_<dataset-id>_<annotation-type>_<time>.validation"
///
/// * AIP_TEST_DATA_URI =
/// "bigquery_destination.dataset_<dataset-id>_<annotation-type>_<time>.test"
#[prost(message, tag = "10")]
BigqueryDestination(super::BigQueryDestination),
}
}
/// Assigns the input data to training, validation, and test sets as per the
/// given fractions. Any of `training_fraction`, `validation_fraction` and
/// `test_fraction` may optionally be provided, they must sum to up to 1. If the
/// provided ones sum to less than 1, the remainder is assigned to sets as
/// decided by Vertex AI. If none of the fractions are set, by default roughly
/// 80% of data is used for training, 10% for validation, and 10% for test.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FractionSplit {
/// The fraction of the input data that is to be used to train the Model.
#[prost(double, tag = "1")]
pub training_fraction: f64,
/// The fraction of the input data that is to be used to validate the Model.
#[prost(double, tag = "2")]
pub validation_fraction: f64,
/// The fraction of the input data that is to be used to evaluate the Model.
#[prost(double, tag = "3")]
pub test_fraction: f64,
}
/// Assigns input data to training, validation, and test sets based on the given
/// filters, data pieces not matched by any filter are ignored. Currently only
/// supported for Datasets containing DataItems.
/// If any of the filters in this message are to match nothing, then they can be
/// set as '-' (the minus sign).
///
/// Supported only for unstructured Datasets.
///
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FilterSplit {
/// Required. A filter on DataItems of the Dataset. DataItems that match
/// this filter are used to train the Model. A filter with same syntax
/// as the one used in
/// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
/// may be used. If a single DataItem is matched by more than one of the
/// FilterSplit filters, then it is assigned to the first set that applies to
/// it in the training, validation, test order.
#[prost(string, tag = "1")]
pub training_filter: ::prost::alloc::string::String,
/// Required. A filter on DataItems of the Dataset. DataItems that match
/// this filter are used to validate the Model. A filter with same syntax
/// as the one used in
/// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
/// may be used. If a single DataItem is matched by more than one of the
/// FilterSplit filters, then it is assigned to the first set that applies to
/// it in the training, validation, test order.
#[prost(string, tag = "2")]
pub validation_filter: ::prost::alloc::string::String,
/// Required. A filter on DataItems of the Dataset. DataItems that match
/// this filter are used to test the Model. A filter with same syntax
/// as the one used in
/// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
/// may be used. If a single DataItem is matched by more than one of the
/// FilterSplit filters, then it is assigned to the first set that applies to
/// it in the training, validation, test order.
#[prost(string, tag = "3")]
pub test_filter: ::prost::alloc::string::String,
}
/// Assigns input data to training, validation, and test sets based on the
/// value of a provided key.
///
/// Supported only for tabular Datasets.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PredefinedSplit {
/// Required. The key is a name of one of the Dataset's data columns.
/// The value of the key (either the label's value or value in the column)
/// must be one of {`training`, `validation`, `test`}, and it defines to which
/// set the given piece of data is assigned. If for a piece of data the key
/// is not present or has an invalid value, that piece is ignored by the
/// pipeline.
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
}
/// Assigns input data to training, validation, and test sets based on a
/// provided timestamps. The youngest data pieces are assigned to training set,
/// next to validation set, and the oldest to the test set.
///
/// Supported only for tabular Datasets.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TimestampSplit {
/// The fraction of the input data that is to be used to train the Model.
#[prost(double, tag = "1")]
pub training_fraction: f64,
/// The fraction of the input data that is to be used to validate the Model.
#[prost(double, tag = "2")]
pub validation_fraction: f64,
/// The fraction of the input data that is to be used to evaluate the Model.
#[prost(double, tag = "3")]
pub test_fraction: f64,
/// Required. The key is a name of one of the Dataset's data columns.
/// The values of the key (the values in the column) must be in RFC 3339
/// `date-time` format, where `time-offset` = `"Z"`
/// (e.g. 1985-04-12T23:20:50.52Z). If for a piece of data the key is not
/// present or has an invalid value, that piece is ignored by the pipeline.
#[prost(string, tag = "4")]
pub key: ::prost::alloc::string::String,
}
/// Assigns input data to the training, validation, and test sets so that the
/// distribution of values found in the categorical column (as specified by the
/// `key` field) is mirrored within each split. The fraction values determine
/// the relative sizes of the splits.
///
/// For example, if the specified column has three values, with 50% of the rows
/// having value "A", 25% value "B", and 25% value "C", and the split fractions
/// are specified as 80/10/10, then the training set will constitute 80% of the
/// training data, with about 50% of the training set rows having the value "A"
/// for the specified column, about 25% having the value "B", and about 25%
/// having the value "C".
///
/// Only the top 500 occurring values are used; any values not in the top
/// 500 values are randomly assigned to a split. If less than three rows contain
/// a specific value, those rows are randomly assigned.
///
/// Supported only for tabular Datasets.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StratifiedSplit {
/// The fraction of the input data that is to be used to train the Model.
#[prost(double, tag = "1")]
pub training_fraction: f64,
/// The fraction of the input data that is to be used to validate the Model.
#[prost(double, tag = "2")]
pub validation_fraction: f64,
/// The fraction of the input data that is to be used to evaluate the Model.
#[prost(double, tag = "3")]
pub test_fraction: f64,
/// Required. The key is a name of one of the Dataset's data columns.
/// The key provided must be for a categorical column.
#[prost(string, tag = "4")]
pub key: ::prost::alloc::string::String,
}
/// Runtime operation information for
/// [PipelineService.BatchCancelPipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchCancelPipelineJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCancelPipelineJobsOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTrainingPipelineRequest {
/// Required. The resource name of the Location to create the TrainingPipeline
/// in. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The TrainingPipeline to create.
#[prost(message, optional, tag = "2")]
pub training_pipeline: ::core::option::Option<TrainingPipeline>,
}
/// Request message for
/// [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTrainingPipelineRequest {
/// Required. The name of the TrainingPipeline resource.
/// Format:
/// `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTrainingPipelinesRequest {
/// Required. The resource name of the Location to list the TrainingPipelines
/// from. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
///
/// Supported fields:
///
/// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
/// * `state` supports `=`, `!=` comparisons.
/// * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard.
/// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
/// `create_time` must be in RFC 3339 format.
/// * `labels` supports general map functions that is:
/// `labels.key=value` - key:value equality
/// `labels.key:* - key existence
///
/// Some examples of using the filter are:
///
/// * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"`
/// * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"`
/// * `NOT display_name="my_pipeline"`
/// * `create_time>"2021-05-18T00:00:00Z"`
/// * `training_task_definition:"*automl_text_classification*"`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token]
/// of the previous
/// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTrainingPipelinesResponse {
/// List of TrainingPipelines in the requested page.
#[prost(message, repeated, tag = "1")]
pub training_pipelines: ::prost::alloc::vec::Vec<TrainingPipeline>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTrainingPipelineRequest {
/// Required. The name of the TrainingPipeline resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelTrainingPipelineRequest {
/// Required. The name of the TrainingPipeline to cancel.
/// Format:
/// `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreatePipelineJobRequest {
/// Required. The resource name of the Location to create the PipelineJob in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The PipelineJob to create.
#[prost(message, optional, tag = "2")]
pub pipeline_job: ::core::option::Option<PipelineJob>,
/// The ID to use for the PipelineJob, which will become the final component of
/// the PipelineJob name. If not provided, an ID will be automatically
/// generated.
///
/// This value should be less than 128 characters, and valid characters
/// are `/[a-z][0-9]-/`.
#[prost(string, tag = "3")]
pub pipeline_job_id: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPipelineJobRequest {
/// Required. The name of the PipelineJob resource.
/// Format:
/// `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPipelineJobsRequest {
/// Required. The resource name of the Location to list the PipelineJobs from.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the PipelineJobs that match the filter expression. The following
/// fields are supported:
///
/// * `pipeline_name`: Supports `=` and `!=` comparisons.
/// * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
/// * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
/// for example, can check if pipeline's display_name contains *step* by
/// doing display_name:\"*step*\"
/// * `state`: Supports `=` and `!=` comparisons.
/// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be in RFC 3339 format.
/// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be in RFC 3339 format.
/// * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be in RFC 3339 format.
/// * `labels`: Supports key-value equality and key presence.
/// * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
/// * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
/// wildcard.
///
/// Filter expressions can be combined together using logical operators
/// (`AND` & `OR`).
/// For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`.
///
/// The syntax to define filter expression is based on
/// <https://google.aip.dev/160.>
///
/// Examples:
///
/// * `create_time>"2021-05-18T00:00:00Z" OR
/// update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated
/// after 2020-05-18 00:00:00 UTC.
/// * `labels.env = "prod"`
/// PipelineJobs with label "env" set to "prod".
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token]
/// of the previous
/// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by. The default sort order is in
/// ascending order. Use "desc" after a field name for descending. You can have
/// multiple order_by fields provided e.g. "create_time desc, end_time",
/// "end_time, start_time, update_time" For example, using "create_time desc,
/// end_time" will order results by create time in descending order, and if
/// there are multiple jobs having the same create time, order them by the end
/// time in ascending order. if order_by is not specified, it will order by
/// default order is create time in descending order. Supported fields:
///
/// * `create_time`
/// * `update_time`
/// * `end_time`
/// * `start_time`
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "7")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPipelineJobsResponse {
/// List of PipelineJobs in the requested page.
#[prost(message, repeated, tag = "1")]
pub pipeline_jobs: ::prost::alloc::vec::Vec<PipelineJob>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1.ListPipelineJobsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeletePipelineJobRequest {
/// Required. The name of the PipelineJob resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.BatchDeletePipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchDeletePipelineJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchDeletePipelineJobsRequest {
/// Required. The name of the PipelineJobs' parent resource.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The names of the PipelineJobs to delete.
/// A maximum of 32 PipelineJobs can be deleted in a batch.
/// Format:
/// `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`
#[prost(string, repeated, tag = "2")]
pub names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for
/// [PipelineService.BatchDeletePipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchDeletePipelineJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchDeletePipelineJobsResponse {
/// PipelineJobs deleted.
#[prost(message, repeated, tag = "1")]
pub pipeline_jobs: ::prost::alloc::vec::Vec<PipelineJob>,
}
/// Request message for
/// [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelPipelineJobRequest {
/// Required. The name of the PipelineJob to cancel.
/// Format:
/// `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [PipelineService.BatchCancelPipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchCancelPipelineJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCancelPipelineJobsRequest {
/// Required. The name of the PipelineJobs' parent resource.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The names of the PipelineJobs to cancel.
/// A maximum of 32 PipelineJobs can be cancelled in a batch.
/// Format:
/// `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`
#[prost(string, repeated, tag = "2")]
pub names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for
/// [PipelineService.BatchCancelPipelineJobs][google.cloud.aiplatform.v1.PipelineService.BatchCancelPipelineJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCancelPipelineJobsResponse {
/// PipelineJobs cancelled.
#[prost(message, repeated, tag = "1")]
pub pipeline_jobs: ::prost::alloc::vec::Vec<PipelineJob>,
}
/// Generated client implementations.
pub mod pipeline_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for creating and managing Vertex AI's pipelines. This includes both
/// `TrainingPipeline` resources (used for AutoML and custom training) and
/// `PipelineJob` resources (used for Vertex AI Pipelines).
#[derive(Debug, Clone)]
pub struct PipelineServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> PipelineServiceClient<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,
) -> PipelineServiceClient<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,
{
PipelineServiceClient::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 TrainingPipeline. A created TrainingPipeline right away will be
/// attempted to be run.
pub async fn create_training_pipeline(
&mut self,
request: impl tonic::IntoRequest<super::CreateTrainingPipelineRequest>,
) -> std::result::Result<
tonic::Response<super::TrainingPipeline>,
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.aiplatform.v1.PipelineService/CreateTrainingPipeline",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"CreateTrainingPipeline",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a TrainingPipeline.
pub async fn get_training_pipeline(
&mut self,
request: impl tonic::IntoRequest<super::GetTrainingPipelineRequest>,
) -> std::result::Result<
tonic::Response<super::TrainingPipeline>,
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.aiplatform.v1.PipelineService/GetTrainingPipeline",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"GetTrainingPipeline",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists TrainingPipelines in a Location.
pub async fn list_training_pipelines(
&mut self,
request: impl tonic::IntoRequest<super::ListTrainingPipelinesRequest>,
) -> std::result::Result<
tonic::Response<super::ListTrainingPipelinesResponse>,
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.aiplatform.v1.PipelineService/ListTrainingPipelines",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"ListTrainingPipelines",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a TrainingPipeline.
pub async fn delete_training_pipeline(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTrainingPipelineRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.PipelineService/DeleteTrainingPipeline",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"DeleteTrainingPipeline",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels a TrainingPipeline.
/// Starts asynchronous cancellation on the TrainingPipeline. The server
/// makes a best effort to cancel the pipeline, but success is not
/// guaranteed. Clients can use
/// [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
/// or other methods to check whether the cancellation succeeded or whether the
/// pipeline completed despite cancellation. On successful cancellation,
/// the TrainingPipeline is not deleted; instead it becomes a pipeline with
/// a
/// [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
/// value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
/// corresponding to `Code.CANCELLED`, and
/// [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
/// is set to `CANCELLED`.
pub async fn cancel_training_pipeline(
&mut self,
request: impl tonic::IntoRequest<super::CancelTrainingPipelineRequest>,
) -> 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.aiplatform.v1.PipelineService/CancelTrainingPipeline",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"CancelTrainingPipeline",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a PipelineJob. A PipelineJob will run immediately when created.
pub async fn create_pipeline_job(
&mut self,
request: impl tonic::IntoRequest<super::CreatePipelineJobRequest>,
) -> std::result::Result<tonic::Response<super::PipelineJob>, 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.aiplatform.v1.PipelineService/CreatePipelineJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"CreatePipelineJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a PipelineJob.
pub async fn get_pipeline_job(
&mut self,
request: impl tonic::IntoRequest<super::GetPipelineJobRequest>,
) -> std::result::Result<tonic::Response<super::PipelineJob>, 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.aiplatform.v1.PipelineService/GetPipelineJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"GetPipelineJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists PipelineJobs in a Location.
pub async fn list_pipeline_jobs(
&mut self,
request: impl tonic::IntoRequest<super::ListPipelineJobsRequest>,
) -> std::result::Result<
tonic::Response<super::ListPipelineJobsResponse>,
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.aiplatform.v1.PipelineService/ListPipelineJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"ListPipelineJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a PipelineJob.
pub async fn delete_pipeline_job(
&mut self,
request: impl tonic::IntoRequest<super::DeletePipelineJobRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.PipelineService/DeletePipelineJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"DeletePipelineJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Batch deletes PipelineJobs
/// The Operation is atomic. If it fails, none of the PipelineJobs are deleted.
/// If it succeeds, all of the PipelineJobs are deleted.
pub async fn batch_delete_pipeline_jobs(
&mut self,
request: impl tonic::IntoRequest<super::BatchDeletePipelineJobsRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.PipelineService/BatchDeletePipelineJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"BatchDeletePipelineJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels a PipelineJob.
/// Starts asynchronous cancellation on the PipelineJob. The server
/// makes a best effort to cancel the pipeline, but success is not
/// guaranteed. Clients can use
/// [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
/// or other methods to check whether the cancellation succeeded or whether the
/// pipeline completed despite cancellation. On successful cancellation,
/// the PipelineJob is not deleted; instead it becomes a pipeline with
/// a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
/// with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
/// to `Code.CANCELLED`, and
/// [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
/// `CANCELLED`.
pub async fn cancel_pipeline_job(
&mut self,
request: impl tonic::IntoRequest<super::CancelPipelineJobRequest>,
) -> 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.aiplatform.v1.PipelineService/CancelPipelineJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"CancelPipelineJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Batch cancel PipelineJobs.
/// Firstly the server will check if all the jobs are in non-terminal states,
/// and skip the jobs that are already terminated.
/// If the operation failed, none of the pipeline jobs are cancelled.
/// The server will poll the states of all the pipeline jobs periodically
/// to check the cancellation status.
/// This operation will return an LRO.
pub async fn batch_cancel_pipeline_jobs(
&mut self,
request: impl tonic::IntoRequest<super::BatchCancelPipelineJobsRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.PipelineService/BatchCancelPipelineJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PipelineService",
"BatchCancelPipelineJobs",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// An instance of a Schedule periodically schedules runs to make API calls based
/// on user specified time specification and API request type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Schedule {
/// Immutable. The resource name of the Schedule.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. User provided name of the Schedule.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Optional. Timestamp after which the first run can be scheduled.
/// Default to Schedule create time if not specified.
#[prost(message, optional, tag = "3")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Timestamp after which no new runs can be scheduled.
/// If specified, The schedule will be completed when either
/// end_time is reached or when scheduled_run_count >= max_run_count.
/// If not specified, new runs will keep getting scheduled until this Schedule
/// is paused or deleted. Already scheduled runs will be allowed to complete.
/// Unset if not specified.
#[prost(message, optional, tag = "4")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Maximum run count of the schedule.
/// If specified, The schedule will be completed when either
/// started_run_count >= max_run_count or when end_time is reached.
/// If not specified, new runs will keep getting scheduled until this Schedule
/// is paused or deleted. Already scheduled runs will be allowed to complete.
/// Unset if not specified.
#[prost(int64, tag = "16")]
pub max_run_count: i64,
/// Output only. The number of runs started by this schedule.
#[prost(int64, tag = "17")]
pub started_run_count: i64,
/// Output only. The state of this Schedule.
#[prost(enumeration = "schedule::State", tag = "5")]
pub state: i32,
/// Output only. Timestamp when this Schedule was created.
#[prost(message, optional, tag = "6")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Schedule was updated.
#[prost(message, optional, tag = "19")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Schedule should schedule the next run.
/// Having a next_run_time in the past means the runs are being started
/// behind schedule.
#[prost(message, optional, tag = "7")]
pub next_run_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Schedule was last paused.
/// Unset if never paused.
#[prost(message, optional, tag = "8")]
pub last_pause_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Schedule was last resumed.
/// Unset if never resumed from pause.
#[prost(message, optional, tag = "9")]
pub last_resume_time: ::core::option::Option<::prost_types::Timestamp>,
/// Required. Maximum number of runs that can be started concurrently for this
/// Schedule. This is the limit for starting the scheduled requests and not the
/// execution of the operations/jobs created by the requests (if applicable).
#[prost(int64, tag = "11")]
pub max_concurrent_run_count: i64,
/// Optional. Whether new scheduled runs can be queued when max_concurrent_runs
/// limit is reached. If set to true, new runs will be queued instead of
/// skipped. Default to false.
#[prost(bool, tag = "12")]
pub allow_queueing: bool,
/// Output only. Whether to backfill missed runs when the schedule is resumed
/// from PAUSED state. If set to true, all missed runs will be scheduled. New
/// runs will be scheduled after the backfill is complete. Default to false.
#[prost(bool, tag = "13")]
pub catch_up: bool,
/// Output only. Response of the last scheduled run.
/// This is the response for starting the scheduled requests and not the
/// execution of the operations/jobs created by the requests (if applicable).
/// Unset if no run has been scheduled yet.
#[prost(message, optional, tag = "18")]
pub last_scheduled_run_response: ::core::option::Option<schedule::RunResponse>,
/// Required.
/// The time specification to launch scheduled runs.
#[prost(oneof = "schedule::TimeSpecification", tags = "10")]
pub time_specification: ::core::option::Option<schedule::TimeSpecification>,
/// Required.
/// The API request template to launch the scheduled runs.
/// User-specified ID is not supported in the request template.
#[prost(oneof = "schedule::Request", tags = "14, 20")]
pub request: ::core::option::Option<schedule::Request>,
}
/// Nested message and enum types in `Schedule`.
pub mod schedule {
/// Status of a scheduled run.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunResponse {
/// The scheduled run time based on the user-specified schedule.
#[prost(message, optional, tag = "1")]
pub scheduled_run_time: ::core::option::Option<::prost_types::Timestamp>,
/// The response of the scheduled run.
#[prost(string, tag = "2")]
pub run_response: ::prost::alloc::string::String,
}
/// Possible state of the schedule.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified.
Unspecified = 0,
/// The Schedule is active. Runs are being scheduled on the user-specified
/// timespec.
Active = 1,
/// The schedule is paused. No new runs will be created until the schedule
/// is resumed. Already started runs will be allowed to complete.
Paused = 2,
/// The Schedule is completed. No new runs will be scheduled. Already started
/// runs will be allowed to complete. Schedules in completed state cannot be
/// paused or resumed.
Completed = 3,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Active => "ACTIVE",
State::Paused => "PAUSED",
State::Completed => "COMPLETED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"ACTIVE" => Some(Self::Active),
"PAUSED" => Some(Self::Paused),
"COMPLETED" => Some(Self::Completed),
_ => None,
}
}
}
/// Required.
/// The time specification to launch scheduled runs.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TimeSpecification {
/// Cron schedule (<https://en.wikipedia.org/wiki/Cron>) to launch scheduled
/// runs. To explicitly set a timezone to the cron tab, apply a prefix in the
/// cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
/// The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
/// database. For example, "CRON_TZ=America/New_York 1 * * * *", or
/// "TZ=America/New_York 1 * * * *".
#[prost(string, tag = "10")]
Cron(::prost::alloc::string::String),
}
/// Required.
/// The API request template to launch the scheduled runs.
/// User-specified ID is not supported in the request template.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Request {
/// Request for
/// [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].
/// CreatePipelineJobRequest.parent field is required (format:
/// projects/{project}/locations/{location}).
#[prost(message, tag = "14")]
CreatePipelineJobRequest(super::CreatePipelineJobRequest),
/// Request for
/// [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
#[prost(message, tag = "20")]
CreateNotebookExecutionJobRequest(super::CreateNotebookExecutionJobRequest),
}
}
/// A message representing a Study.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Study {
/// Output only. The name of a study. The study's globally unique identifier.
/// Format: `projects/{project}/locations/{location}/studies/{study}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. Describes the Study, default value is empty string.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. Configuration of the Study.
#[prost(message, optional, tag = "3")]
pub study_spec: ::core::option::Option<StudySpec>,
/// Output only. The detailed state of a Study.
#[prost(enumeration = "study::State", tag = "4")]
pub state: i32,
/// Output only. Time at which the study was created.
#[prost(message, optional, tag = "5")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. A human readable reason why the Study is inactive.
/// This should be empty if a study is ACTIVE or COMPLETED.
#[prost(string, tag = "6")]
pub inactive_reason: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Study`.
pub mod study {
/// Describes the Study state.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// The study state is unspecified.
Unspecified = 0,
/// The study is active.
Active = 1,
/// The study is stopped due to an internal error.
Inactive = 2,
/// The study is done when the service exhausts the parameter search space
/// or max_trial_count is reached.
Completed = 3,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Active => "ACTIVE",
State::Inactive => "INACTIVE",
State::Completed => "COMPLETED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"ACTIVE" => Some(Self::Active),
"INACTIVE" => Some(Self::Inactive),
"COMPLETED" => Some(Self::Completed),
_ => None,
}
}
}
}
/// A message representing a Trial. A Trial contains a unique set of Parameters
/// that has been or will be evaluated, along with the objective metrics got by
/// running the Trial.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Trial {
/// Output only. Resource name of the Trial assigned by the service.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. The identifier of the Trial assigned by the service.
#[prost(string, tag = "2")]
pub id: ::prost::alloc::string::String,
/// Output only. The detailed state of the Trial.
#[prost(enumeration = "trial::State", tag = "3")]
pub state: i32,
/// Output only. The parameters of the Trial.
#[prost(message, repeated, tag = "4")]
pub parameters: ::prost::alloc::vec::Vec<trial::Parameter>,
/// Output only. The final measurement containing the objective value.
#[prost(message, optional, tag = "5")]
pub final_measurement: ::core::option::Option<Measurement>,
/// Output only. A list of measurements that are strictly lexicographically
/// ordered by their induced tuples (steps, elapsed_duration).
/// These are used for early stopping computations.
#[prost(message, repeated, tag = "6")]
pub measurements: ::prost::alloc::vec::Vec<Measurement>,
/// Output only. Time when the Trial was started.
#[prost(message, optional, tag = "7")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the Trial's status changed to `SUCCEEDED` or
/// `INFEASIBLE`.
#[prost(message, optional, tag = "8")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The identifier of the client that originally requested this
/// Trial. Each client is identified by a unique client_id. When a client asks
/// for a suggestion, Vertex AI Vizier will assign it a Trial. The client
/// should evaluate the Trial, complete it, and report back to Vertex AI
/// Vizier. If suggestion is asked again by same client_id before the Trial is
/// completed, the same Trial will be returned. Multiple clients with
/// different client_ids can ask for suggestions simultaneously, each of them
/// will get their own Trial.
#[prost(string, tag = "9")]
pub client_id: ::prost::alloc::string::String,
/// Output only. A human readable string describing why the Trial is
/// infeasible. This is set only if Trial state is `INFEASIBLE`.
#[prost(string, tag = "10")]
pub infeasible_reason: ::prost::alloc::string::String,
/// Output only. The CustomJob name linked to the Trial.
/// It's set for a HyperparameterTuningJob's Trial.
#[prost(string, tag = "11")]
pub custom_job: ::prost::alloc::string::String,
/// Output only. URIs for accessing [interactive
/// shells](<https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell>)
/// (one URI for each training node). Only available if this trial is part of
/// a
/// [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob]
/// and the job's
/// [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
/// field is `true`.
///
/// The keys are names of each node used for the trial; for example,
/// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
/// the second worker pool, and `workerpool1-1` for the second node in the
/// second worker pool.
///
/// The values are the URIs for each node's interactive shell.
#[prost(btree_map = "string, string", tag = "12")]
pub web_access_uris: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
}
/// Nested message and enum types in `Trial`.
pub mod trial {
/// A message representing a parameter to be tuned.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Parameter {
/// Output only. The ID of the parameter. The parameter should be defined in
/// [StudySpec's
/// Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
#[prost(string, tag = "1")]
pub parameter_id: ::prost::alloc::string::String,
/// Output only. The value of the parameter.
/// `number_value` will be set if a parameter defined in StudySpec is
/// in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
/// `string_value` will be set if a parameter defined in StudySpec is
/// in type 'CATEGORICAL'.
#[prost(message, optional, tag = "2")]
pub value: ::core::option::Option<::prost_types::Value>,
}
/// Describes a Trial state.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// The Trial state is unspecified.
Unspecified = 0,
/// Indicates that a specific Trial has been requested, but it has not yet
/// been suggested by the service.
Requested = 1,
/// Indicates that the Trial has been suggested.
Active = 2,
/// Indicates that the Trial should stop according to the service.
Stopping = 3,
/// Indicates that the Trial is completed successfully.
Succeeded = 4,
/// Indicates that the Trial should not be attempted again.
/// The service will set a Trial to INFEASIBLE when it's done but missing
/// the final_measurement.
Infeasible = 5,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Requested => "REQUESTED",
State::Active => "ACTIVE",
State::Stopping => "STOPPING",
State::Succeeded => "SUCCEEDED",
State::Infeasible => "INFEASIBLE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"REQUESTED" => Some(Self::Requested),
"ACTIVE" => Some(Self::Active),
"STOPPING" => Some(Self::Stopping),
"SUCCEEDED" => Some(Self::Succeeded),
"INFEASIBLE" => Some(Self::Infeasible),
_ => None,
}
}
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TrialContext {
/// A human-readable field which can store a description of this context.
/// This will become part of the resulting Trial's description field.
#[prost(string, tag = "1")]
pub description: ::prost::alloc::string::String,
/// If/when a Trial is generated or selected from this Context,
/// its Parameters will match any parameters specified here.
/// (I.e. if this context specifies parameter name:'a' int_value:3,
/// then a resulting Trial will have int_value:3 for its parameter named
/// 'a'.) Note that we first attempt to match existing REQUESTED Trials with
/// contexts, and if there are no matches, we generate suggestions in the
/// subspace defined by the parameters specified here.
/// NOTE: a Context without any Parameters matches the entire feasible search
/// space.
#[prost(message, repeated, tag = "2")]
pub parameters: ::prost::alloc::vec::Vec<trial::Parameter>,
}
/// Time-based Constraint for Study
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct StudyTimeConstraint {
#[prost(oneof = "study_time_constraint::Constraint", tags = "1, 2")]
pub constraint: ::core::option::Option<study_time_constraint::Constraint>,
}
/// Nested message and enum types in `StudyTimeConstraint`.
pub mod study_time_constraint {
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Constraint {
/// Counts the wallclock time passed since the creation of this Study.
#[prost(message, tag = "1")]
MaxDuration(::prost_types::Duration),
/// Compares the wallclock time to this time. Must use UTC timezone.
#[prost(message, tag = "2")]
EndTime(::prost_types::Timestamp),
}
}
/// Represents specification of a Study.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StudySpec {
/// Required. Metric specs for the Study.
#[prost(message, repeated, tag = "1")]
pub metrics: ::prost::alloc::vec::Vec<study_spec::MetricSpec>,
/// Required. The set of parameters to tune.
#[prost(message, repeated, tag = "2")]
pub parameters: ::prost::alloc::vec::Vec<study_spec::ParameterSpec>,
/// The search algorithm specified for the Study.
#[prost(enumeration = "study_spec::Algorithm", tag = "3")]
pub algorithm: i32,
/// The observation noise level of the study.
/// Currently only supported by the Vertex AI Vizier service. Not supported by
/// HyperparameterTuningJob or TrainingPipeline.
#[prost(enumeration = "study_spec::ObservationNoise", tag = "6")]
pub observation_noise: i32,
/// Describe which measurement selection type will be used
#[prost(enumeration = "study_spec::MeasurementSelectionType", tag = "7")]
pub measurement_selection_type: i32,
/// Conditions for automated stopping of a Study. Enable automated stopping by
/// configuring at least one condition.
#[prost(message, optional, tag = "11")]
pub study_stopping_config: ::core::option::Option<study_spec::StudyStoppingConfig>,
#[prost(oneof = "study_spec::AutomatedStoppingSpec", tags = "4, 5, 9")]
pub automated_stopping_spec: ::core::option::Option<
study_spec::AutomatedStoppingSpec,
>,
}
/// Nested message and enum types in `StudySpec`.
pub mod study_spec {
/// Represents a metric to optimize.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetricSpec {
/// Required. The ID of the metric. Must not contain whitespaces and must be
/// unique amongst all MetricSpecs.
#[prost(string, tag = "1")]
pub metric_id: ::prost::alloc::string::String,
/// Required. The optimization goal of the metric.
#[prost(enumeration = "metric_spec::GoalType", tag = "2")]
pub goal: i32,
/// Used for safe search. In the case, the metric will be a safety
/// metric. You must provide a separate metric for objective metric.
#[prost(message, optional, tag = "3")]
pub safety_config: ::core::option::Option<metric_spec::SafetyMetricConfig>,
}
/// Nested message and enum types in `MetricSpec`.
pub mod metric_spec {
/// Used in safe optimization to specify threshold levels and risk tolerance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SafetyMetricConfig {
/// Safety threshold (boundary value between safe and unsafe). NOTE that if
/// you leave SafetyMetricConfig unset, a default value of 0 will be used.
#[prost(double, tag = "1")]
pub safety_threshold: f64,
/// Desired minimum fraction of safe trials (over total number of trials)
/// that should be targeted by the algorithm at any time during the
/// study (best effort). This should be between 0.0 and 1.0 and a value of
/// 0.0 means that there is no minimum and an algorithm proceeds without
/// targeting any specific fraction. A value of 1.0 means that the
/// algorithm attempts to only Suggest safe Trials.
#[prost(double, optional, tag = "2")]
pub desired_min_safe_trials_fraction: ::core::option::Option<f64>,
}
/// The available types of optimization goals.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum GoalType {
/// Goal Type will default to maximize.
Unspecified = 0,
/// Maximize the goal metric.
Maximize = 1,
/// Minimize the goal metric.
Minimize = 2,
}
impl GoalType {
/// 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 {
GoalType::Unspecified => "GOAL_TYPE_UNSPECIFIED",
GoalType::Maximize => "MAXIMIZE",
GoalType::Minimize => "MINIMIZE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"GOAL_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"MAXIMIZE" => Some(Self::Maximize),
"MINIMIZE" => Some(Self::Minimize),
_ => None,
}
}
}
}
/// Represents a single parameter to optimize.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ParameterSpec {
/// Required. The ID of the parameter. Must not contain whitespaces and must
/// be unique amongst all ParameterSpecs.
#[prost(string, tag = "1")]
pub parameter_id: ::prost::alloc::string::String,
/// How the parameter should be scaled.
/// Leave unset for `CATEGORICAL` parameters.
#[prost(enumeration = "parameter_spec::ScaleType", tag = "6")]
pub scale_type: i32,
/// A conditional parameter node is active if the parameter's value matches
/// the conditional node's parent_value_condition.
///
/// If two items in conditional_parameter_specs have the same name, they
/// must have disjoint parent_value_condition.
#[prost(message, repeated, tag = "10")]
pub conditional_parameter_specs: ::prost::alloc::vec::Vec<
parameter_spec::ConditionalParameterSpec,
>,
#[prost(oneof = "parameter_spec::ParameterValueSpec", tags = "2, 3, 4, 5")]
pub parameter_value_spec: ::core::option::Option<
parameter_spec::ParameterValueSpec,
>,
}
/// Nested message and enum types in `ParameterSpec`.
pub mod parameter_spec {
/// Value specification for a parameter in `DOUBLE` type.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DoubleValueSpec {
/// Required. Inclusive minimum value of the parameter.
#[prost(double, tag = "1")]
pub min_value: f64,
/// Required. Inclusive maximum value of the parameter.
#[prost(double, tag = "2")]
pub max_value: f64,
/// A default value for a `DOUBLE` parameter that is assumed to be a
/// relatively good starting point. Unset value signals that there is no
/// offered starting point.
///
/// Currently only supported by the Vertex AI Vizier service. Not supported
/// by HyperparameterTuningJob or TrainingPipeline.
#[prost(double, optional, tag = "4")]
pub default_value: ::core::option::Option<f64>,
}
/// Value specification for a parameter in `INTEGER` type.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct IntegerValueSpec {
/// Required. Inclusive minimum value of the parameter.
#[prost(int64, tag = "1")]
pub min_value: i64,
/// Required. Inclusive maximum value of the parameter.
#[prost(int64, tag = "2")]
pub max_value: i64,
/// A default value for an `INTEGER` parameter that is assumed to be a
/// relatively good starting point. Unset value signals that there is no
/// offered starting point.
///
/// Currently only supported by the Vertex AI Vizier service. Not supported
/// by HyperparameterTuningJob or TrainingPipeline.
#[prost(int64, optional, tag = "4")]
pub default_value: ::core::option::Option<i64>,
}
/// Value specification for a parameter in `CATEGORICAL` type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CategoricalValueSpec {
/// Required. The list of possible categories.
#[prost(string, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// A default value for a `CATEGORICAL` parameter that is assumed to be a
/// relatively good starting point. Unset value signals that there is no
/// offered starting point.
///
/// Currently only supported by the Vertex AI Vizier service. Not supported
/// by HyperparameterTuningJob or TrainingPipeline.
#[prost(string, optional, tag = "3")]
pub default_value: ::core::option::Option<::prost::alloc::string::String>,
}
/// Value specification for a parameter in `DISCRETE` type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DiscreteValueSpec {
/// Required. A list of possible values.
/// The list should be in increasing order and at least 1e-10 apart.
/// For instance, this parameter might have possible settings of 1.5, 2.5,
/// and 4.0. This list should not contain more than 1,000 values.
#[prost(double, repeated, packed = "false", tag = "1")]
pub values: ::prost::alloc::vec::Vec<f64>,
/// A default value for a `DISCRETE` parameter that is assumed to be a
/// relatively good starting point. Unset value signals that there is no
/// offered starting point. It automatically rounds to the
/// nearest feasible discrete point.
///
/// Currently only supported by the Vertex AI Vizier service. Not supported
/// by HyperparameterTuningJob or TrainingPipeline.
#[prost(double, optional, tag = "3")]
pub default_value: ::core::option::Option<f64>,
}
/// Represents a parameter spec with condition from its parent parameter.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ConditionalParameterSpec {
/// Required. The spec for a conditional parameter.
#[prost(message, optional, tag = "1")]
pub parameter_spec: ::core::option::Option<super::ParameterSpec>,
/// A set of parameter values from the parent ParameterSpec's feasible
/// space.
#[prost(
oneof = "conditional_parameter_spec::ParentValueCondition",
tags = "2, 3, 4"
)]
pub parent_value_condition: ::core::option::Option<
conditional_parameter_spec::ParentValueCondition,
>,
}
/// Nested message and enum types in `ConditionalParameterSpec`.
pub mod conditional_parameter_spec {
/// Represents the spec to match discrete values from parent parameter.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DiscreteValueCondition {
/// Required. Matches values of the parent parameter of 'DISCRETE' type.
/// All values must exist in `discrete_value_spec` of parent parameter.
///
/// The Epsilon of the value matching is 1e-10.
#[prost(double, repeated, packed = "false", tag = "1")]
pub values: ::prost::alloc::vec::Vec<f64>,
}
/// Represents the spec to match integer values from parent parameter.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IntValueCondition {
/// Required. Matches values of the parent parameter of 'INTEGER' type.
/// All values must lie in `integer_value_spec` of parent parameter.
#[prost(int64, repeated, packed = "false", tag = "1")]
pub values: ::prost::alloc::vec::Vec<i64>,
}
/// Represents the spec to match categorical values from parent parameter.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CategoricalValueCondition {
/// Required. Matches values of the parent parameter of 'CATEGORICAL'
/// type. All values must exist in `categorical_value_spec` of parent
/// parameter.
#[prost(string, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// A set of parameter values from the parent ParameterSpec's feasible
/// space.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ParentValueCondition {
/// The spec for matching values from a parent parameter of
/// `DISCRETE` type.
#[prost(message, tag = "2")]
ParentDiscreteValues(DiscreteValueCondition),
/// The spec for matching values from a parent parameter of `INTEGER`
/// type.
#[prost(message, tag = "3")]
ParentIntValues(IntValueCondition),
/// The spec for matching values from a parent parameter of
/// `CATEGORICAL` type.
#[prost(message, tag = "4")]
ParentCategoricalValues(CategoricalValueCondition),
}
}
/// The type of scaling that should be applied to this parameter.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ScaleType {
/// By default, no scaling is applied.
Unspecified = 0,
/// Scales the feasible space to (0, 1) linearly.
UnitLinearScale = 1,
/// Scales the feasible space logarithmically to (0, 1). The entire
/// feasible space must be strictly positive.
UnitLogScale = 2,
/// Scales the feasible space "reverse" logarithmically to (0, 1). The
/// result is that values close to the top of the feasible space are spread
/// out more than points near the bottom. The entire feasible space must be
/// strictly positive.
UnitReverseLogScale = 3,
}
impl ScaleType {
/// 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 {
ScaleType::Unspecified => "SCALE_TYPE_UNSPECIFIED",
ScaleType::UnitLinearScale => "UNIT_LINEAR_SCALE",
ScaleType::UnitLogScale => "UNIT_LOG_SCALE",
ScaleType::UnitReverseLogScale => "UNIT_REVERSE_LOG_SCALE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SCALE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"UNIT_LINEAR_SCALE" => Some(Self::UnitLinearScale),
"UNIT_LOG_SCALE" => Some(Self::UnitLogScale),
"UNIT_REVERSE_LOG_SCALE" => Some(Self::UnitReverseLogScale),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ParameterValueSpec {
/// The value spec for a 'DOUBLE' parameter.
#[prost(message, tag = "2")]
DoubleValueSpec(DoubleValueSpec),
/// The value spec for an 'INTEGER' parameter.
#[prost(message, tag = "3")]
IntegerValueSpec(IntegerValueSpec),
/// The value spec for a 'CATEGORICAL' parameter.
#[prost(message, tag = "4")]
CategoricalValueSpec(CategoricalValueSpec),
/// The value spec for a 'DISCRETE' parameter.
#[prost(message, tag = "5")]
DiscreteValueSpec(DiscreteValueSpec),
}
}
/// The decay curve automated stopping rule builds a Gaussian Process
/// Regressor to predict the final objective value of a Trial based on the
/// already completed Trials and the intermediate measurements of the current
/// Trial. Early stopping is requested for the current Trial if there is very
/// low probability to exceed the optimal value found so far.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DecayCurveAutomatedStoppingSpec {
/// True if
/// [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration]
/// is used as the x-axis of each Trials Decay Curve. Otherwise,
/// [Measurement.step_count][google.cloud.aiplatform.v1.Measurement.step_count]
/// will be used as the x-axis.
#[prost(bool, tag = "1")]
pub use_elapsed_duration: bool,
}
/// The median automated stopping rule stops a pending Trial if the Trial's
/// best objective_value is strictly below the median 'performance' of all
/// completed Trials reported up to the Trial's last measurement.
/// Currently, 'performance' refers to the running average of the objective
/// values reported by the Trial in each measurement.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct MedianAutomatedStoppingSpec {
/// True if median automated stopping rule applies on
/// [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration].
/// It means that elapsed_duration field of latest measurement of current
/// Trial is used to compute median objective value for each completed
/// Trials.
#[prost(bool, tag = "1")]
pub use_elapsed_duration: bool,
}
/// Configuration for ConvexAutomatedStoppingSpec.
/// When there are enough completed trials (configured by
/// min_measurement_count), for pending trials with enough measurements and
/// steps, the policy first computes an overestimate of the objective value at
/// max_num_steps according to the slope of the incomplete objective value
/// curve. No prediction can be made if the curve is completely flat. If the
/// overestimation is worse than the best objective value of the completed
/// trials, this pending trial will be early-stopped, but a last measurement
/// will be added to the pending trial with max_num_steps and predicted
/// objective value from the autoregression model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ConvexAutomatedStoppingSpec {
/// Steps used in predicting the final objective for early stopped trials. In
/// general, it's set to be the same as the defined steps in training /
/// tuning. If not defined, it will learn it from the completed trials. When
/// use_steps is false, this field is set to the maximum elapsed seconds.
#[prost(int64, tag = "1")]
pub max_step_count: i64,
/// Minimum number of steps for a trial to complete. Trials which do not have
/// a measurement with step_count > min_step_count won't be considered for
/// early stopping. It's ok to set it to 0, and a trial can be early stopped
/// at any stage. By default, min_step_count is set to be one-tenth of the
/// max_step_count.
/// When use_elapsed_duration is true, this field is set to the minimum
/// elapsed seconds.
#[prost(int64, tag = "2")]
pub min_step_count: i64,
/// The minimal number of measurements in a Trial. Early-stopping checks
/// will not trigger if less than min_measurement_count+1 completed trials or
/// pending trials with less than min_measurement_count measurements. If not
/// defined, the default value is 5.
#[prost(int64, tag = "3")]
pub min_measurement_count: i64,
/// The hyper-parameter name used in the tuning job that stands for learning
/// rate. Leave it blank if learning rate is not in a parameter in tuning.
/// The learning_rate is used to estimate the objective value of the ongoing
/// trial.
#[prost(string, tag = "4")]
pub learning_rate_parameter_name: ::prost::alloc::string::String,
/// This bool determines whether or not the rule is applied based on
/// elapsed_secs or steps. If use_elapsed_duration==false, the early stopping
/// decision is made according to the predicted objective values according to
/// the target steps. If use_elapsed_duration==true, elapsed_secs is used
/// instead of steps. Also, in this case, the parameters max_num_steps and
/// min_num_steps are overloaded to contain max_elapsed_seconds and
/// min_elapsed_seconds.
#[prost(bool, tag = "5")]
pub use_elapsed_duration: bool,
/// ConvexAutomatedStoppingSpec by default only updates the trials that needs
/// to be early stopped using a newly trained auto-regressive model. When
/// this flag is set to True, all stopped trials from the beginning are
/// potentially updated in terms of their `final_measurement`. Also, note
/// that the training logic of autoregressive models is different in this
/// case. Enabling this option has shown better results and this may be the
/// default option in the future.
#[prost(bool, optional, tag = "6")]
pub update_all_stopped_trials: ::core::option::Option<bool>,
}
/// The configuration (stopping conditions) for automated stopping of a Study.
/// Conditions include trial budgets, time budgets, and convergence detection.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct StudyStoppingConfig {
/// If true, a Study enters STOPPING_ASAP whenever it would normally enters
/// STOPPING state.
///
/// The bottom line is: set to true if you want to interrupt on-going
/// evaluations of Trials as soon as the study stopping condition is met.
/// (Please see Study.State documentation for the source of truth).
#[prost(message, optional, tag = "1")]
pub should_stop_asap: ::core::option::Option<bool>,
/// Each "stopping rule" in this proto specifies an "if" condition. Before
/// Vizier would generate a new suggestion, it first checks each specified
/// stopping rule, from top to bottom in this list.
/// Note that the first few rules (e.g. minimum_runtime_constraint,
/// min_num_trials) will prevent other stopping rules from being evaluated
/// until they are met. For example, setting `min_num_trials=5` and
/// `always_stop_after= 1 hour` means that the Study will ONLY stop after it
/// has 5 COMPLETED trials, even if more than an hour has passed since its
/// creation. It follows the first applicable rule (whose "if" condition is
/// satisfied) to make a stopping decision. If none of the specified rules
/// are applicable, then Vizier decides that the study should not stop.
/// If Vizier decides that the study should stop, the study enters
/// STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
/// IMPORTANT: The automatic study state transition happens precisely as
/// described above; that is, deleting trials or updating StudyConfig NEVER
/// automatically moves the study state back to ACTIVE. If you want to
/// _resume_ a Study that was stopped, 1) change the stopping conditions if
/// necessary, 2) activate the study, and then 3) ask for suggestions.
/// If the specified time or duration has not passed, do not stop the
/// study.
#[prost(message, optional, tag = "2")]
pub minimum_runtime_constraint: ::core::option::Option<
super::StudyTimeConstraint,
>,
/// If the specified time or duration has passed, stop the study.
#[prost(message, optional, tag = "3")]
pub maximum_runtime_constraint: ::core::option::Option<
super::StudyTimeConstraint,
>,
/// If there are fewer than this many COMPLETED trials, do not stop the
/// study.
#[prost(message, optional, tag = "4")]
pub min_num_trials: ::core::option::Option<i32>,
/// If there are more than this many trials, stop the study.
#[prost(message, optional, tag = "5")]
pub max_num_trials: ::core::option::Option<i32>,
/// If the objective value has not improved for this many consecutive
/// trials, stop the study.
///
/// WARNING: Effective only for single-objective studies.
#[prost(message, optional, tag = "6")]
pub max_num_trials_no_progress: ::core::option::Option<i32>,
/// If the objective value has not improved for this much time, stop the
/// study.
///
/// WARNING: Effective only for single-objective studies.
#[prost(message, optional, tag = "7")]
pub max_duration_no_progress: ::core::option::Option<::prost_types::Duration>,
}
/// The available search algorithms for the Study.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Algorithm {
/// The default algorithm used by Vertex AI for [hyperparameter
/// tuning](<https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview>)
/// and [Vertex AI Vizier](<https://cloud.google.com/vertex-ai/docs/vizier>).
Unspecified = 0,
/// Simple grid search within the feasible space. To use grid search,
/// all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.
GridSearch = 2,
/// Simple random search within the feasible space.
RandomSearch = 3,
}
impl Algorithm {
/// 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 {
Algorithm::Unspecified => "ALGORITHM_UNSPECIFIED",
Algorithm::GridSearch => "GRID_SEARCH",
Algorithm::RandomSearch => "RANDOM_SEARCH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ALGORITHM_UNSPECIFIED" => Some(Self::Unspecified),
"GRID_SEARCH" => Some(Self::GridSearch),
"RANDOM_SEARCH" => Some(Self::RandomSearch),
_ => None,
}
}
}
/// Describes the noise level of the repeated observations.
///
/// "Noisy" means that the repeated observations with the same Trial parameters
/// may lead to different metric evaluations.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ObservationNoise {
/// The default noise level chosen by Vertex AI.
Unspecified = 0,
/// Vertex AI assumes that the objective function is (nearly)
/// perfectly reproducible, and will never repeat the same Trial
/// parameters.
Low = 1,
/// Vertex AI will estimate the amount of noise in metric
/// evaluations, it may repeat the same Trial parameters more than once.
High = 2,
}
impl ObservationNoise {
/// 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 {
ObservationNoise::Unspecified => "OBSERVATION_NOISE_UNSPECIFIED",
ObservationNoise::Low => "LOW",
ObservationNoise::High => "HIGH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OBSERVATION_NOISE_UNSPECIFIED" => Some(Self::Unspecified),
"LOW" => Some(Self::Low),
"HIGH" => Some(Self::High),
_ => None,
}
}
}
/// This indicates which measurement to use if/when the service automatically
/// selects the final measurement from previously reported intermediate
/// measurements. Choose this based on two considerations:
/// A) Do you expect your measurements to monotonically improve?
/// If so, choose LAST_MEASUREMENT. On the other hand, if you're in a
/// situation where your system can "over-train" and you expect the
/// performance to get better for a while but then start declining,
/// choose BEST_MEASUREMENT.
/// B) Are your measurements significantly noisy and/or irreproducible?
/// If so, BEST_MEASUREMENT will tend to be over-optimistic, and it
/// may be better to choose LAST_MEASUREMENT.
/// If both or neither of (A) and (B) apply, it doesn't matter which
/// selection type is chosen.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum MeasurementSelectionType {
/// Will be treated as LAST_MEASUREMENT.
Unspecified = 0,
/// Use the last measurement reported.
LastMeasurement = 1,
/// Use the best measurement reported.
BestMeasurement = 2,
}
impl MeasurementSelectionType {
/// 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 {
MeasurementSelectionType::Unspecified => {
"MEASUREMENT_SELECTION_TYPE_UNSPECIFIED"
}
MeasurementSelectionType::LastMeasurement => "LAST_MEASUREMENT",
MeasurementSelectionType::BestMeasurement => "BEST_MEASUREMENT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MEASUREMENT_SELECTION_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"LAST_MEASUREMENT" => Some(Self::LastMeasurement),
"BEST_MEASUREMENT" => Some(Self::BestMeasurement),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum AutomatedStoppingSpec {
/// The automated early stopping spec using decay curve rule.
#[prost(message, tag = "4")]
DecayCurveStoppingSpec(DecayCurveAutomatedStoppingSpec),
/// The automated early stopping spec using median rule.
#[prost(message, tag = "5")]
MedianAutomatedStoppingSpec(MedianAutomatedStoppingSpec),
/// The automated early stopping spec using convex stopping rule.
#[prost(message, tag = "9")]
ConvexAutomatedStoppingSpec(ConvexAutomatedStoppingSpec),
}
}
/// A message representing a Measurement of a Trial. A Measurement contains
/// the Metrics got by executing a Trial using suggested hyperparameter
/// values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Measurement {
/// Output only. Time that the Trial has been running at the point of this
/// Measurement.
#[prost(message, optional, tag = "1")]
pub elapsed_duration: ::core::option::Option<::prost_types::Duration>,
/// Output only. The number of steps the machine learning model has been
/// trained for. Must be non-negative.
#[prost(int64, tag = "2")]
pub step_count: i64,
/// Output only. A list of metrics got by evaluating the objective functions
/// using suggested Parameter values.
#[prost(message, repeated, tag = "3")]
pub metrics: ::prost::alloc::vec::Vec<measurement::Metric>,
}
/// Nested message and enum types in `Measurement`.
pub mod measurement {
/// A message representing a metric in the measurement.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Metric {
/// Output only. The ID of the Metric. The Metric should be defined in
/// [StudySpec's Metrics][google.cloud.aiplatform.v1.StudySpec.metrics].
#[prost(string, tag = "1")]
pub metric_id: ::prost::alloc::string::String,
/// Output only. The value for this metric.
#[prost(double, tag = "2")]
pub value: f64,
}
}
/// TensorboardRun maps to a specific execution of a training job with a given
/// set of hyperparameter values, model definition, dataset, etc
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TensorboardRun {
/// Output only. Name of the TensorboardRun.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. User provided name of this TensorboardRun.
/// This value must be unique among all TensorboardRuns
/// belonging to the same parent TensorboardExperiment.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Description of this TensorboardRun.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. Timestamp when this TensorboardRun was created.
#[prost(message, optional, tag = "6")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this TensorboardRun was last updated.
#[prost(message, optional, tag = "7")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The labels with user-defined metadata to organize your TensorboardRuns.
///
/// This field will be used to filter and visualize Runs in the Tensorboard UI.
/// For example, a Vertex AI training job can set a label
/// aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
/// within that job. An end user can set a label experiment_id=xxxxx for all
/// the runs produced in a Jupyter notebook. These runs can be grouped by a
/// label value and visualized together in the Tensorboard UI.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one TensorboardRun
/// (System labels are excluded).
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "8")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Used to perform a consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "9")]
pub etag: ::prost::alloc::string::String,
}
/// Request message for EvaluationService.EvaluateInstances.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EvaluateInstancesRequest {
/// Required. The resource name of the Location to evaluate the instances.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub location: ::prost::alloc::string::String,
/// Instances and specs for evaluation
#[prost(
oneof = "evaluate_instances_request::MetricInputs",
tags = "2, 3, 4, 5, 6, 8, 9, 12, 7, 23, 14, 15, 10, 24, 16, 17, 18, 28, 29, 19, 20, 21, 22"
)]
pub metric_inputs: ::core::option::Option<evaluate_instances_request::MetricInputs>,
}
/// Nested message and enum types in `EvaluateInstancesRequest`.
pub mod evaluate_instances_request {
/// Instances and specs for evaluation
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum MetricInputs {
/// Auto metric instances.
/// Instances and metric spec for exact match metric.
#[prost(message, tag = "2")]
ExactMatchInput(super::ExactMatchInput),
/// Instances and metric spec for bleu metric.
#[prost(message, tag = "3")]
BleuInput(super::BleuInput),
/// Instances and metric spec for rouge metric.
#[prost(message, tag = "4")]
RougeInput(super::RougeInput),
/// LLM-based metric instance.
/// General text generation metrics, applicable to other categories.
/// Input for fluency metric.
#[prost(message, tag = "5")]
FluencyInput(super::FluencyInput),
/// Input for coherence metric.
#[prost(message, tag = "6")]
CoherenceInput(super::CoherenceInput),
/// Input for safety metric.
#[prost(message, tag = "8")]
SafetyInput(super::SafetyInput),
/// Input for groundedness metric.
#[prost(message, tag = "9")]
GroundednessInput(super::GroundednessInput),
/// Input for fulfillment metric.
#[prost(message, tag = "12")]
FulfillmentInput(super::FulfillmentInput),
/// Input for summarization quality metric.
#[prost(message, tag = "7")]
SummarizationQualityInput(super::SummarizationQualityInput),
/// Input for pairwise summarization quality metric.
#[prost(message, tag = "23")]
PairwiseSummarizationQualityInput(super::PairwiseSummarizationQualityInput),
/// Input for summarization helpfulness metric.
#[prost(message, tag = "14")]
SummarizationHelpfulnessInput(super::SummarizationHelpfulnessInput),
/// Input for summarization verbosity metric.
#[prost(message, tag = "15")]
SummarizationVerbosityInput(super::SummarizationVerbosityInput),
/// Input for question answering quality metric.
#[prost(message, tag = "10")]
QuestionAnsweringQualityInput(super::QuestionAnsweringQualityInput),
/// Input for pairwise question answering quality metric.
#[prost(message, tag = "24")]
PairwiseQuestionAnsweringQualityInput(
super::PairwiseQuestionAnsweringQualityInput,
),
/// Input for question answering relevance metric.
#[prost(message, tag = "16")]
QuestionAnsweringRelevanceInput(super::QuestionAnsweringRelevanceInput),
/// Input for question answering helpfulness
/// metric.
#[prost(message, tag = "17")]
QuestionAnsweringHelpfulnessInput(super::QuestionAnsweringHelpfulnessInput),
/// Input for question answering correctness
/// metric.
#[prost(message, tag = "18")]
QuestionAnsweringCorrectnessInput(super::QuestionAnsweringCorrectnessInput),
/// Input for pointwise metric.
#[prost(message, tag = "28")]
PointwiseMetricInput(super::PointwiseMetricInput),
/// Input for pairwise metric.
#[prost(message, tag = "29")]
PairwiseMetricInput(super::PairwiseMetricInput),
/// Tool call metric instances.
/// Input for tool call valid metric.
#[prost(message, tag = "19")]
ToolCallValidInput(super::ToolCallValidInput),
/// Input for tool name match metric.
#[prost(message, tag = "20")]
ToolNameMatchInput(super::ToolNameMatchInput),
/// Input for tool parameter key match metric.
#[prost(message, tag = "21")]
ToolParameterKeyMatchInput(super::ToolParameterKeyMatchInput),
/// Input for tool parameter key value match metric.
#[prost(message, tag = "22")]
ToolParameterKvMatchInput(super::ToolParameterKvMatchInput),
}
}
/// Response message for EvaluationService.EvaluateInstances.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EvaluateInstancesResponse {
/// Evaluation results will be served in the same order as presented in
/// EvaluationRequest.instances.
#[prost(
oneof = "evaluate_instances_response::EvaluationResults",
tags = "1, 2, 3, 4, 5, 7, 8, 11, 6, 22, 13, 14, 9, 23, 15, 16, 17, 27, 28, 18, 19, 20, 21"
)]
pub evaluation_results: ::core::option::Option<
evaluate_instances_response::EvaluationResults,
>,
}
/// Nested message and enum types in `EvaluateInstancesResponse`.
pub mod evaluate_instances_response {
/// Evaluation results will be served in the same order as presented in
/// EvaluationRequest.instances.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum EvaluationResults {
/// Auto metric evaluation results.
/// Results for exact match metric.
#[prost(message, tag = "1")]
ExactMatchResults(super::ExactMatchResults),
/// Results for bleu metric.
#[prost(message, tag = "2")]
BleuResults(super::BleuResults),
/// Results for rouge metric.
#[prost(message, tag = "3")]
RougeResults(super::RougeResults),
/// LLM-based metric evaluation result.
/// General text generation metrics, applicable to other categories.
/// Result for fluency metric.
#[prost(message, tag = "4")]
FluencyResult(super::FluencyResult),
/// Result for coherence metric.
#[prost(message, tag = "5")]
CoherenceResult(super::CoherenceResult),
/// Result for safety metric.
#[prost(message, tag = "7")]
SafetyResult(super::SafetyResult),
/// Result for groundedness metric.
#[prost(message, tag = "8")]
GroundednessResult(super::GroundednessResult),
/// Result for fulfillment metric.
#[prost(message, tag = "11")]
FulfillmentResult(super::FulfillmentResult),
/// Summarization only metrics.
/// Result for summarization quality metric.
#[prost(message, tag = "6")]
SummarizationQualityResult(super::SummarizationQualityResult),
/// Result for pairwise summarization quality metric.
#[prost(message, tag = "22")]
PairwiseSummarizationQualityResult(super::PairwiseSummarizationQualityResult),
/// Result for summarization helpfulness metric.
#[prost(message, tag = "13")]
SummarizationHelpfulnessResult(super::SummarizationHelpfulnessResult),
/// Result for summarization verbosity metric.
#[prost(message, tag = "14")]
SummarizationVerbosityResult(super::SummarizationVerbosityResult),
/// Question answering only metrics.
/// Result for question answering quality metric.
#[prost(message, tag = "9")]
QuestionAnsweringQualityResult(super::QuestionAnsweringQualityResult),
/// Result for pairwise question answering quality metric.
#[prost(message, tag = "23")]
PairwiseQuestionAnsweringQualityResult(
super::PairwiseQuestionAnsweringQualityResult,
),
/// Result for question answering relevance metric.
#[prost(message, tag = "15")]
QuestionAnsweringRelevanceResult(super::QuestionAnsweringRelevanceResult),
/// Result for question answering helpfulness metric.
#[prost(message, tag = "16")]
QuestionAnsweringHelpfulnessResult(super::QuestionAnsweringHelpfulnessResult),
/// Result for question answering correctness metric.
#[prost(message, tag = "17")]
QuestionAnsweringCorrectnessResult(super::QuestionAnsweringCorrectnessResult),
/// Generic metrics.
/// Result for pointwise metric.
#[prost(message, tag = "27")]
PointwiseMetricResult(super::PointwiseMetricResult),
/// Result for pairwise metric.
#[prost(message, tag = "28")]
PairwiseMetricResult(super::PairwiseMetricResult),
/// Tool call metrics.
/// Results for tool call valid metric.
#[prost(message, tag = "18")]
ToolCallValidResults(super::ToolCallValidResults),
/// Results for tool name match metric.
#[prost(message, tag = "19")]
ToolNameMatchResults(super::ToolNameMatchResults),
/// Results for tool parameter key match metric.
#[prost(message, tag = "20")]
ToolParameterKeyMatchResults(super::ToolParameterKeyMatchResults),
/// Results for tool parameter key value match metric.
#[prost(message, tag = "21")]
ToolParameterKvMatchResults(super::ToolParameterKvMatchResults),
}
}
/// Input for exact match metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExactMatchInput {
/// Required. Spec for exact match metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<ExactMatchSpec>,
/// Required. Repeated exact match instances.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<ExactMatchInstance>,
}
/// Spec for exact match instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExactMatchInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for exact match metric - returns 1 if prediction and reference exactly
/// matches, otherwise 0.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ExactMatchSpec {}
/// Results for exact match metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExactMatchResults {
/// Output only. Exact match metric values.
#[prost(message, repeated, tag = "1")]
pub exact_match_metric_values: ::prost::alloc::vec::Vec<ExactMatchMetricValue>,
}
/// Exact match metric value for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ExactMatchMetricValue {
/// Output only. Exact match score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
}
/// Input for bleu metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BleuInput {
/// Required. Spec for bleu score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<BleuSpec>,
/// Required. Repeated bleu instances.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<BleuInstance>,
}
/// Spec for bleu instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BleuInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for bleu score metric - calculates the precision of n-grams in the
/// prediction as compared to reference - returns a score ranging between 0 to 1.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BleuSpec {
/// Optional. Whether to use_effective_order to compute bleu score.
#[prost(bool, tag = "1")]
pub use_effective_order: bool,
}
/// Results for bleu metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BleuResults {
/// Output only. Bleu metric values.
#[prost(message, repeated, tag = "1")]
pub bleu_metric_values: ::prost::alloc::vec::Vec<BleuMetricValue>,
}
/// Bleu metric value for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BleuMetricValue {
/// Output only. Bleu score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
}
/// Input for rouge metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RougeInput {
/// Required. Spec for rouge score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<RougeSpec>,
/// Required. Repeated rouge instances.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<RougeInstance>,
}
/// Spec for rouge instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RougeInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for rouge score metric - calculates the recall of n-grams in prediction
/// as compared to reference - returns a score ranging between 0 and 1.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RougeSpec {
/// Optional. Supported rouge types are rougen\[1-9\], rougeL, and rougeLsum.
#[prost(string, tag = "1")]
pub rouge_type: ::prost::alloc::string::String,
/// Optional. Whether to use stemmer to compute rouge score.
#[prost(bool, tag = "2")]
pub use_stemmer: bool,
/// Optional. Whether to split summaries while using rougeLsum.
#[prost(bool, tag = "3")]
pub split_summaries: bool,
}
/// Results for rouge metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RougeResults {
/// Output only. Rouge metric values.
#[prost(message, repeated, tag = "1")]
pub rouge_metric_values: ::prost::alloc::vec::Vec<RougeMetricValue>,
}
/// Rouge metric value for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RougeMetricValue {
/// Output only. Rouge score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
}
/// Input for coherence metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CoherenceInput {
/// Required. Spec for coherence score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<CoherenceSpec>,
/// Required. Coherence instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<CoherenceInstance>,
}
/// Spec for coherence instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CoherenceInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for coherence score metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CoherenceSpec {
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "1")]
pub version: i32,
}
/// Spec for coherence result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CoherenceResult {
/// Output only. Coherence score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for coherence score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for coherence score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for fluency metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FluencyInput {
/// Required. Spec for fluency score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<FluencySpec>,
/// Required. Fluency instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<FluencyInstance>,
}
/// Spec for fluency instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FluencyInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for fluency score metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FluencySpec {
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "1")]
pub version: i32,
}
/// Spec for fluency result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FluencyResult {
/// Output only. Fluency score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for fluency score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for fluency score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for safety metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SafetyInput {
/// Required. Spec for safety metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<SafetySpec>,
/// Required. Safety instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<SafetyInstance>,
}
/// Spec for safety instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SafetyInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for safety metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SafetySpec {
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "1")]
pub version: i32,
}
/// Spec for safety result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SafetyResult {
/// Output only. Safety score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for safety score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for safety score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for groundedness metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GroundednessInput {
/// Required. Spec for groundedness metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<GroundednessSpec>,
/// Required. Groundedness instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<GroundednessInstance>,
}
/// Spec for groundedness instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GroundednessInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Background information provided in context used to compare
/// against the prediction.
#[prost(string, optional, tag = "2")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for groundedness metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct GroundednessSpec {
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "1")]
pub version: i32,
}
/// Spec for groundedness result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GroundednessResult {
/// Output only. Groundedness score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for groundedness score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for groundedness score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for fulfillment metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FulfillmentInput {
/// Required. Spec for fulfillment score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<FulfillmentSpec>,
/// Required. Fulfillment instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<FulfillmentInstance>,
}
/// Spec for fulfillment instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FulfillmentInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Inference instruction prompt to compare prediction with.
#[prost(string, optional, tag = "2")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for fulfillment metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FulfillmentSpec {
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "1")]
pub version: i32,
}
/// Spec for fulfillment result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FulfillmentResult {
/// Output only. Fulfillment score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for fulfillment score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for fulfillment score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for summarization quality metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationQualityInput {
/// Required. Spec for summarization quality score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<SummarizationQualitySpec>,
/// Required. Summarization quality instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<SummarizationQualityInstance>,
}
/// Spec for summarization quality instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationQualityInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Text to be summarized.
#[prost(string, optional, tag = "3")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Summarization prompt for LLM.
#[prost(string, optional, tag = "4")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for summarization quality score metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SummarizationQualitySpec {
/// Optional. Whether to use instance.reference to compute summarization
/// quality.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for summarization quality result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationQualityResult {
/// Output only. Summarization Quality score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for summarization quality score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for summarization quality score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for pairwise summarization quality metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseSummarizationQualityInput {
/// Required. Spec for pairwise summarization quality score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<PairwiseSummarizationQualitySpec>,
/// Required. Pairwise summarization quality instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<PairwiseSummarizationQualityInstance>,
}
/// Spec for pairwise summarization quality instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseSummarizationQualityInstance {
/// Required. Output of the candidate model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Output of the baseline model.
#[prost(string, optional, tag = "2")]
pub baseline_prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "3")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Text to be summarized.
#[prost(string, optional, tag = "4")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Summarization prompt for LLM.
#[prost(string, optional, tag = "5")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for pairwise summarization quality score metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct PairwiseSummarizationQualitySpec {
/// Optional. Whether to use instance.reference to compute pairwise
/// summarization quality.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for pairwise summarization quality result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseSummarizationQualityResult {
/// Output only. Pairwise summarization prediction choice.
#[prost(enumeration = "PairwiseChoice", tag = "1")]
pub pairwise_choice: i32,
/// Output only. Explanation for summarization quality score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for summarization quality score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for summarization helpfulness metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationHelpfulnessInput {
/// Required. Spec for summarization helpfulness score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<SummarizationHelpfulnessSpec>,
/// Required. Summarization helpfulness instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<SummarizationHelpfulnessInstance>,
}
/// Spec for summarization helpfulness instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationHelpfulnessInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Text to be summarized.
#[prost(string, optional, tag = "3")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Summarization prompt for LLM.
#[prost(string, optional, tag = "4")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for summarization helpfulness score metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SummarizationHelpfulnessSpec {
/// Optional. Whether to use instance.reference to compute summarization
/// helpfulness.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for summarization helpfulness result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationHelpfulnessResult {
/// Output only. Summarization Helpfulness score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for summarization helpfulness score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for summarization helpfulness score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for summarization verbosity metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationVerbosityInput {
/// Required. Spec for summarization verbosity score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<SummarizationVerbositySpec>,
/// Required. Summarization verbosity instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<SummarizationVerbosityInstance>,
}
/// Spec for summarization verbosity instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationVerbosityInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Text to be summarized.
#[prost(string, optional, tag = "3")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Summarization prompt for LLM.
#[prost(string, optional, tag = "4")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for summarization verbosity score metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SummarizationVerbositySpec {
/// Optional. Whether to use instance.reference to compute summarization
/// verbosity.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for summarization verbosity result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SummarizationVerbosityResult {
/// Output only. Summarization Verbosity score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for summarization verbosity score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for summarization verbosity score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for question answering quality metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringQualityInput {
/// Required. Spec for question answering quality score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<QuestionAnsweringQualitySpec>,
/// Required. Question answering quality instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<QuestionAnsweringQualityInstance>,
}
/// Spec for question answering quality instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringQualityInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Text to answer the question.
#[prost(string, optional, tag = "3")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Question Answering prompt for LLM.
#[prost(string, optional, tag = "4")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for question answering quality score metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringQualitySpec {
/// Optional. Whether to use instance.reference to compute question answering
/// quality.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for question answering quality result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringQualityResult {
/// Output only. Question Answering Quality score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for question answering quality score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for question answering quality score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for pairwise question answering quality metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseQuestionAnsweringQualityInput {
/// Required. Spec for pairwise question answering quality score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<PairwiseQuestionAnsweringQualitySpec>,
/// Required. Pairwise question answering quality instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<PairwiseQuestionAnsweringQualityInstance>,
}
/// Spec for pairwise question answering quality instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseQuestionAnsweringQualityInstance {
/// Required. Output of the candidate model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Output of the baseline model.
#[prost(string, optional, tag = "2")]
pub baseline_prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "3")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Text to answer the question.
#[prost(string, optional, tag = "4")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Question Answering prompt for LLM.
#[prost(string, optional, tag = "5")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for pairwise question answering quality score metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct PairwiseQuestionAnsweringQualitySpec {
/// Optional. Whether to use instance.reference to compute question answering
/// quality.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for pairwise question answering quality result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseQuestionAnsweringQualityResult {
/// Output only. Pairwise question answering prediction choice.
#[prost(enumeration = "PairwiseChoice", tag = "1")]
pub pairwise_choice: i32,
/// Output only. Explanation for question answering quality score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for question answering quality score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for question answering relevance metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringRelevanceInput {
/// Required. Spec for question answering relevance score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<QuestionAnsweringRelevanceSpec>,
/// Required. Question answering relevance instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<QuestionAnsweringRelevanceInstance>,
}
/// Spec for question answering relevance instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringRelevanceInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Text provided as context to answer the question.
#[prost(string, optional, tag = "3")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Required. The question asked and other instruction in the inference prompt.
#[prost(string, optional, tag = "4")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for question answering relevance metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringRelevanceSpec {
/// Optional. Whether to use instance.reference to compute question answering
/// relevance.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for question answering relevance result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringRelevanceResult {
/// Output only. Question Answering Relevance score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for question answering relevance score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for question answering relevance score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for question answering helpfulness metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringHelpfulnessInput {
/// Required. Spec for question answering helpfulness score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<QuestionAnsweringHelpfulnessSpec>,
/// Required. Question answering helpfulness instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<QuestionAnsweringHelpfulnessInstance>,
}
/// Spec for question answering helpfulness instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringHelpfulnessInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Text provided as context to answer the question.
#[prost(string, optional, tag = "3")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Required. The question asked and other instruction in the inference prompt.
#[prost(string, optional, tag = "4")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for question answering helpfulness metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringHelpfulnessSpec {
/// Optional. Whether to use instance.reference to compute question answering
/// helpfulness.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for question answering helpfulness result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringHelpfulnessResult {
/// Output only. Question Answering Helpfulness score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for question answering helpfulness score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for question answering helpfulness score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for question answering correctness metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringCorrectnessInput {
/// Required. Spec for question answering correctness score metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<QuestionAnsweringCorrectnessSpec>,
/// Required. Question answering correctness instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<QuestionAnsweringCorrectnessInstance>,
}
/// Spec for question answering correctness instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringCorrectnessInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Text provided as context to answer the question.
#[prost(string, optional, tag = "3")]
pub context: ::core::option::Option<::prost::alloc::string::String>,
/// Required. The question asked and other instruction in the inference prompt.
#[prost(string, optional, tag = "4")]
pub instruction: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for question answering correctness metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringCorrectnessSpec {
/// Optional. Whether to use instance.reference to compute question answering
/// correctness.
#[prost(bool, tag = "1")]
pub use_reference: bool,
/// Optional. Which version to use for evaluation.
#[prost(int32, tag = "2")]
pub version: i32,
}
/// Spec for question answering correctness result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuestionAnsweringCorrectnessResult {
/// Output only. Question Answering Correctness score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for question answering correctness score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
/// Output only. Confidence for question answering correctness score.
#[prost(float, optional, tag = "3")]
pub confidence: ::core::option::Option<f32>,
}
/// Input for pointwise metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PointwiseMetricInput {
/// Required. Spec for pointwise metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<PointwiseMetricSpec>,
/// Required. Pointwise metric instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<PointwiseMetricInstance>,
}
/// Pointwise metric instance. Usually one instance corresponds to one row in an
/// evaluation dataset.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PointwiseMetricInstance {
/// Instance for pointwise metric.
#[prost(oneof = "pointwise_metric_instance::Instance", tags = "1")]
pub instance: ::core::option::Option<pointwise_metric_instance::Instance>,
}
/// Nested message and enum types in `PointwiseMetricInstance`.
pub mod pointwise_metric_instance {
/// Instance for pointwise metric.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Instance {
/// Instance specified as a json string. String key-value pairs are expected
/// in the json_instance to render
/// PointwiseMetricSpec.instance_prompt_template.
#[prost(string, tag = "1")]
JsonInstance(::prost::alloc::string::String),
}
}
/// Spec for pointwise metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PointwiseMetricSpec {
/// Required. Metric prompt template for pointwise metric.
#[prost(string, optional, tag = "1")]
pub metric_prompt_template: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for pointwise metric result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PointwiseMetricResult {
/// Output only. Pointwise metric score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
/// Output only. Explanation for pointwise metric score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
}
/// Input for pairwise metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseMetricInput {
/// Required. Spec for pairwise metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<PairwiseMetricSpec>,
/// Required. Pairwise metric instance.
#[prost(message, optional, tag = "2")]
pub instance: ::core::option::Option<PairwiseMetricInstance>,
}
/// Pairwise metric instance. Usually one instance corresponds to one row in an
/// evaluation dataset.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseMetricInstance {
/// Instance for pairwise metric.
#[prost(oneof = "pairwise_metric_instance::Instance", tags = "1")]
pub instance: ::core::option::Option<pairwise_metric_instance::Instance>,
}
/// Nested message and enum types in `PairwiseMetricInstance`.
pub mod pairwise_metric_instance {
/// Instance for pairwise metric.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Instance {
/// Instance specified as a json string. String key-value pairs are expected
/// in the json_instance to render
/// PairwiseMetricSpec.instance_prompt_template.
#[prost(string, tag = "1")]
JsonInstance(::prost::alloc::string::String),
}
}
/// Spec for pairwise metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseMetricSpec {
/// Required. Metric prompt template for pairwise metric.
#[prost(string, optional, tag = "1")]
pub metric_prompt_template: ::core::option::Option<::prost::alloc::string::String>,
}
/// Spec for pairwise metric result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PairwiseMetricResult {
/// Output only. Pairwise metric choice.
#[prost(enumeration = "PairwiseChoice", tag = "1")]
pub pairwise_choice: i32,
/// Output only. Explanation for pairwise metric score.
#[prost(string, tag = "2")]
pub explanation: ::prost::alloc::string::String,
}
/// Input for tool call valid metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolCallValidInput {
/// Required. Spec for tool call valid metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<ToolCallValidSpec>,
/// Required. Repeated tool call valid instances.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<ToolCallValidInstance>,
}
/// Spec for tool call valid metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ToolCallValidSpec {}
/// Spec for tool call valid instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolCallValidInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
}
/// Results for tool call valid metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolCallValidResults {
/// Output only. Tool call valid metric values.
#[prost(message, repeated, tag = "1")]
pub tool_call_valid_metric_values: ::prost::alloc::vec::Vec<
ToolCallValidMetricValue,
>,
}
/// Tool call valid metric value for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ToolCallValidMetricValue {
/// Output only. Tool call valid score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
}
/// Input for tool name match metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolNameMatchInput {
/// Required. Spec for tool name match metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<ToolNameMatchSpec>,
/// Required. Repeated tool name match instances.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<ToolNameMatchInstance>,
}
/// Spec for tool name match metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ToolNameMatchSpec {}
/// Spec for tool name match instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolNameMatchInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
}
/// Results for tool name match metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolNameMatchResults {
/// Output only. Tool name match metric values.
#[prost(message, repeated, tag = "1")]
pub tool_name_match_metric_values: ::prost::alloc::vec::Vec<
ToolNameMatchMetricValue,
>,
}
/// Tool name match metric value for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ToolNameMatchMetricValue {
/// Output only. Tool name match score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
}
/// Input for tool parameter key match metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolParameterKeyMatchInput {
/// Required. Spec for tool parameter key match metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<ToolParameterKeyMatchSpec>,
/// Required. Repeated tool parameter key match instances.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<ToolParameterKeyMatchInstance>,
}
/// Spec for tool parameter key match metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ToolParameterKeyMatchSpec {}
/// Spec for tool parameter key match instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolParameterKeyMatchInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
}
/// Results for tool parameter key match metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolParameterKeyMatchResults {
/// Output only. Tool parameter key match metric values.
#[prost(message, repeated, tag = "1")]
pub tool_parameter_key_match_metric_values: ::prost::alloc::vec::Vec<
ToolParameterKeyMatchMetricValue,
>,
}
/// Tool parameter key match metric value for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ToolParameterKeyMatchMetricValue {
/// Output only. Tool parameter key match score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
}
/// Input for tool parameter key value match metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolParameterKvMatchInput {
/// Required. Spec for tool parameter key value match metric.
#[prost(message, optional, tag = "1")]
pub metric_spec: ::core::option::Option<ToolParameterKvMatchSpec>,
/// Required. Repeated tool parameter key value match instances.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<ToolParameterKvMatchInstance>,
}
/// Spec for tool parameter key value match metric.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ToolParameterKvMatchSpec {
/// Optional. Whether to use STRCIT string match on parameter values.
#[prost(bool, tag = "1")]
pub use_strict_string_match: bool,
}
/// Spec for tool parameter key value match instance.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolParameterKvMatchInstance {
/// Required. Output of the evaluated model.
#[prost(string, optional, tag = "1")]
pub prediction: ::core::option::Option<::prost::alloc::string::String>,
/// Required. Ground truth used to compare against the prediction.
#[prost(string, optional, tag = "2")]
pub reference: ::core::option::Option<::prost::alloc::string::String>,
}
/// Results for tool parameter key value match metric.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ToolParameterKvMatchResults {
/// Output only. Tool parameter key value match metric values.
#[prost(message, repeated, tag = "1")]
pub tool_parameter_kv_match_metric_values: ::prost::alloc::vec::Vec<
ToolParameterKvMatchMetricValue,
>,
}
/// Tool parameter key value match metric value for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ToolParameterKvMatchMetricValue {
/// Output only. Tool parameter key value match score.
#[prost(float, optional, tag = "1")]
pub score: ::core::option::Option<f32>,
}
/// Pairwise prediction autorater preference.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PairwiseChoice {
/// Unspecified prediction choice.
Unspecified = 0,
/// Baseline prediction wins
Baseline = 1,
/// Candidate prediction wins
Candidate = 2,
/// Winner cannot be determined
Tie = 3,
}
impl PairwiseChoice {
/// 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 {
PairwiseChoice::Unspecified => "PAIRWISE_CHOICE_UNSPECIFIED",
PairwiseChoice::Baseline => "BASELINE",
PairwiseChoice::Candidate => "CANDIDATE",
PairwiseChoice::Tie => "TIE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PAIRWISE_CHOICE_UNSPECIFIED" => Some(Self::Unspecified),
"BASELINE" => Some(Self::Baseline),
"CANDIDATE" => Some(Self::Candidate),
"TIE" => Some(Self::Tie),
_ => None,
}
}
}
/// Generated client implementations.
pub mod evaluation_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Vertex AI Online Evaluation Service.
#[derive(Debug, Clone)]
pub struct EvaluationServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> EvaluationServiceClient<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,
) -> EvaluationServiceClient<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,
{
EvaluationServiceClient::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
}
/// Evaluates instances based on a given metric.
pub async fn evaluate_instances(
&mut self,
request: impl tonic::IntoRequest<super::EvaluateInstancesRequest>,
) -> std::result::Result<
tonic::Response<super::EvaluateInstancesResponse>,
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.aiplatform.v1.EvaluationService/EvaluateInstances",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EvaluationService",
"EvaluateInstances",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for
/// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateEndpointRequest {
/// Required. The resource name of the Location to create the Endpoint in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Endpoint to create.
#[prost(message, optional, tag = "2")]
pub endpoint: ::core::option::Option<Endpoint>,
/// Immutable. The ID to use for endpoint, which will become the final
/// component of the endpoint resource name.
/// If not provided, Vertex AI will generate a value for this ID.
///
/// If the first character is a letter, this value may be up to 63 characters,
/// and valid characters are `\[a-z0-9-\]`. The last character must be a letter
/// or number.
///
/// If the first character is a number, this value may be up to 9 characters,
/// and valid characters are `\[0-9\]` with no leading zeros.
///
/// When using HTTP/JSON, this field is populated
/// based on a query string argument, such as `?endpoint_id=12345`. This is the
/// fallback for fields that are not included in either the URI or the body.
#[prost(string, tag = "4")]
pub endpoint_id: ::prost::alloc::string::String,
}
/// Runtime operation information for
/// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateEndpointOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [EndpointService.GetEndpoint][google.cloud.aiplatform.v1.EndpointService.GetEndpoint]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetEndpointRequest {
/// Required. The name of the Endpoint resource.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEndpointsRequest {
/// Required. The resource name of the Location from which to list the
/// Endpoints. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. An expression for filtering the results of the request. For field
/// names both snake_case and camelCase are supported.
///
/// * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint
/// ID, i.e. the last segment of the Endpoint's
/// [resource name][google.cloud.aiplatform.v1.Endpoint.name].
/// * `display_name` supports `=` and `!=`.
/// * `labels` supports general map functions that is:
/// * `labels.key=value` - key:value equality
/// * `labels.key:*` or `labels:key` - key existence
/// * A key including a space must be quoted. `labels."a key"`.
/// * `base_model_name` only supports `=`.
///
/// Some examples:
///
/// * `endpoint=1`
/// * `displayName="myDisplayName"`
/// * `labels.myKey="myValue"`
/// * `baseModelName="text-bison"`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. The standard list page token.
/// Typically obtained via
/// [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token]
/// of the previous
/// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Optional. Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
/// Supported fields:
///
/// * `display_name`
/// * `create_time`
/// * `update_time`
///
/// Example: `display_name, create_time desc`.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListEndpointsResponse {
/// List of Endpoints in the requested page.
#[prost(message, repeated, tag = "1")]
pub endpoints: ::prost::alloc::vec::Vec<Endpoint>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListEndpointsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateEndpointRequest {
/// Required. The Endpoint which replaces the resource on the server.
#[prost(message, optional, tag = "1")]
pub endpoint: ::core::option::Option<Endpoint>,
/// Required. The update mask applies to the resource. See
/// [google.protobuf.FieldMask][google.protobuf.FieldMask].
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteEndpointRequest {
/// Required. The name of the Endpoint resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployModelRequest {
/// Required. The name of the Endpoint resource into which to deploy a Model.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Required. The DeployedModel to be created within the Endpoint. Note that
/// [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split]
/// must be updated for the DeployedModel to start receiving traffic, either as
/// part of this call, or via
/// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
#[prost(message, optional, tag = "2")]
pub deployed_model: ::core::option::Option<DeployedModel>,
/// A map from a DeployedModel's ID to the percentage of this Endpoint's
/// traffic that should be forwarded to that DeployedModel.
///
/// If this field is non-empty, then the Endpoint's
/// [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
/// overwritten with it. To refer to the ID of the just being deployed Model, a
/// "0" should be used, and the actual ID of the new DeployedModel will be
/// filled in its place by this method. The traffic percentage values must add
/// up to 100.
///
/// If this field is empty, then the Endpoint's
/// [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not
/// updated.
#[prost(btree_map = "string, int32", tag = "3")]
pub traffic_split: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
i32,
>,
}
/// Response message for
/// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployModelResponse {
/// The DeployedModel that had been deployed in the Endpoint.
#[prost(message, optional, tag = "1")]
pub deployed_model: ::core::option::Option<DeployedModel>,
}
/// Runtime operation information for
/// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployModelOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UndeployModelRequest {
/// Required. The name of the Endpoint resource from which to undeploy a Model.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Required. The ID of the DeployedModel to be undeployed from the Endpoint.
#[prost(string, tag = "2")]
pub deployed_model_id: ::prost::alloc::string::String,
/// If this field is provided, then the Endpoint's
/// [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
/// overwritten with it. If last DeployedModel is being undeployed from the
/// Endpoint, the \[Endpoint.traffic_split\] will always end up empty when this
/// call returns. A DeployedModel will be successfully undeployed only if it
/// doesn't have any traffic assigned to it when this method executes, or if
/// this field unassigns any traffic to it.
#[prost(btree_map = "string, int32", tag = "3")]
pub traffic_split: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
i32,
>,
}
/// Response message for
/// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UndeployModelResponse {}
/// Runtime operation information for
/// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UndeployModelOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [EndpointService.MutateDeployedModel][google.cloud.aiplatform.v1.EndpointService.MutateDeployedModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateDeployedModelRequest {
/// Required. The name of the Endpoint resource into which to mutate a
/// DeployedModel. Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Required. The DeployedModel to be mutated within the Endpoint. Only the
/// following fields can be mutated:
///
/// * `min_replica_count` in either
/// [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or
/// [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
/// * `max_replica_count` in either
/// [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or
/// [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
/// * [autoscaling_metric_specs][google.cloud.aiplatform.v1.DedicatedResources.autoscaling_metric_specs]
/// * `disable_container_logging` (v1 only)
/// * `enable_container_logging` (v1beta1 only)
#[prost(message, optional, tag = "2")]
pub deployed_model: ::core::option::Option<DeployedModel>,
/// Required. The update mask applies to the resource. See
/// [google.protobuf.FieldMask][google.protobuf.FieldMask].
#[prost(message, optional, tag = "4")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [EndpointService.MutateDeployedModel][google.cloud.aiplatform.v1.EndpointService.MutateDeployedModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateDeployedModelResponse {
/// The DeployedModel that's being mutated.
#[prost(message, optional, tag = "1")]
pub deployed_model: ::core::option::Option<DeployedModel>,
}
/// Runtime operation information for
/// [EndpointService.MutateDeployedModel][google.cloud.aiplatform.v1.EndpointService.MutateDeployedModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateDeployedModelOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Generated client implementations.
pub mod endpoint_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for managing Vertex AI's Endpoints.
#[derive(Debug, Clone)]
pub struct EndpointServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> EndpointServiceClient<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,
) -> EndpointServiceClient<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,
{
EndpointServiceClient::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 an Endpoint.
pub async fn create_endpoint(
&mut self,
request: impl tonic::IntoRequest<super::CreateEndpointRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.EndpointService/CreateEndpoint",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EndpointService",
"CreateEndpoint",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets an Endpoint.
pub async fn get_endpoint(
&mut self,
request: impl tonic::IntoRequest<super::GetEndpointRequest>,
) -> std::result::Result<tonic::Response<super::Endpoint>, 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.aiplatform.v1.EndpointService/GetEndpoint",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EndpointService",
"GetEndpoint",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Endpoints in a Location.
pub async fn list_endpoints(
&mut self,
request: impl tonic::IntoRequest<super::ListEndpointsRequest>,
) -> std::result::Result<
tonic::Response<super::ListEndpointsResponse>,
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.aiplatform.v1.EndpointService/ListEndpoints",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EndpointService",
"ListEndpoints",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an Endpoint.
pub async fn update_endpoint(
&mut self,
request: impl tonic::IntoRequest<super::UpdateEndpointRequest>,
) -> std::result::Result<tonic::Response<super::Endpoint>, 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.aiplatform.v1.EndpointService/UpdateEndpoint",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EndpointService",
"UpdateEndpoint",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an Endpoint.
pub async fn delete_endpoint(
&mut self,
request: impl tonic::IntoRequest<super::DeleteEndpointRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.EndpointService/DeleteEndpoint",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EndpointService",
"DeleteEndpoint",
),
);
self.inner.unary(req, path, codec).await
}
/// Deploys a Model into this Endpoint, creating a DeployedModel within it.
pub async fn deploy_model(
&mut self,
request: impl tonic::IntoRequest<super::DeployModelRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.EndpointService/DeployModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EndpointService",
"DeployModel",
),
);
self.inner.unary(req, path, codec).await
}
/// Undeploys a Model from an Endpoint, removing a DeployedModel from it, and
/// freeing all resources it's using.
pub async fn undeploy_model(
&mut self,
request: impl tonic::IntoRequest<super::UndeployModelRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.EndpointService/UndeployModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EndpointService",
"UndeployModel",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an existing deployed model. Updatable fields include
/// `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`,
/// `disable_container_logging` (v1 only), and `enable_container_logging`
/// (v1beta1 only).
pub async fn mutate_deployed_model(
&mut self,
request: impl tonic::IntoRequest<super::MutateDeployedModelRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.EndpointService/MutateDeployedModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.EndpointService",
"MutateDeployedModel",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// A Model Garden Publisher Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PublisherModel {
/// Output only. The resource name of the PublisherModel.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Immutable. The version ID of the PublisherModel.
/// A new version is committed when a new model version is uploaded under an
/// existing model id. It is an auto-incrementing decimal number in string
/// representation.
#[prost(string, tag = "2")]
pub version_id: ::prost::alloc::string::String,
/// Required. Indicates the open source category of the publisher model.
#[prost(enumeration = "publisher_model::OpenSourceCategory", tag = "7")]
pub open_source_category: i32,
/// Optional. Supported call-to-action options.
#[prost(message, optional, tag = "19")]
pub supported_actions: ::core::option::Option<publisher_model::CallToAction>,
/// Optional. Additional information about the model's Frameworks.
#[prost(string, repeated, tag = "23")]
pub frameworks: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. Indicates the launch stage of the model.
#[prost(enumeration = "publisher_model::LaunchStage", tag = "29")]
pub launch_stage: i32,
/// Optional. Indicates the state of the model version.
#[prost(enumeration = "publisher_model::VersionState", tag = "37")]
pub version_state: i32,
/// Optional. Output only. Immutable. Used to indicate this model has a
/// publisher model and provide the template of the publisher model resource
/// name.
#[prost(string, tag = "30")]
pub publisher_model_template: ::prost::alloc::string::String,
/// Optional. The schemata that describes formats of the PublisherModel's
/// predictions and explanations as given and returned via
/// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
#[prost(message, optional, tag = "31")]
pub predict_schemata: ::core::option::Option<PredictSchemata>,
}
/// Nested message and enum types in `PublisherModel`.
pub mod publisher_model {
/// Reference to a resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResourceReference {
#[prost(oneof = "resource_reference::Reference", tags = "1, 2, 3, 4")]
pub reference: ::core::option::Option<resource_reference::Reference>,
}
/// Nested message and enum types in `ResourceReference`.
pub mod resource_reference {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Reference {
/// The URI of the resource.
#[prost(string, tag = "1")]
Uri(::prost::alloc::string::String),
/// The resource name of the Google Cloud resource.
#[prost(string, tag = "2")]
ResourceName(::prost::alloc::string::String),
/// Use case (CUJ) of the resource.
#[prost(string, tag = "3")]
UseCase(::prost::alloc::string::String),
/// Description of the resource.
#[prost(string, tag = "4")]
Description(::prost::alloc::string::String),
}
}
/// A named piece of documentation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Documentation {
/// Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
/// NODE.JS, etc..
#[prost(string, tag = "1")]
pub title: ::prost::alloc::string::String,
/// Required. Content of this piece of document (in Markdown format).
#[prost(string, tag = "2")]
pub content: ::prost::alloc::string::String,
}
/// Actions could take on this Publisher Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CallToAction {
/// Optional. To view Rest API docs.
#[prost(message, optional, tag = "1")]
pub view_rest_api: ::core::option::Option<call_to_action::ViewRestApi>,
/// Optional. Open notebook of the PublisherModel.
#[prost(message, optional, tag = "2")]
pub open_notebook: ::core::option::Option<
call_to_action::RegionalResourceReferences,
>,
/// Optional. Open notebooks of the PublisherModel.
#[prost(message, optional, tag = "12")]
pub open_notebooks: ::core::option::Option<call_to_action::OpenNotebooks>,
/// Optional. Create application using the PublisherModel.
#[prost(message, optional, tag = "3")]
pub create_application: ::core::option::Option<
call_to_action::RegionalResourceReferences,
>,
/// Optional. Open fine-tuning pipeline of the PublisherModel.
#[prost(message, optional, tag = "4")]
pub open_fine_tuning_pipeline: ::core::option::Option<
call_to_action::RegionalResourceReferences,
>,
/// Optional. Open fine-tuning pipelines of the PublisherModel.
#[prost(message, optional, tag = "13")]
pub open_fine_tuning_pipelines: ::core::option::Option<
call_to_action::OpenFineTuningPipelines,
>,
/// Optional. Open prompt-tuning pipeline of the PublisherModel.
#[prost(message, optional, tag = "5")]
pub open_prompt_tuning_pipeline: ::core::option::Option<
call_to_action::RegionalResourceReferences,
>,
/// Optional. Open Genie / Playground.
#[prost(message, optional, tag = "6")]
pub open_genie: ::core::option::Option<
call_to_action::RegionalResourceReferences,
>,
/// Optional. Deploy the PublisherModel to Vertex Endpoint.
#[prost(message, optional, tag = "7")]
pub deploy: ::core::option::Option<call_to_action::Deploy>,
/// Optional. Deploy PublisherModel to Google Kubernetes Engine.
#[prost(message, optional, tag = "14")]
pub deploy_gke: ::core::option::Option<call_to_action::DeployGke>,
/// Optional. Open in Generation AI Studio.
#[prost(message, optional, tag = "8")]
pub open_generation_ai_studio: ::core::option::Option<
call_to_action::RegionalResourceReferences,
>,
/// Optional. Request for access.
#[prost(message, optional, tag = "9")]
pub request_access: ::core::option::Option<
call_to_action::RegionalResourceReferences,
>,
/// Optional. Open evaluation pipeline of the PublisherModel.
#[prost(message, optional, tag = "11")]
pub open_evaluation_pipeline: ::core::option::Option<
call_to_action::RegionalResourceReferences,
>,
}
/// Nested message and enum types in `CallToAction`.
pub mod call_to_action {
/// The regional resource name or the URI. Key is region, e.g.,
/// us-central1, europe-west2, global, etc..
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegionalResourceReferences {
/// Required.
#[prost(btree_map = "string, message", tag = "1")]
pub references: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
super::ResourceReference,
>,
/// Required.
#[prost(string, tag = "2")]
pub title: ::prost::alloc::string::String,
/// Optional. Title of the resource.
#[prost(string, optional, tag = "3")]
pub resource_title: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Use case (CUJ) of the resource.
#[prost(string, optional, tag = "4")]
pub resource_use_case: ::core::option::Option<
::prost::alloc::string::String,
>,
/// Optional. Description of the resource.
#[prost(string, optional, tag = "5")]
pub resource_description: ::core::option::Option<
::prost::alloc::string::String,
>,
}
/// Rest API docs.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ViewRestApi {
/// Required.
#[prost(message, repeated, tag = "1")]
pub documentations: ::prost::alloc::vec::Vec<super::Documentation>,
/// Required. The title of the view rest API.
#[prost(string, tag = "2")]
pub title: ::prost::alloc::string::String,
}
/// Open notebooks.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpenNotebooks {
/// Required. Regional resource references to notebooks.
#[prost(message, repeated, tag = "1")]
pub notebooks: ::prost::alloc::vec::Vec<RegionalResourceReferences>,
}
/// Open fine tuning pipelines.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpenFineTuningPipelines {
/// Required. Regional resource references to fine tuning pipelines.
#[prost(message, repeated, tag = "1")]
pub fine_tuning_pipelines: ::prost::alloc::vec::Vec<
RegionalResourceReferences,
>,
}
/// Model metadata that is needed for UploadModel or
/// DeployModel/CreateEndpoint requests.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Deploy {
/// Optional. Default model display name.
#[prost(string, tag = "1")]
pub model_display_name: ::prost::alloc::string::String,
/// Optional. Large model reference. When this is set, model_artifact_spec
/// is not needed.
#[prost(message, optional, tag = "2")]
pub large_model_reference: ::core::option::Option<
super::super::LargeModelReference,
>,
/// Optional. The specification of the container that is to be used when
/// deploying this Model in Vertex AI. Not present for Large Models.
#[prost(message, optional, tag = "3")]
pub container_spec: ::core::option::Option<super::super::ModelContainerSpec>,
/// Optional. The path to the directory containing the Model artifact and
/// any of its supporting files.
#[prost(string, tag = "4")]
pub artifact_uri: ::prost::alloc::string::String,
/// Optional. The name of the deploy task (e.g., "text to image
/// generation").
#[prost(string, optional, tag = "10")]
pub deploy_task_name: ::core::option::Option<::prost::alloc::string::String>,
/// Optional. Metadata information about this deployment config.
#[prost(message, optional, tag = "11")]
pub deploy_metadata: ::core::option::Option<deploy::DeployMetadata>,
/// Required. The title of the regional resource reference.
#[prost(string, tag = "8")]
pub title: ::prost::alloc::string::String,
/// Optional. The signed URI for ephemeral Cloud Storage access to model
/// artifact.
#[prost(string, tag = "9")]
pub public_artifact_uri: ::prost::alloc::string::String,
/// The prediction (for example, the machine) resources that the
/// DeployedModel uses.
#[prost(oneof = "deploy::PredictionResources", tags = "5, 6, 7")]
pub prediction_resources: ::core::option::Option<
deploy::PredictionResources,
>,
}
/// Nested message and enum types in `Deploy`.
pub mod deploy {
/// Metadata information about the deployment for managing deployment
/// config.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployMetadata {
/// Optional. Labels for the deployment. For managing deployment config
/// like verifying, source of deployment config, etc.
#[prost(btree_map = "string, string", tag = "1")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. Sample request for deployed endpoint.
#[prost(string, tag = "2")]
pub sample_request: ::prost::alloc::string::String,
}
/// The prediction (for example, the machine) resources that the
/// DeployedModel uses.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum PredictionResources {
/// A description of resources that are dedicated to the DeployedModel,
/// and that need a higher degree of manual configuration.
#[prost(message, tag = "5")]
DedicatedResources(super::super::super::DedicatedResources),
/// A description of resources that to large degree are decided by Vertex
/// AI, and require only a modest additional configuration.
#[prost(message, tag = "6")]
AutomaticResources(super::super::super::AutomaticResources),
/// The resource name of the shared DeploymentResourcePool to deploy on.
/// Format:
/// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
#[prost(string, tag = "7")]
SharedResources(::prost::alloc::string::String),
}
}
/// Configurations for PublisherModel GKE deployment
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployGke {
/// Optional. GKE deployment configuration in yaml format.
#[prost(string, repeated, tag = "1")]
pub gke_yaml_configs: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
}
/// An enum representing the open source category of a PublisherModel.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum OpenSourceCategory {
/// The open source category is unspecified, which should not be used.
Unspecified = 0,
/// Used to indicate the PublisherModel is not open sourced.
Proprietary = 1,
/// Used to indicate the PublisherModel is a Google-owned open source model
/// w/ Google checkpoint.
GoogleOwnedOssWithGoogleCheckpoint = 2,
/// Used to indicate the PublisherModel is a 3p-owned open source model w/
/// Google checkpoint.
ThirdPartyOwnedOssWithGoogleCheckpoint = 3,
/// Used to indicate the PublisherModel is a Google-owned pure open source
/// model.
GoogleOwnedOss = 4,
/// Used to indicate the PublisherModel is a 3p-owned pure open source model.
ThirdPartyOwnedOss = 5,
}
impl OpenSourceCategory {
/// 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 {
OpenSourceCategory::Unspecified => "OPEN_SOURCE_CATEGORY_UNSPECIFIED",
OpenSourceCategory::Proprietary => "PROPRIETARY",
OpenSourceCategory::GoogleOwnedOssWithGoogleCheckpoint => {
"GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT"
}
OpenSourceCategory::ThirdPartyOwnedOssWithGoogleCheckpoint => {
"THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT"
}
OpenSourceCategory::GoogleOwnedOss => "GOOGLE_OWNED_OSS",
OpenSourceCategory::ThirdPartyOwnedOss => "THIRD_PARTY_OWNED_OSS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPEN_SOURCE_CATEGORY_UNSPECIFIED" => Some(Self::Unspecified),
"PROPRIETARY" => Some(Self::Proprietary),
"GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT" => {
Some(Self::GoogleOwnedOssWithGoogleCheckpoint)
}
"THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT" => {
Some(Self::ThirdPartyOwnedOssWithGoogleCheckpoint)
}
"GOOGLE_OWNED_OSS" => Some(Self::GoogleOwnedOss),
"THIRD_PARTY_OWNED_OSS" => Some(Self::ThirdPartyOwnedOss),
_ => None,
}
}
}
/// An enum representing the launch stage of a PublisherModel.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum LaunchStage {
/// The model launch stage is unspecified.
Unspecified = 0,
/// Used to indicate the PublisherModel is at Experimental launch stage,
/// available to a small set of customers.
Experimental = 1,
/// Used to indicate the PublisherModel is at Private Preview launch stage,
/// only available to a small set of customers, although a larger set of
/// customers than an Experimental launch. Previews are the first launch
/// stage used to get feedback from customers.
PrivatePreview = 2,
/// Used to indicate the PublisherModel is at Public Preview launch stage,
/// available to all customers, although not supported for production
/// workloads.
PublicPreview = 3,
/// Used to indicate the PublisherModel is at GA launch stage, available to
/// all customers and ready for production workload.
Ga = 4,
}
impl LaunchStage {
/// 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 {
LaunchStage::Unspecified => "LAUNCH_STAGE_UNSPECIFIED",
LaunchStage::Experimental => "EXPERIMENTAL",
LaunchStage::PrivatePreview => "PRIVATE_PREVIEW",
LaunchStage::PublicPreview => "PUBLIC_PREVIEW",
LaunchStage::Ga => "GA",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"LAUNCH_STAGE_UNSPECIFIED" => Some(Self::Unspecified),
"EXPERIMENTAL" => Some(Self::Experimental),
"PRIVATE_PREVIEW" => Some(Self::PrivatePreview),
"PUBLIC_PREVIEW" => Some(Self::PublicPreview),
"GA" => Some(Self::Ga),
_ => None,
}
}
}
/// An enum representing the state of the PublicModelVersion.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum VersionState {
/// The version state is unspecified.
Unspecified = 0,
/// Used to indicate the version is stable.
Stable = 1,
/// Used to indicate the version is unstable.
Unstable = 2,
}
impl VersionState {
/// 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 {
VersionState::Unspecified => "VERSION_STATE_UNSPECIFIED",
VersionState::Stable => "VERSION_STATE_STABLE",
VersionState::Unstable => "VERSION_STATE_UNSTABLE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"VERSION_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"VERSION_STATE_STABLE" => Some(Self::Stable),
"VERSION_STATE_UNSTABLE" => Some(Self::Unstable),
_ => None,
}
}
}
}
/// Request message for
/// [ModelGardenService.GetPublisherModel][google.cloud.aiplatform.v1.ModelGardenService.GetPublisherModel]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPublisherModelRequest {
/// Required. The name of the PublisherModel resource.
/// Format:
/// `publishers/{publisher}/models/{publisher_model}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The IETF BCP-47 language code representing the language in which
/// the publisher model's text information should be written in.
#[prost(string, tag = "2")]
pub language_code: ::prost::alloc::string::String,
/// Optional. PublisherModel view specifying which fields to read.
#[prost(enumeration = "PublisherModelView", tag = "3")]
pub view: i32,
/// Optional. Boolean indicates whether the requested model is a Hugging Face
/// model.
#[prost(bool, tag = "5")]
pub is_hugging_face_model: bool,
/// Optional. Token used to access Hugging Face gated models.
#[prost(string, tag = "6")]
pub hugging_face_token: ::prost::alloc::string::String,
}
/// View enumeration of PublisherModel.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PublisherModelView {
/// The default / unset value. The API will default to the BASIC view.
Unspecified = 0,
/// Include basic metadata about the publisher model, but not the full
/// contents.
Basic = 1,
/// Include everything.
Full = 2,
/// Include: VersionId, ModelVersionExternalName, and SupportedActions.
PublisherModelVersionViewBasic = 3,
}
impl PublisherModelView {
/// 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 {
PublisherModelView::Unspecified => "PUBLISHER_MODEL_VIEW_UNSPECIFIED",
PublisherModelView::Basic => "PUBLISHER_MODEL_VIEW_BASIC",
PublisherModelView::Full => "PUBLISHER_MODEL_VIEW_FULL",
PublisherModelView::PublisherModelVersionViewBasic => {
"PUBLISHER_MODEL_VERSION_VIEW_BASIC"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PUBLISHER_MODEL_VIEW_UNSPECIFIED" => Some(Self::Unspecified),
"PUBLISHER_MODEL_VIEW_BASIC" => Some(Self::Basic),
"PUBLISHER_MODEL_VIEW_FULL" => Some(Self::Full),
"PUBLISHER_MODEL_VERSION_VIEW_BASIC" => {
Some(Self::PublisherModelVersionViewBasic)
}
_ => None,
}
}
}
/// Generated client implementations.
pub mod model_garden_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The interface of Model Garden Service.
#[derive(Debug, Clone)]
pub struct ModelGardenServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> ModelGardenServiceClient<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,
) -> ModelGardenServiceClient<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,
{
ModelGardenServiceClient::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
}
/// Gets a Model Garden publisher model.
pub async fn get_publisher_model(
&mut self,
request: impl tonic::IntoRequest<super::GetPublisherModelRequest>,
) -> std::result::Result<tonic::Response<super::PublisherModel>, 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.aiplatform.v1.ModelGardenService/GetPublisherModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelGardenService",
"GetPublisherModel",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Success and error statistics of processing multiple entities
/// (for example, DataItems or structured data rows) in batch.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CompletionStats {
/// Output only. The number of entities that had been processed successfully.
#[prost(int64, tag = "1")]
pub successful_count: i64,
/// Output only. The number of entities for which any error was encountered.
#[prost(int64, tag = "2")]
pub failed_count: i64,
/// Output only. In cases when enough errors are encountered a job, pipeline,
/// or operation may be failed as a whole. Below is the number of entities for
/// which the processing had not been finished (either in successful or failed
/// state). Set to -1 if the number is unknown (for example, the operation
/// failed before the total entity number could be collected).
#[prost(int64, tag = "3")]
pub incomplete_count: i64,
/// Output only. The number of the successful forecast points that are
/// generated by the forecasting model. This is ONLY used by the forecasting
/// batch prediction.
#[prost(int64, tag = "5")]
pub successful_forecast_point_count: i64,
}
/// Manual batch tuning parameters.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ManualBatchTuningParameters {
/// Immutable. The number of the records (e.g. instances) of the operation
/// given in each batch to a machine replica. Machine type, and size of a
/// single record should be considered when setting this parameter, higher
/// value speeds up the batch operation's execution, but too high value will
/// result in a whole batch not fitting in a machine's memory, and the whole
/// operation will fail.
/// The default value is 64.
#[prost(int32, tag = "1")]
pub batch_size: i32,
}
/// Contains model information necessary to perform batch prediction without
/// requiring a full model import.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UnmanagedContainerModel {
/// The path to the directory containing the Model artifact and any of its
/// supporting files.
#[prost(string, tag = "1")]
pub artifact_uri: ::prost::alloc::string::String,
/// Contains the schemata used in Model's predictions and explanations
#[prost(message, optional, tag = "2")]
pub predict_schemata: ::core::option::Option<PredictSchemata>,
/// Input only. The specification of the container that is to be used when
/// deploying this Model.
#[prost(message, optional, tag = "3")]
pub container_spec: ::core::option::Option<ModelContainerSpec>,
}
/// A job that uses a
/// [Model][google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce
/// predictions on multiple [input
/// instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If
/// predictions for significant portion of the instances fail, the job may finish
/// without attempting predictions for all remaining instances.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchPredictionJob {
/// Output only. Resource name of the BatchPredictionJob.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user-defined name of this BatchPredictionJob.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The name of the Model resource that produces the predictions via this job,
/// must share the same ancestor Location.
/// Starting this job has no impact on any existing deployments of the Model
/// and their resources.
/// Exactly one of model and unmanaged_container_model must be set.
///
/// The model resource name may contain version id or version alias to specify
/// the version.
/// Example: `projects/{project}/locations/{location}/models/{model}@2`
/// or
/// `projects/{project}/locations/{location}/models/{model}@golden`
/// if no version is specified, the default version will be deployed.
///
/// The model resource could also be a publisher model.
/// Example: `publishers/{publisher}/models/{model}`
/// or
/// `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
#[prost(string, tag = "3")]
pub model: ::prost::alloc::string::String,
/// Output only. The version ID of the Model that produces the predictions via
/// this job.
#[prost(string, tag = "30")]
pub model_version_id: ::prost::alloc::string::String,
/// Contains model information necessary to perform batch prediction without
/// requiring uploading to model registry.
/// Exactly one of model and unmanaged_container_model must be set.
#[prost(message, optional, tag = "28")]
pub unmanaged_container_model: ::core::option::Option<UnmanagedContainerModel>,
/// Required. Input configuration of the instances on which predictions are
/// performed. The schema of any single instance may be specified via the
/// [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
#[prost(message, optional, tag = "4")]
pub input_config: ::core::option::Option<batch_prediction_job::InputConfig>,
/// Configuration for how to convert batch prediction input instances to the
/// prediction instances that are sent to the Model.
#[prost(message, optional, tag = "27")]
pub instance_config: ::core::option::Option<batch_prediction_job::InstanceConfig>,
/// The parameters that govern the predictions. The schema of the parameters
/// may be specified via the
/// [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
#[prost(message, optional, tag = "5")]
pub model_parameters: ::core::option::Option<::prost_types::Value>,
/// Required. The Configuration specifying where output predictions should
/// be written.
/// The schema of any single prediction may be specified as a concatenation
/// of [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
/// and
/// [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
#[prost(message, optional, tag = "6")]
pub output_config: ::core::option::Option<batch_prediction_job::OutputConfig>,
/// The config of resources used by the Model during the batch prediction. If
/// the Model
/// [supports][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types]
/// DEDICATED_RESOURCES this config may be provided (and the job will use these
/// resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config
/// must be provided.
#[prost(message, optional, tag = "7")]
pub dedicated_resources: ::core::option::Option<BatchDedicatedResources>,
/// The service account that the DeployedModel's container runs as. If not
/// specified, a system generated one will be used, which
/// has minimal permissions and the custom container, if used, may not have
/// enough permission to access other Google Cloud resources.
///
/// Users deploying the Model must have the `iam.serviceAccounts.actAs`
/// permission on this service account.
#[prost(string, tag = "29")]
pub service_account: ::prost::alloc::string::String,
/// Immutable. Parameters configuring the batch behavior. Currently only
/// applicable when
/// [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources]
/// are used (in other cases Vertex AI does the tuning itself).
#[prost(message, optional, tag = "8")]
pub manual_batch_tuning_parameters: ::core::option::Option<
ManualBatchTuningParameters,
>,
/// Generate explanation with the batch prediction results.
///
/// When set to `true`, the batch prediction output changes based on the
/// `predictions_format` field of the
/// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]
/// object:
///
/// * `bigquery`: output includes a column named `explanation`. The value
/// is a struct that conforms to the
/// [Explanation][google.cloud.aiplatform.v1.Explanation] object.
/// * `jsonl`: The JSON objects on each line include an additional entry
/// keyed `explanation`. The value of the entry is a JSON object that
/// conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation]
/// object.
/// * `csv`: Generating explanations for CSV format is not supported.
///
/// If this field is set to true, either the
/// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
/// or
/// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
/// must be populated.
#[prost(bool, tag = "23")]
pub generate_explanation: bool,
/// Explanation configuration for this BatchPredictionJob. Can be
/// specified only if
/// [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
/// is set to `true`.
///
/// This value overrides the value of
/// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
/// All fields of
/// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
/// are optional in the request. If a field of the
/// [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
/// object is not populated, the corresponding field of the
/// [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
/// object is inherited.
#[prost(message, optional, tag = "25")]
pub explanation_spec: ::core::option::Option<ExplanationSpec>,
/// Output only. Information further describing the output of this job.
#[prost(message, optional, tag = "9")]
pub output_info: ::core::option::Option<batch_prediction_job::OutputInfo>,
/// Output only. The detailed state of the job.
#[prost(enumeration = "JobState", tag = "10")]
pub state: i32,
/// Output only. Only populated when the job's state is JOB_STATE_FAILED or
/// JOB_STATE_CANCELLED.
#[prost(message, optional, tag = "11")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// Output only. Partial failures encountered.
/// For example, single files that can't be read.
/// This field never exceeds 20 entries.
/// Status details fields contain standard Google Cloud error details.
#[prost(message, repeated, tag = "12")]
pub partial_failures: ::prost::alloc::vec::Vec<super::super::super::rpc::Status>,
/// Output only. Information about resources that had been consumed by this
/// job. Provided in real time at best effort basis, as well as a final value
/// once the job completes.
///
/// Note: This field currently may be not populated for batch predictions that
/// use AutoML Models.
#[prost(message, optional, tag = "13")]
pub resources_consumed: ::core::option::Option<ResourcesConsumed>,
/// Output only. Statistics on completed and failed prediction instances.
#[prost(message, optional, tag = "14")]
pub completion_stats: ::core::option::Option<CompletionStats>,
/// Output only. Time when the BatchPredictionJob was created.
#[prost(message, optional, tag = "15")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the BatchPredictionJob for the first time entered
/// the `JOB_STATE_RUNNING` state.
#[prost(message, optional, tag = "16")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the BatchPredictionJob entered any of the following
/// states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
#[prost(message, optional, tag = "17")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the BatchPredictionJob was most recently updated.
#[prost(message, optional, tag = "18")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The labels with user-defined metadata to organize BatchPredictionJobs.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "19")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Customer-managed encryption key options for a BatchPredictionJob. If this
/// is set, then all resources created by the BatchPredictionJob will be
/// encrypted with the provided encryption key.
#[prost(message, optional, tag = "24")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// For custom-trained Models and AutoML Tabular Models, the container of the
/// DeployedModel instances will send `stderr` and `stdout` streams to
/// Cloud Logging by default. Please note that the logs incur cost,
/// which are subject to [Cloud Logging
/// pricing](<https://cloud.google.com/logging/pricing>).
///
/// User can disable container logging by setting this flag to true.
#[prost(bool, tag = "34")]
pub disable_container_logging: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "36")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "37")]
pub satisfies_pzi: bool,
}
/// Nested message and enum types in `BatchPredictionJob`.
pub mod batch_prediction_job {
/// Configures the input to
/// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See
/// [Model.supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats]
/// for Model's supported input formats, and how instances should be expressed
/// via any of them.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InputConfig {
/// Required. The format in which instances are given, must be one of the
/// [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
/// [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats].
#[prost(string, tag = "1")]
pub instances_format: ::prost::alloc::string::String,
/// Required. The source of the input.
#[prost(oneof = "input_config::Source", tags = "2, 3")]
pub source: ::core::option::Option<input_config::Source>,
}
/// Nested message and enum types in `InputConfig`.
pub mod input_config {
/// Required. The source of the input.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// The Cloud Storage location for the input instances.
#[prost(message, tag = "2")]
GcsSource(super::super::GcsSource),
/// The BigQuery location of the input table.
/// The schema of the table should be in the format described by the given
/// context OpenAPI Schema, if one is provided. The table may contain
/// additional columns that are not described by the schema, and they will
/// be ignored.
#[prost(message, tag = "3")]
BigquerySource(super::super::BigQuerySource),
}
}
/// Configuration defining how to transform batch prediction input instances to
/// the instances that the Model accepts.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InstanceConfig {
/// The format of the instance that the Model accepts. Vertex AI will
/// convert compatible
/// [batch prediction input instance
/// formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
/// to the specified format.
///
/// Supported values are:
///
/// * `object`: Each input is converted to JSON object format.
/// * For `bigquery`, each row is converted to an object.
/// * For `jsonl`, each line of the JSONL input must be an object.
/// * Does not apply to `csv`, `file-list`, `tf-record`, or
/// `tf-record-gzip`.
///
/// * `array`: Each input is converted to JSON array format.
/// * For `bigquery`, each row is converted to an array. The order
/// of columns is determined by the BigQuery column order, unless
/// [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
/// is populated.
/// [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
/// must be populated for specifying field orders.
/// * For `jsonl`, if each line of the JSONL input is an object,
/// [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
/// must be populated for specifying field orders.
/// * Does not apply to `csv`, `file-list`, `tf-record`, or
/// `tf-record-gzip`.
///
/// If not specified, Vertex AI converts the batch prediction input as
/// follows:
///
/// * For `bigquery` and `csv`, the behavior is the same as `array`. The
/// order of columns is the same as defined in the file or table, unless
/// [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
/// is populated.
/// * For `jsonl`, the prediction instance format is determined by
/// each line of the input.
/// * For `tf-record`/`tf-record-gzip`, each record will be converted to
/// an object in the format of `{"b64": <value>}`, where `<value>` is
/// the Base64-encoded string of the content of the record.
/// * For `file-list`, each file in the list will be converted to an
/// object in the format of `{"b64": <value>}`, where `<value>` is
/// the Base64-encoded string of the content of the file.
#[prost(string, tag = "1")]
pub instance_type: ::prost::alloc::string::String,
/// The name of the field that is considered as a key.
///
/// The values identified by the key field is not included in the transformed
/// instances that is sent to the Model. This is similar to
/// specifying this name of the field in
/// [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields].
/// In addition, the batch prediction output will not include the instances.
/// Instead the output will only include the value of the key field, in a
/// field named `key` in the output:
///
/// * For `jsonl` output format, the output will have a `key` field
/// instead of the `instance` field.
/// * For `csv`/`bigquery` output format, the output will have have a `key`
/// column instead of the instance feature columns.
///
/// The input must be JSONL with objects at each line, CSV, BigQuery
/// or TfRecord.
#[prost(string, tag = "2")]
pub key_field: ::prost::alloc::string::String,
/// Fields that will be included in the prediction instance that is
/// sent to the Model.
///
/// If
/// [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type]
/// is `array`, the order of field names in included_fields also determines
/// the order of the values in the array.
///
/// When included_fields is populated,
/// [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields]
/// must be empty.
///
/// The input must be JSONL with objects at each line, BigQuery
/// or TfRecord.
#[prost(string, repeated, tag = "3")]
pub included_fields: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Fields that will be excluded in the prediction instance that is
/// sent to the Model.
///
/// Excluded will be attached to the batch prediction output if
/// [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field]
/// is not specified.
///
/// When excluded_fields is populated,
/// [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
/// must be empty.
///
/// The input must be JSONL with objects at each line, BigQuery
/// or TfRecord.
#[prost(string, repeated, tag = "4")]
pub excluded_fields: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Configures the output of
/// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See
/// [Model.supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]
/// for supported output formats, and how predictions are expressed via any of
/// them.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OutputConfig {
/// Required. The format in which Vertex AI gives the predictions, must be
/// one of the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
/// [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
#[prost(string, tag = "1")]
pub predictions_format: ::prost::alloc::string::String,
/// Required. The destination of the output.
#[prost(oneof = "output_config::Destination", tags = "2, 3")]
pub destination: ::core::option::Option<output_config::Destination>,
}
/// Nested message and enum types in `OutputConfig`.
pub mod output_config {
/// Required. The destination of the output.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Destination {
/// The Cloud Storage location of the directory where the output is
/// to be written to. In the given directory a new directory is created.
/// Its name is `prediction-<model-display-name>-<job-create-time>`,
/// where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format.
/// Inside of it files `predictions_0001.<extension>`,
/// `predictions_0002.<extension>`, ..., `predictions_N.<extension>`
/// are created where `<extension>` depends on chosen
/// [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format],
/// and N may equal 0001 and depends on the total number of successfully
/// predicted instances. If the Model has both
/// [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
/// and
/// [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
/// schemata defined then each such file contains predictions as per the
/// [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format].
/// If prediction for any instance failed (partially or completely), then
/// an additional `errors_0001.<extension>`, `errors_0002.<extension>`,...,
/// `errors_N.<extension>` files are created (N depends on total number
/// of failed predictions). These files contain the failed instances,
/// as per their schema, followed by an additional `error` field which as
/// value has [google.rpc.Status][google.rpc.Status]
/// containing only `code` and `message` fields.
#[prost(message, tag = "2")]
GcsDestination(super::super::GcsDestination),
/// The BigQuery project or dataset location where the output is to be
/// written to. If project is provided, a new dataset is created with name
/// `prediction_<model-display-name>_<job-create-time>`
/// where <model-display-name> is made
/// BigQuery-dataset-name compatible (for example, most special characters
/// become underscores), and timestamp is in
/// YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset
/// two tables will be created, `predictions`, and `errors`.
/// If the Model has both
/// [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
/// and
/// [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
/// schemata defined then the tables have columns as follows: The
/// `predictions` table contains instances for which the prediction
/// succeeded, it has columns as per a concatenation of the Model's
/// instance and prediction schemata. The `errors` table contains rows for
/// which the prediction has failed, it has instance columns, as per the
/// instance schema, followed by a single "errors" column, which as values
/// has [google.rpc.Status][google.rpc.Status]
/// represented as a STRUCT, and containing only `code` and `message`.
#[prost(message, tag = "3")]
BigqueryDestination(super::super::BigQueryDestination),
}
}
/// Further describes this job's output.
/// Supplements
/// [output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OutputInfo {
/// Output only. The name of the BigQuery table created, in
/// `predictions_<timestamp>`
/// format, into which the prediction output is written.
/// Can be used by UI to generate the BigQuery output path, for example.
#[prost(string, tag = "4")]
pub bigquery_output_table: ::prost::alloc::string::String,
/// The output location into which prediction output is written.
#[prost(oneof = "output_info::OutputLocation", tags = "1, 2")]
pub output_location: ::core::option::Option<output_info::OutputLocation>,
}
/// Nested message and enum types in `OutputInfo`.
pub mod output_info {
/// The output location into which prediction output is written.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OutputLocation {
/// Output only. The full path of the Cloud Storage directory created, into
/// which the prediction output is written.
#[prost(string, tag = "1")]
GcsOutputDirectory(::prost::alloc::string::String),
/// Output only. The path of the BigQuery dataset created, in
/// `bq://projectId.bqDatasetId`
/// format, into which the prediction output is written.
#[prost(string, tag = "2")]
BigqueryOutputDataset(::prost::alloc::string::String),
}
}
}
/// A collection of metrics calculated by comparing Model's predictions on a
/// slice of the test data against ground truth annotations.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelEvaluationSlice {
/// Output only. The resource name of the ModelEvaluationSlice.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. The slice of the test data that is used to evaluate the Model.
#[prost(message, optional, tag = "2")]
pub slice: ::core::option::Option<model_evaluation_slice::Slice>,
/// Output only. Points to a YAML file stored on Google Cloud Storage
/// describing the
/// [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this
/// ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
#[prost(string, tag = "3")]
pub metrics_schema_uri: ::prost::alloc::string::String,
/// Output only. Sliced evaluation metrics of the Model. The schema of the
/// metrics is stored in
/// [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri]
#[prost(message, optional, tag = "4")]
pub metrics: ::core::option::Option<::prost_types::Value>,
/// Output only. Timestamp when this ModelEvaluationSlice was created.
#[prost(message, optional, tag = "5")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Aggregated explanation metrics for the Model's prediction
/// output over the data this ModelEvaluation uses. This field is populated
/// only if the Model is evaluated with explanations, and only for tabular
/// Models.
#[prost(message, optional, tag = "6")]
pub model_explanation: ::core::option::Option<ModelExplanation>,
}
/// Nested message and enum types in `ModelEvaluationSlice`.
pub mod model_evaluation_slice {
/// Definition of a slice.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Slice {
/// Output only. The dimension of the slice.
/// Well-known dimensions are:
/// * `annotationSpec`: This slice is on the test data that has either
/// ground truth or prediction with
/// [AnnotationSpec.display_name][google.cloud.aiplatform.v1.AnnotationSpec.display_name]
/// equals to
/// [value][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.value].
/// * `slice`: This slice is a user customized slice defined by its
/// SliceSpec.
#[prost(string, tag = "1")]
pub dimension: ::prost::alloc::string::String,
/// Output only. The value of the dimension in this slice.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
/// Output only. Specification for how the data was sliced.
#[prost(message, optional, tag = "3")]
pub slice_spec: ::core::option::Option<slice::SliceSpec>,
}
/// Nested message and enum types in `Slice`.
pub mod slice {
/// Specification for how the data should be sliced.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SliceSpec {
/// Mapping configuration for this SliceSpec.
/// The key is the name of the feature.
/// By default, the key will be prefixed by "instance" as a dictionary
/// prefix for Vertex Batch Predictions output format.
#[prost(btree_map = "string, message", tag = "1")]
pub configs: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
slice_spec::SliceConfig,
>,
}
/// Nested message and enum types in `SliceSpec`.
pub mod slice_spec {
/// Specification message containing the config for this SliceSpec.
/// When `kind` is selected as `value` and/or `range`, only a single slice
/// will be computed.
/// When `all_values` is present, a separate slice will be computed for
/// each possible label/value for the corresponding key in `config`.
/// Examples, with feature zip_code with values 12345, 23334, 88888 and
/// feature country with values "US", "Canada", "Mexico" in the dataset:
///
/// Example 1:
///
/// {
/// "zip_code": { "value": { "float_value": 12345.0 } }
/// }
///
/// A single slice for any data with zip_code 12345 in the dataset.
///
/// Example 2:
///
/// {
/// "zip_code": { "range": { "low": 12345, "high": 20000 } }
/// }
///
/// A single slice containing data where the zip_codes between 12345 and
/// 20000 For this example, data with the zip_code of 12345 will be in this
/// slice.
///
/// Example 3:
///
/// {
/// "zip_code": { "range": { "low": 10000, "high": 20000 } },
/// "country": { "value": { "string_value": "US" } }
/// }
///
/// A single slice containing data where the zip_codes between 10000 and
/// 20000 has the country "US". For this example, data with the zip_code of
/// 12345 and country "US" will be in this slice.
///
/// Example 4:
///
/// { "country": {"all_values": { "value": true } } }
///
/// Three slices are computed, one for each unique country in the dataset.
///
/// Example 5:
///
/// {
/// "country": { "all_values": { "value": true } },
/// "zip_code": { "value": { "float_value": 12345.0 } }
/// }
///
/// Three slices are computed, one for each unique country in the dataset
/// where the zip_code is also 12345. For this example, data with zip_code
/// 12345 and country "US" will be in one slice, zip_code 12345 and country
/// "Canada" in another slice, and zip_code 12345 and country "Mexico" in
/// another slice, totaling 3 slices.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SliceConfig {
#[prost(oneof = "slice_config::Kind", tags = "1, 2, 3")]
pub kind: ::core::option::Option<slice_config::Kind>,
}
/// Nested message and enum types in `SliceConfig`.
pub mod slice_config {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
/// A unique specific value for a given feature.
/// Example: `{ "value": { "string_value": "12345" } }`
#[prost(message, tag = "1")]
Value(super::Value),
/// A range of values for a numerical feature.
/// Example: `{"range":{"low":10000.0,"high":50000.0}}`
/// will capture 12345 and 23334 in the slice.
#[prost(message, tag = "2")]
Range(super::Range),
/// If all_values is set to true, then all possible labels of the keyed
/// feature will have another slice computed.
/// Example: `{"all_values":{"value":true}}`
#[prost(message, tag = "3")]
AllValues(bool),
}
}
/// A range of values for slice(s).
/// `low` is inclusive, `high` is exclusive.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Range {
/// Inclusive low value for the range.
#[prost(float, tag = "1")]
pub low: f32,
/// Exclusive high value for the range.
#[prost(float, tag = "2")]
pub high: f32,
}
/// Single value that supports strings and floats.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Value {
#[prost(oneof = "value::Kind", tags = "1, 2")]
pub kind: ::core::option::Option<value::Kind>,
}
/// Nested message and enum types in `Value`.
pub mod value {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
/// String type.
#[prost(string, tag = "1")]
StringValue(::prost::alloc::string::String),
/// Float type.
#[prost(float, tag = "2")]
FloatValue(f32),
}
}
}
}
}
/// SpecialistPool represents customers' own workforce to work on their data
/// labeling jobs. It includes a group of specialist managers and workers.
/// Managers are responsible for managing the workers in this pool as well as
/// customers' data labeling jobs associated with this pool. Customers create
/// specialist pool as well as start data labeling jobs on Cloud, managers and
/// workers handle the jobs using CrowdCompute console.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SpecialistPool {
/// Required. The resource name of the SpecialistPool.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user-defined name of the SpecialistPool.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
/// This field should be unique on project-level.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Output only. The number of managers in this SpecialistPool.
#[prost(int32, tag = "3")]
pub specialist_managers_count: i32,
/// The email addresses of the managers in the SpecialistPool.
#[prost(string, repeated, tag = "4")]
pub specialist_manager_emails: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// Output only. The resource name of the pending data labeling jobs.
#[prost(string, repeated, tag = "5")]
pub pending_data_labeling_jobs: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// The email addresses of workers in the SpecialistPool.
#[prost(string, repeated, tag = "7")]
pub specialist_worker_emails: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
/// Instance of a general MetadataSchema.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetadataSchema {
/// Output only. The resource name of the MetadataSchema.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The version of the MetadataSchema. The version's format must match
/// the following regular expression: `^\[0-9\]+[.][0-9]+[.][0-9]+$`, which would
/// allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
#[prost(string, tag = "2")]
pub schema_version: ::prost::alloc::string::String,
/// Required. The raw YAML string representation of the MetadataSchema. The
/// combination of \[MetadataSchema.version\] and the schema name given by
/// `title` in \[MetadataSchema.schema\] must be unique within a MetadataStore.
///
/// The schema is defined as an OpenAPI 3.0.2
/// [MetadataSchema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject>)
#[prost(string, tag = "3")]
pub schema: ::prost::alloc::string::String,
/// The type of the MetadataSchema. This is a property that identifies which
/// metadata types will use the MetadataSchema.
#[prost(enumeration = "metadata_schema::MetadataSchemaType", tag = "4")]
pub schema_type: i32,
/// Output only. Timestamp when this MetadataSchema was created.
#[prost(message, optional, tag = "5")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Description of the Metadata Schema
#[prost(string, tag = "6")]
pub description: ::prost::alloc::string::String,
}
/// Nested message and enum types in `MetadataSchema`.
pub mod metadata_schema {
/// Describes the type of the MetadataSchema.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum MetadataSchemaType {
/// Unspecified type for the MetadataSchema.
Unspecified = 0,
/// A type indicating that the MetadataSchema will be used by Artifacts.
ArtifactType = 1,
/// A typee indicating that the MetadataSchema will be used by Executions.
ExecutionType = 2,
/// A state indicating that the MetadataSchema will be used by Contexts.
ContextType = 3,
}
impl MetadataSchemaType {
/// 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 {
MetadataSchemaType::Unspecified => "METADATA_SCHEMA_TYPE_UNSPECIFIED",
MetadataSchemaType::ArtifactType => "ARTIFACT_TYPE",
MetadataSchemaType::ExecutionType => "EXECUTION_TYPE",
MetadataSchemaType::ContextType => "CONTEXT_TYPE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"METADATA_SCHEMA_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"ARTIFACT_TYPE" => Some(Self::ArtifactType),
"EXECUTION_TYPE" => Some(Self::ExecutionType),
"CONTEXT_TYPE" => Some(Self::ContextType),
_ => None,
}
}
}
}
/// Lookup key for a feature view.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureViewDataKey {
#[prost(oneof = "feature_view_data_key::KeyOneof", tags = "1, 2")]
pub key_oneof: ::core::option::Option<feature_view_data_key::KeyOneof>,
}
/// Nested message and enum types in `FeatureViewDataKey`.
pub mod feature_view_data_key {
/// ID that is comprised from several parts (columns).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CompositeKey {
/// Parts to construct Entity ID. Should match with the same ID columns as
/// defined in FeatureView in the same order.
#[prost(string, repeated, tag = "1")]
pub parts: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum KeyOneof {
/// String key to use for lookup.
#[prost(string, tag = "1")]
Key(::prost::alloc::string::String),
/// The actual Entity ID will be composed from this struct. This should match
/// with the way ID is defined in the FeatureView spec.
#[prost(message, tag = "2")]
CompositeKey(CompositeKey),
}
}
/// Request message for
/// [FeatureOnlineStoreService.FetchFeatureValues][google.cloud.aiplatform.v1.FeatureOnlineStoreService.FetchFeatureValues].
/// All the features under the requested feature view will be returned.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FetchFeatureValuesRequest {
/// Required. FeatureView resource format
/// `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
#[prost(string, tag = "1")]
pub feature_view: ::prost::alloc::string::String,
/// Optional. The request key to fetch feature values for.
#[prost(message, optional, tag = "6")]
pub data_key: ::core::option::Option<FeatureViewDataKey>,
/// Optional. Response data format. If not set,
/// [FeatureViewDataFormat.KEY_VALUE][google.cloud.aiplatform.v1.FeatureViewDataFormat.KEY_VALUE]
/// will be used.
#[prost(enumeration = "FeatureViewDataFormat", tag = "7")]
pub data_format: i32,
}
/// Response message for
/// [FeatureOnlineStoreService.FetchFeatureValues][google.cloud.aiplatform.v1.FeatureOnlineStoreService.FetchFeatureValues]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FetchFeatureValuesResponse {
/// The data key associated with this response.
/// Will only be populated for
/// [FeatureOnlineStoreService.StreamingFetchFeatureValues][] RPCs.
#[prost(message, optional, tag = "4")]
pub data_key: ::core::option::Option<FeatureViewDataKey>,
#[prost(oneof = "fetch_feature_values_response::Format", tags = "3, 2")]
pub format: ::core::option::Option<fetch_feature_values_response::Format>,
}
/// Nested message and enum types in `FetchFeatureValuesResponse`.
pub mod fetch_feature_values_response {
/// Response structure in the format of key (feature name) and (feature) value
/// pair.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureNameValuePairList {
/// List of feature names and values.
#[prost(message, repeated, tag = "1")]
pub features: ::prost::alloc::vec::Vec<
feature_name_value_pair_list::FeatureNameValuePair,
>,
}
/// Nested message and enum types in `FeatureNameValuePairList`.
pub mod feature_name_value_pair_list {
/// Feature name & value pair.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureNameValuePair {
/// Feature short name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
#[prost(oneof = "feature_name_value_pair::Data", tags = "2")]
pub data: ::core::option::Option<feature_name_value_pair::Data>,
}
/// Nested message and enum types in `FeatureNameValuePair`.
pub mod feature_name_value_pair {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Data {
/// Feature value.
#[prost(message, tag = "2")]
Value(super::super::super::FeatureValue),
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Format {
/// Feature values in KeyValue format.
#[prost(message, tag = "3")]
KeyValues(FeatureNameValuePairList),
/// Feature values in proto Struct format.
#[prost(message, tag = "2")]
ProtoStruct(::prost_types::Struct),
}
}
/// A query to find a number of similar entities.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NearestNeighborQuery {
/// Optional. The number of similar entities to be retrieved from feature view
/// for each query.
#[prost(int32, tag = "3")]
pub neighbor_count: i32,
/// Optional. The list of string filters.
#[prost(message, repeated, tag = "4")]
pub string_filters: ::prost::alloc::vec::Vec<nearest_neighbor_query::StringFilter>,
/// Optional. The list of numeric filters.
#[prost(message, repeated, tag = "8")]
pub numeric_filters: ::prost::alloc::vec::Vec<nearest_neighbor_query::NumericFilter>,
/// Optional. Crowding is a constraint on a neighbor list produced by nearest
/// neighbor search requiring that no more than
/// sper_crowding_attribute_neighbor_count of the k neighbors returned have the
/// same value of crowding_attribute. It's used for improving result diversity.
#[prost(int32, tag = "5")]
pub per_crowding_attribute_neighbor_count: i32,
/// Optional. Parameters that can be set to tune query on the fly.
#[prost(message, optional, tag = "7")]
pub parameters: ::core::option::Option<nearest_neighbor_query::Parameters>,
#[prost(oneof = "nearest_neighbor_query::Instance", tags = "1, 2")]
pub instance: ::core::option::Option<nearest_neighbor_query::Instance>,
}
/// Nested message and enum types in `NearestNeighborQuery`.
pub mod nearest_neighbor_query {
/// The embedding vector.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Embedding {
/// Optional. Individual value in the embedding.
#[prost(float, repeated, packed = "false", tag = "1")]
pub value: ::prost::alloc::vec::Vec<f32>,
}
/// String filter is used to search a subset of the entities by using boolean
/// rules on string columns.
/// For example: if a query specifies string filter
/// with 'name = color, allow_tokens = {red, blue}, deny_tokens = {purple}','
/// then that query will match entities that are red or blue, but if those
/// points are also purple, then they will be excluded even if they are
/// red/blue. Only string filter is supported for now, numeric filter will be
/// supported in the near future.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StringFilter {
/// Required. Column names in BigQuery that used as filters.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The allowed tokens.
#[prost(string, repeated, tag = "2")]
pub allow_tokens: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. The denied tokens.
#[prost(string, repeated, tag = "3")]
pub deny_tokens: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Numeric filter is used to search a subset of the entities by using boolean
/// rules on numeric columns.
/// For example:
/// Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0}
/// Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0}
/// Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0}
/// Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2
/// {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NumericFilter {
/// Required. Column name in BigQuery that used as filters.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. This MUST be specified for queries and must NOT be specified
/// for database points.
#[prost(enumeration = "numeric_filter::Operator", optional, tag = "5")]
pub op: ::core::option::Option<i32>,
/// The type of Value must be consistent for all datapoints with a given
/// name. This is verified at runtime.
#[prost(oneof = "numeric_filter::Value", tags = "2, 3, 4")]
pub value: ::core::option::Option<numeric_filter::Value>,
}
/// Nested message and enum types in `NumericFilter`.
pub mod numeric_filter {
/// Datapoints for which Operator is true relative to the query’s Value
/// field will be allowlisted.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Operator {
/// Unspecified operator.
Unspecified = 0,
/// Entities are eligible if their value is < the query's.
Less = 1,
/// Entities are eligible if their value is <= the query's.
LessEqual = 2,
/// Entities are eligible if their value is == the query's.
Equal = 3,
/// Entities are eligible if their value is >= the query's.
GreaterEqual = 4,
/// Entities are eligible if their value is > the query's.
Greater = 5,
/// Entities are eligible if their value is != the query's.
NotEqual = 6,
}
impl Operator {
/// 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 {
Operator::Unspecified => "OPERATOR_UNSPECIFIED",
Operator::Less => "LESS",
Operator::LessEqual => "LESS_EQUAL",
Operator::Equal => "EQUAL",
Operator::GreaterEqual => "GREATER_EQUAL",
Operator::Greater => "GREATER",
Operator::NotEqual => "NOT_EQUAL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPERATOR_UNSPECIFIED" => Some(Self::Unspecified),
"LESS" => Some(Self::Less),
"LESS_EQUAL" => Some(Self::LessEqual),
"EQUAL" => Some(Self::Equal),
"GREATER_EQUAL" => Some(Self::GreaterEqual),
"GREATER" => Some(Self::Greater),
"NOT_EQUAL" => Some(Self::NotEqual),
_ => None,
}
}
}
/// The type of Value must be consistent for all datapoints with a given
/// name. This is verified at runtime.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Value {
/// int value type.
#[prost(int64, tag = "2")]
ValueInt(i64),
/// float value type.
#[prost(float, tag = "3")]
ValueFloat(f32),
/// double value type.
#[prost(double, tag = "4")]
ValueDouble(f64),
}
}
/// Parameters that can be overrided in each query to tune query latency and
/// recall.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Parameters {
/// Optional. The number of neighbors to find via approximate search before
/// exact reordering is performed; if set, this value must be >
/// neighbor_count.
#[prost(int32, tag = "1")]
pub approximate_neighbor_candidates: i32,
/// Optional. The fraction of the number of leaves to search, set at query
/// time allows user to tune search performance. This value increase result
/// in both search accuracy and latency increase. The value should be between
/// 0.0 and 1.0.
#[prost(double, tag = "2")]
pub leaf_nodes_search_fraction: f64,
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Instance {
/// Optional. The entity id whose similar entities should be searched for.
/// If embedding is set, search will use embedding instead of
/// entity_id.
#[prost(string, tag = "1")]
EntityId(::prost::alloc::string::String),
/// Optional. The embedding vector that be used for similar search.
#[prost(message, tag = "2")]
Embedding(Embedding),
}
}
/// The request message for
/// [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchNearestEntitiesRequest {
/// Required. FeatureView resource format
/// `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
#[prost(string, tag = "1")]
pub feature_view: ::prost::alloc::string::String,
/// Required. The query.
#[prost(message, optional, tag = "2")]
pub query: ::core::option::Option<NearestNeighborQuery>,
/// Optional. If set to true, the full entities (including all vector values
/// and metadata) of the nearest neighbors are returned; otherwise only entity
/// id of the nearest neighbors will be returned. Note that returning full
/// entities will significantly increase the latency and cost of the query.
#[prost(bool, tag = "3")]
pub return_full_entity: bool,
}
/// Nearest neighbors for one query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NearestNeighbors {
/// All its neighbors.
#[prost(message, repeated, tag = "1")]
pub neighbors: ::prost::alloc::vec::Vec<nearest_neighbors::Neighbor>,
}
/// Nested message and enum types in `NearestNeighbors`.
pub mod nearest_neighbors {
/// A neighbor of the query vector.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Neighbor {
/// The id of the similar entity.
#[prost(string, tag = "1")]
pub entity_id: ::prost::alloc::string::String,
/// The distance between the neighbor and the query vector.
#[prost(double, tag = "2")]
pub distance: f64,
/// The attributes of the neighbor, e.g. filters, crowding and metadata
/// Note that full entities are returned only when "return_full_entity"
/// is set to true. Otherwise, only the "entity_id" and "distance" fields
/// are populated.
#[prost(message, optional, tag = "3")]
pub entity_key_values: ::core::option::Option<super::FetchFeatureValuesResponse>,
}
}
/// Response message for
/// [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchNearestEntitiesResponse {
/// The nearest neighbors of the query entity.
#[prost(message, optional, tag = "1")]
pub nearest_neighbors: ::core::option::Option<NearestNeighbors>,
}
/// Format of the data in the Feature View.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum FeatureViewDataFormat {
/// Not set. Will be treated as the KeyValue format.
Unspecified = 0,
/// Return response data in key-value format.
KeyValue = 1,
/// Return response data in proto Struct format.
ProtoStruct = 2,
}
impl FeatureViewDataFormat {
/// 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 {
FeatureViewDataFormat::Unspecified => "FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED",
FeatureViewDataFormat::KeyValue => "KEY_VALUE",
FeatureViewDataFormat::ProtoStruct => "PROTO_STRUCT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED" => Some(Self::Unspecified),
"KEY_VALUE" => Some(Self::KeyValue),
"PROTO_STRUCT" => Some(Self::ProtoStruct),
_ => None,
}
}
}
/// Generated client implementations.
pub mod feature_online_store_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for fetching feature values from the online store.
#[derive(Debug, Clone)]
pub struct FeatureOnlineStoreServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> FeatureOnlineStoreServiceClient<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,
) -> FeatureOnlineStoreServiceClient<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,
{
FeatureOnlineStoreServiceClient::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
}
/// Fetch feature values under a FeatureView.
pub async fn fetch_feature_values(
&mut self,
request: impl tonic::IntoRequest<super::FetchFeatureValuesRequest>,
) -> std::result::Result<
tonic::Response<super::FetchFeatureValuesResponse>,
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.aiplatform.v1.FeatureOnlineStoreService/FetchFeatureValues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreService",
"FetchFeatureValues",
),
);
self.inner.unary(req, path, codec).await
}
/// Search the nearest entities under a FeatureView.
/// Search only works for indexable feature view; if a feature view isn't
/// indexable, returns Invalid argument response.
pub async fn search_nearest_entities(
&mut self,
request: impl tonic::IntoRequest<super::SearchNearestEntitiesRequest>,
) -> std::result::Result<
tonic::Response<super::SearchNearestEntitiesResponse>,
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.aiplatform.v1.FeatureOnlineStoreService/SearchNearestEntities",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreService",
"SearchNearestEntities",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Represents a job that runs custom workloads such as a Docker container or a
/// Python package. A CustomJob can have multiple worker pools and each worker
/// pool can have its own machine and input spec. A CustomJob will be cleaned up
/// once the job enters terminal state (failed or succeeded).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CustomJob {
/// Output only. Resource name of a CustomJob.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The display name of the CustomJob.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. Job spec.
#[prost(message, optional, tag = "4")]
pub job_spec: ::core::option::Option<CustomJobSpec>,
/// Output only. The detailed state of the job.
#[prost(enumeration = "JobState", tag = "5")]
pub state: i32,
/// Output only. Time when the CustomJob was created.
#[prost(message, optional, tag = "6")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the CustomJob for the first time entered the
/// `JOB_STATE_RUNNING` state.
#[prost(message, optional, tag = "7")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the CustomJob entered any of the following states:
/// `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
#[prost(message, optional, tag = "8")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the CustomJob was most recently updated.
#[prost(message, optional, tag = "9")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Only populated when job's state is `JOB_STATE_FAILED` or
/// `JOB_STATE_CANCELLED`.
#[prost(message, optional, tag = "10")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// The labels with user-defined metadata to organize CustomJobs.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "11")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Customer-managed encryption key options for a CustomJob. If this is set,
/// then all resources created by the CustomJob will be encrypted with the
/// provided encryption key.
#[prost(message, optional, tag = "12")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. URIs for accessing [interactive
/// shells](<https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell>)
/// (one URI for each training node). Only available if
/// [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
/// is `true`.
///
/// The keys are names of each node in the training job; for example,
/// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
/// the second worker pool, and `workerpool1-1` for the second node in the
/// second worker pool.
///
/// The values are the URIs for each node's interactive shell.
#[prost(btree_map = "string, string", tag = "16")]
pub web_access_uris: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "18")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "19")]
pub satisfies_pzi: bool,
}
/// Represents the spec of a CustomJob.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CustomJobSpec {
/// Optional. The ID of the PersistentResource in the same Project and Location
/// which to run
///
/// If this is specified, the job will be run on existing machines held by the
/// PersistentResource instead of on-demand short-live machines.
/// The network and CMEK configs on the job should be consistent with those on
/// the PersistentResource, otherwise, the job will be rejected.
#[prost(string, tag = "14")]
pub persistent_resource_id: ::prost::alloc::string::String,
/// Required. The spec of the worker pools including machine type and Docker
/// image. All worker pools except the first one are optional and can be
/// skipped by providing an empty value.
#[prost(message, repeated, tag = "1")]
pub worker_pool_specs: ::prost::alloc::vec::Vec<WorkerPoolSpec>,
/// Scheduling options for a CustomJob.
#[prost(message, optional, tag = "3")]
pub scheduling: ::core::option::Option<Scheduling>,
/// Specifies the service account for workload run-as account.
/// Users submitting jobs must have act-as permission on this run-as account.
/// If unspecified, the [Vertex AI Custom Code Service
/// Agent](<https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents>)
/// for the CustomJob's project is used.
#[prost(string, tag = "4")]
pub service_account: ::prost::alloc::string::String,
/// Optional. The full name of the Compute Engine
/// [network](/compute/docs/networks-and-firewalls#networks) to which the Job
/// should be peered. For example, `projects/12345/global/networks/myVPC`.
/// [Format](/compute/docs/reference/rest/v1/networks/insert)
/// is of the form `projects/{project}/global/networks/{network}`.
/// Where {project} is a project number, as in `12345`, and {network} is a
/// network name.
///
/// To specify this field, you must have already [configured VPC Network
/// Peering for Vertex
/// AI](<https://cloud.google.com/vertex-ai/docs/general/vpc-peering>).
///
/// If this field is left unspecified, the job is not peered with any network.
#[prost(string, tag = "5")]
pub network: ::prost::alloc::string::String,
/// Optional. A list of names for the reserved ip ranges under the VPC network
/// that can be used for this job.
///
/// If set, we will deploy the job within the provided ip ranges. Otherwise,
/// the job will be deployed to any ip ranges under the provided VPC
/// network.
///
/// Example: \['vertex-ai-ip-range'\].
#[prost(string, repeated, tag = "13")]
pub reserved_ip_ranges: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The Cloud Storage location to store the output of this CustomJob or
/// HyperparameterTuningJob. For HyperparameterTuningJob,
/// the baseOutputDirectory of
/// each child CustomJob backing a Trial is set to a subdirectory of name
/// [id][google.cloud.aiplatform.v1.Trial.id] under its parent
/// HyperparameterTuningJob's baseOutputDirectory.
///
/// The following Vertex AI environment variables will be passed to
/// containers or python modules when this field is set:
///
/// For CustomJob:
///
/// * AIP_MODEL_DIR = `<base_output_directory>/model/`
/// * AIP_CHECKPOINT_DIR = `<base_output_directory>/checkpoints/`
/// * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/logs/`
///
/// For CustomJob backing a Trial of HyperparameterTuningJob:
///
/// * AIP_MODEL_DIR = `<base_output_directory>/<trial_id>/model/`
/// * AIP_CHECKPOINT_DIR = `<base_output_directory>/<trial_id>/checkpoints/`
/// * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
#[prost(message, optional, tag = "6")]
pub base_output_directory: ::core::option::Option<GcsDestination>,
/// The ID of the location to store protected artifacts. e.g. us-central1.
/// Populate only when the location is different than CustomJob location.
/// List of supported locations:
/// <https://cloud.google.com/vertex-ai/docs/general/locations>
#[prost(string, tag = "19")]
pub protected_artifact_location_id: ::prost::alloc::string::String,
/// Optional. The name of a Vertex AI
/// [Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which
/// this CustomJob will upload Tensorboard logs. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(string, tag = "7")]
pub tensorboard: ::prost::alloc::string::String,
/// Optional. Whether you want Vertex AI to enable [interactive shell
/// access](<https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell>)
/// to training containers.
///
/// If set to `true`, you can access interactive shells at the URIs given
/// by
/// [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris]
/// or
/// [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
/// (within
/// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
#[prost(bool, tag = "10")]
pub enable_web_access: bool,
/// Optional. Whether you want Vertex AI to enable access to the customized
/// dashboard in training chief container.
///
/// If set to `true`, you can access the dashboard at the URIs given
/// by
/// [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris]
/// or
/// [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
/// (within
/// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
#[prost(bool, tag = "16")]
pub enable_dashboard_access: bool,
/// Optional. The Experiment associated with this job.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`
#[prost(string, tag = "17")]
pub experiment: ::prost::alloc::string::String,
/// Optional. The Experiment Run associated with this job.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`
#[prost(string, tag = "18")]
pub experiment_run: ::prost::alloc::string::String,
/// Optional. The name of the Model resources for which to generate a mapping
/// to artifact URIs. Applicable only to some of the Google-provided custom
/// jobs. Format: `projects/{project}/locations/{location}/models/{model}`
///
/// In order to retrieve a specific version of the model, also provide
/// the version ID or version alias.
/// Example: `projects/{project}/locations/{location}/models/{model}@2`
/// or
/// `projects/{project}/locations/{location}/models/{model}@golden`
/// If no version ID or alias is specified, the "default" version will be
/// returned. The "default" version alias is created for the first version of
/// the model, and can be moved to other versions later on. There will be
/// exactly one default version.
#[prost(string, repeated, tag = "20")]
pub models: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Represents the spec of a worker pool in a job.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WorkerPoolSpec {
/// Optional. Immutable. The specification of a single machine.
#[prost(message, optional, tag = "1")]
pub machine_spec: ::core::option::Option<MachineSpec>,
/// Optional. The number of worker replicas to use for this worker pool.
#[prost(int64, tag = "2")]
pub replica_count: i64,
/// Optional. List of NFS mount spec.
#[prost(message, repeated, tag = "4")]
pub nfs_mounts: ::prost::alloc::vec::Vec<NfsMount>,
/// Disk spec.
#[prost(message, optional, tag = "5")]
pub disk_spec: ::core::option::Option<DiskSpec>,
/// The custom task to be executed in this worker pool.
#[prost(oneof = "worker_pool_spec::Task", tags = "6, 7")]
pub task: ::core::option::Option<worker_pool_spec::Task>,
}
/// Nested message and enum types in `WorkerPoolSpec`.
pub mod worker_pool_spec {
/// The custom task to be executed in this worker pool.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Task {
/// The custom container task.
#[prost(message, tag = "6")]
ContainerSpec(super::ContainerSpec),
/// The Python packaged task.
#[prost(message, tag = "7")]
PythonPackageSpec(super::PythonPackageSpec),
}
}
/// The spec of a Container.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ContainerSpec {
/// Required. The URI of a container image in the Container Registry that is to
/// be run on each worker replica.
#[prost(string, tag = "1")]
pub image_uri: ::prost::alloc::string::String,
/// The command to be invoked when the container is started.
/// It overrides the entrypoint instruction in Dockerfile when provided.
#[prost(string, repeated, tag = "2")]
pub command: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The arguments to be passed when starting the container.
#[prost(string, repeated, tag = "3")]
pub args: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Environment variables to be passed to the container.
/// Maximum limit is 100.
#[prost(message, repeated, tag = "4")]
pub env: ::prost::alloc::vec::Vec<EnvVar>,
}
/// The spec of a Python packaged code.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PythonPackageSpec {
/// Required. The URI of a container image in Artifact Registry that will run
/// the provided Python package. Vertex AI provides a wide range of executor
/// images with pre-installed packages to meet users' various use cases. See
/// the list of [pre-built containers for
/// training](<https://cloud.google.com/vertex-ai/docs/training/pre-built-containers>).
/// You must use an image from this list.
#[prost(string, tag = "1")]
pub executor_image_uri: ::prost::alloc::string::String,
/// Required. The Google Cloud Storage location of the Python package files
/// which are the training program and its dependent packages. The maximum
/// number of package URIs is 100.
#[prost(string, repeated, tag = "2")]
pub package_uris: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Required. The Python module name to run after installing the packages.
#[prost(string, tag = "3")]
pub python_module: ::prost::alloc::string::String,
/// Command line arguments to be passed to the Python task.
#[prost(string, repeated, tag = "4")]
pub args: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Environment variables to be passed to the python module.
/// Maximum limit is 100.
#[prost(message, repeated, tag = "5")]
pub env: ::prost::alloc::vec::Vec<EnvVar>,
}
/// All parameters related to queuing and scheduling of custom jobs.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Scheduling {
/// The maximum job running time. The default is 7 days.
#[prost(message, optional, tag = "1")]
pub timeout: ::core::option::Option<::prost_types::Duration>,
/// Restarts the entire CustomJob if a worker gets restarted.
/// This feature can be used by distributed training jobs that are not
/// resilient to workers leaving and joining a job.
#[prost(bool, tag = "3")]
pub restart_job_on_worker_restart: bool,
/// Optional. This determines which type of scheduling strategy to use.
#[prost(enumeration = "scheduling::Strategy", tag = "4")]
pub strategy: i32,
/// Optional. Indicates if the job should retry for internal errors after the
/// job starts running. If true, overrides
/// `Scheduling.restart_job_on_worker_restart` to false.
#[prost(bool, tag = "5")]
pub disable_retries: bool,
/// Optional. This is the maximum duration that a job will wait for the
/// requested resources to be provisioned if the scheduling strategy is set to
/// \[Strategy.DWS_FLEX_START\].
/// If set to 0, the job will wait indefinitely. The default is 24 hours.
#[prost(message, optional, tag = "6")]
pub max_wait_duration: ::core::option::Option<::prost_types::Duration>,
}
/// Nested message and enum types in `Scheduling`.
pub mod scheduling {
/// Optional. This determines which type of scheduling strategy to use. Right
/// now users have two options such as STANDARD which will use regular on
/// demand resources to schedule the job, the other is SPOT which would
/// leverage spot resources alongwith regular resources to schedule
/// the job.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Strategy {
/// Strategy will default to STANDARD.
Unspecified = 0,
/// Regular on-demand provisioning strategy.
OnDemand = 1,
/// Low cost by making potential use of spot resources.
LowCost = 2,
/// Standard provisioning strategy uses regular on-demand resources.
Standard = 3,
/// Spot provisioning strategy uses spot resources.
Spot = 4,
}
impl Strategy {
/// 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 {
Strategy::Unspecified => "STRATEGY_UNSPECIFIED",
Strategy::OnDemand => "ON_DEMAND",
Strategy::LowCost => "LOW_COST",
Strategy::Standard => "STANDARD",
Strategy::Spot => "SPOT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STRATEGY_UNSPECIFIED" => Some(Self::Unspecified),
"ON_DEMAND" => Some(Self::OnDemand),
"LOW_COST" => Some(Self::LowCost),
"STANDARD" => Some(Self::Standard),
"SPOT" => Some(Self::Spot),
_ => None,
}
}
}
}
/// Represents a HyperparameterTuningJob. A HyperparameterTuningJob
/// has a Study specification and multiple CustomJobs with identical
/// CustomJob specification.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HyperparameterTuningJob {
/// Output only. Resource name of the HyperparameterTuningJob.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The display name of the HyperparameterTuningJob.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. Study configuration of the HyperparameterTuningJob.
#[prost(message, optional, tag = "4")]
pub study_spec: ::core::option::Option<StudySpec>,
/// Required. The desired total number of Trials.
#[prost(int32, tag = "5")]
pub max_trial_count: i32,
/// Required. The desired number of Trials to run in parallel.
#[prost(int32, tag = "6")]
pub parallel_trial_count: i32,
/// The number of failed Trials that need to be seen before failing
/// the HyperparameterTuningJob.
///
/// If set to 0, Vertex AI decides how many Trials must fail
/// before the whole job fails.
#[prost(int32, tag = "7")]
pub max_failed_trial_count: i32,
/// Required. The spec of a trial job. The same spec applies to the CustomJobs
/// created in all the trials.
#[prost(message, optional, tag = "8")]
pub trial_job_spec: ::core::option::Option<CustomJobSpec>,
/// Output only. Trials of the HyperparameterTuningJob.
#[prost(message, repeated, tag = "9")]
pub trials: ::prost::alloc::vec::Vec<Trial>,
/// Output only. The detailed state of the job.
#[prost(enumeration = "JobState", tag = "10")]
pub state: i32,
/// Output only. Time when the HyperparameterTuningJob was created.
#[prost(message, optional, tag = "11")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the HyperparameterTuningJob for the first time
/// entered the `JOB_STATE_RUNNING` state.
#[prost(message, optional, tag = "12")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the HyperparameterTuningJob entered any of the
/// following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
/// `JOB_STATE_CANCELLED`.
#[prost(message, optional, tag = "13")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the HyperparameterTuningJob was most recently
/// updated.
#[prost(message, optional, tag = "14")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Only populated when job's state is JOB_STATE_FAILED or
/// JOB_STATE_CANCELLED.
#[prost(message, optional, tag = "15")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// The labels with user-defined metadata to organize HyperparameterTuningJobs.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "16")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Customer-managed encryption key options for a HyperparameterTuningJob.
/// If this is set, then all resources created by the HyperparameterTuningJob
/// will be encrypted with the provided encryption key.
#[prost(message, optional, tag = "17")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "19")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "20")]
pub satisfies_pzi: bool,
}
/// A piece of data in a Dataset. Could be an image, a video, a document or plain
/// text.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataItem {
/// Output only. The resource name of the DataItem.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Timestamp when this DataItem was created.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this DataItem was last updated.
#[prost(message, optional, tag = "6")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. The labels with user-defined metadata to organize your DataItems.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one DataItem(System
/// labels are excluded).
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "3")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Required. The data that the DataItem represents (for example, an image or a
/// text snippet). The schema of the payload is stored in the parent Dataset's
/// [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
/// dataItemSchemaUri field.
#[prost(message, optional, tag = "4")]
pub payload: ::core::option::Option<::prost_types::Value>,
/// Optional. Used to perform consistent read-modify-write updates. If not set,
/// a blind "overwrite" update happens.
#[prost(string, tag = "7")]
pub etag: ::prost::alloc::string::String,
/// Output only. Reserved for future use.
#[prost(bool, tag = "10")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "11")]
pub satisfies_pzi: bool,
}
/// Request message for
/// [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateIndexRequest {
/// Required. The resource name of the Location to create the Index in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Index to create.
#[prost(message, optional, tag = "2")]
pub index: ::core::option::Option<Index>,
}
/// Runtime operation information for
/// [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateIndexOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// The operation metadata with regard to Matching Engine Index operation.
#[prost(message, optional, tag = "2")]
pub nearest_neighbor_search_operation_metadata: ::core::option::Option<
NearestNeighborSearchOperationMetadata,
>,
}
/// Request message for
/// [IndexService.GetIndex][google.cloud.aiplatform.v1.IndexService.GetIndex]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetIndexRequest {
/// Required. The name of the Index resource.
/// Format:
/// `projects/{project}/locations/{location}/indexes/{index}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListIndexesRequest {
/// Required. The resource name of the Location from which to list the Indexes.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token]
/// of the previous
/// [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListIndexesResponse {
/// List of indexes in the requested page.
#[prost(message, repeated, tag = "1")]
pub indexes: ::prost::alloc::vec::Vec<Index>,
/// A token to retrieve next page of results.
/// Pass to
/// [ListIndexesRequest.page_token][google.cloud.aiplatform.v1.ListIndexesRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateIndexRequest {
/// Required. The Index which updates the resource on the server.
#[prost(message, optional, tag = "1")]
pub index: ::core::option::Option<Index>,
/// The update mask applies to the resource.
/// For the `FieldMask` definition, see
/// [google.protobuf.FieldMask][google.protobuf.FieldMask].
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Runtime operation information for
/// [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateIndexOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// The operation metadata with regard to Matching Engine Index operation.
#[prost(message, optional, tag = "2")]
pub nearest_neighbor_search_operation_metadata: ::core::option::Option<
NearestNeighborSearchOperationMetadata,
>,
}
/// Request message for
/// [IndexService.DeleteIndex][google.cloud.aiplatform.v1.IndexService.DeleteIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteIndexRequest {
/// Required. The name of the Index resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/indexes/{index}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpsertDatapointsRequest {
/// Required. The name of the Index resource to be updated.
/// Format:
/// `projects/{project}/locations/{location}/indexes/{index}`
#[prost(string, tag = "1")]
pub index: ::prost::alloc::string::String,
/// A list of datapoints to be created/updated.
#[prost(message, repeated, tag = "2")]
pub datapoints: ::prost::alloc::vec::Vec<IndexDatapoint>,
/// Optional. Update mask is used to specify the fields to be overwritten in
/// the datapoints by the update. The fields specified in the update_mask are
/// relative to each IndexDatapoint inside datapoints, not the full request.
///
/// Updatable fields:
///
/// * Use `all_restricts` to update both restricts and numeric_restricts.
#[prost(message, optional, tag = "3")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints]
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UpsertDatapointsResponse {}
/// Request message for
/// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RemoveDatapointsRequest {
/// Required. The name of the Index resource to be updated.
/// Format:
/// `projects/{project}/locations/{location}/indexes/{index}`
#[prost(string, tag = "1")]
pub index: ::prost::alloc::string::String,
/// A list of datapoint ids to be deleted.
#[prost(string, repeated, tag = "2")]
pub datapoint_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for
/// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints]
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RemoveDatapointsResponse {}
/// Runtime operation metadata with regard to Matching Engine Index.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NearestNeighborSearchOperationMetadata {
/// The validation stats of the content (per file) to be inserted or
/// updated on the Matching Engine Index resource. Populated if
/// contentsDeltaUri is provided as part of
/// [Index.metadata][google.cloud.aiplatform.v1.Index.metadata]. Please note
/// that, currently for those files that are broken or has unsupported file
/// format, we will not have the stats for those files.
#[prost(message, repeated, tag = "1")]
pub content_validation_stats: ::prost::alloc::vec::Vec<
nearest_neighbor_search_operation_metadata::ContentValidationStats,
>,
/// The ingested data size in bytes.
#[prost(int64, tag = "2")]
pub data_bytes_count: i64,
}
/// Nested message and enum types in `NearestNeighborSearchOperationMetadata`.
pub mod nearest_neighbor_search_operation_metadata {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RecordError {
/// The error type of this record.
#[prost(enumeration = "record_error::RecordErrorType", tag = "1")]
pub error_type: i32,
/// A human-readable message that is shown to the user to help them fix the
/// error. Note that this message may change from time to time, your code
/// should check against error_type as the source of truth.
#[prost(string, tag = "2")]
pub error_message: ::prost::alloc::string::String,
/// Cloud Storage URI pointing to the original file in user's bucket.
#[prost(string, tag = "3")]
pub source_gcs_uri: ::prost::alloc::string::String,
/// Empty if the embedding id is failed to parse.
#[prost(string, tag = "4")]
pub embedding_id: ::prost::alloc::string::String,
/// The original content of this record.
#[prost(string, tag = "5")]
pub raw_record: ::prost::alloc::string::String,
}
/// Nested message and enum types in `RecordError`.
pub mod record_error {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum RecordErrorType {
/// Default, shall not be used.
ErrorTypeUnspecified = 0,
/// The record is empty.
EmptyLine = 1,
/// Invalid json format.
InvalidJsonSyntax = 2,
/// Invalid csv format.
InvalidCsvSyntax = 3,
/// Invalid avro format.
InvalidAvroSyntax = 4,
/// The embedding id is not valid.
InvalidEmbeddingId = 5,
/// The size of the dense embedding vectors does not match with the
/// specified dimension.
EmbeddingSizeMismatch = 6,
/// The `namespace` field is missing.
NamespaceMissing = 7,
/// Generic catch-all error. Only used for validation failure where the
/// root cause cannot be easily retrieved programmatically.
ParsingError = 8,
/// There are multiple restricts with the same `namespace` value.
DuplicateNamespace = 9,
/// Numeric restrict has operator specified in datapoint.
OpInDatapoint = 10,
/// Numeric restrict has multiple values specified.
MultipleValues = 11,
/// Numeric restrict has invalid numeric value specified.
InvalidNumericValue = 12,
/// File is not in UTF_8 format.
InvalidEncoding = 13,
/// Error parsing sparse dimensions field.
InvalidSparseDimensions = 14,
/// Token restrict value is invalid.
InvalidTokenValue = 15,
/// Invalid sparse embedding.
InvalidSparseEmbedding = 16,
/// Invalid dense embedding.
InvalidEmbedding = 17,
}
impl RecordErrorType {
/// 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 {
RecordErrorType::ErrorTypeUnspecified => "ERROR_TYPE_UNSPECIFIED",
RecordErrorType::EmptyLine => "EMPTY_LINE",
RecordErrorType::InvalidJsonSyntax => "INVALID_JSON_SYNTAX",
RecordErrorType::InvalidCsvSyntax => "INVALID_CSV_SYNTAX",
RecordErrorType::InvalidAvroSyntax => "INVALID_AVRO_SYNTAX",
RecordErrorType::InvalidEmbeddingId => "INVALID_EMBEDDING_ID",
RecordErrorType::EmbeddingSizeMismatch => "EMBEDDING_SIZE_MISMATCH",
RecordErrorType::NamespaceMissing => "NAMESPACE_MISSING",
RecordErrorType::ParsingError => "PARSING_ERROR",
RecordErrorType::DuplicateNamespace => "DUPLICATE_NAMESPACE",
RecordErrorType::OpInDatapoint => "OP_IN_DATAPOINT",
RecordErrorType::MultipleValues => "MULTIPLE_VALUES",
RecordErrorType::InvalidNumericValue => "INVALID_NUMERIC_VALUE",
RecordErrorType::InvalidEncoding => "INVALID_ENCODING",
RecordErrorType::InvalidSparseDimensions => {
"INVALID_SPARSE_DIMENSIONS"
}
RecordErrorType::InvalidTokenValue => "INVALID_TOKEN_VALUE",
RecordErrorType::InvalidSparseEmbedding => "INVALID_SPARSE_EMBEDDING",
RecordErrorType::InvalidEmbedding => "INVALID_EMBEDDING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ERROR_TYPE_UNSPECIFIED" => Some(Self::ErrorTypeUnspecified),
"EMPTY_LINE" => Some(Self::EmptyLine),
"INVALID_JSON_SYNTAX" => Some(Self::InvalidJsonSyntax),
"INVALID_CSV_SYNTAX" => Some(Self::InvalidCsvSyntax),
"INVALID_AVRO_SYNTAX" => Some(Self::InvalidAvroSyntax),
"INVALID_EMBEDDING_ID" => Some(Self::InvalidEmbeddingId),
"EMBEDDING_SIZE_MISMATCH" => Some(Self::EmbeddingSizeMismatch),
"NAMESPACE_MISSING" => Some(Self::NamespaceMissing),
"PARSING_ERROR" => Some(Self::ParsingError),
"DUPLICATE_NAMESPACE" => Some(Self::DuplicateNamespace),
"OP_IN_DATAPOINT" => Some(Self::OpInDatapoint),
"MULTIPLE_VALUES" => Some(Self::MultipleValues),
"INVALID_NUMERIC_VALUE" => Some(Self::InvalidNumericValue),
"INVALID_ENCODING" => Some(Self::InvalidEncoding),
"INVALID_SPARSE_DIMENSIONS" => Some(Self::InvalidSparseDimensions),
"INVALID_TOKEN_VALUE" => Some(Self::InvalidTokenValue),
"INVALID_SPARSE_EMBEDDING" => Some(Self::InvalidSparseEmbedding),
"INVALID_EMBEDDING" => Some(Self::InvalidEmbedding),
_ => None,
}
}
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ContentValidationStats {
/// Cloud Storage URI pointing to the original file in user's bucket.
#[prost(string, tag = "1")]
pub source_gcs_uri: ::prost::alloc::string::String,
/// Number of records in this file that were successfully processed.
#[prost(int64, tag = "2")]
pub valid_record_count: i64,
/// Number of records in this file we skipped due to validate errors.
#[prost(int64, tag = "3")]
pub invalid_record_count: i64,
/// The detail information of the partial failures encountered for those
/// invalid records that couldn't be parsed.
/// Up to 50 partial errors will be reported.
#[prost(message, repeated, tag = "4")]
pub partial_errors: ::prost::alloc::vec::Vec<RecordError>,
/// Number of sparse records in this file that were successfully processed.
#[prost(int64, tag = "5")]
pub valid_sparse_record_count: i64,
/// Number of sparse records in this file we skipped due to validate errors.
#[prost(int64, tag = "6")]
pub invalid_sparse_record_count: i64,
}
}
/// Generated client implementations.
pub mod index_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for creating and managing Vertex AI's Index resources.
#[derive(Debug, Clone)]
pub struct IndexServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> IndexServiceClient<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,
) -> IndexServiceClient<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,
{
IndexServiceClient::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 an Index.
pub async fn create_index(
&mut self,
request: impl tonic::IntoRequest<super::CreateIndexRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.IndexService/CreateIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexService",
"CreateIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets an Index.
pub async fn get_index(
&mut self,
request: impl tonic::IntoRequest<super::GetIndexRequest>,
) -> std::result::Result<tonic::Response<super::Index>, 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.aiplatform.v1.IndexService/GetIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexService",
"GetIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Indexes in a Location.
pub async fn list_indexes(
&mut self,
request: impl tonic::IntoRequest<super::ListIndexesRequest>,
) -> std::result::Result<
tonic::Response<super::ListIndexesResponse>,
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.aiplatform.v1.IndexService/ListIndexes",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexService",
"ListIndexes",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an Index.
pub async fn update_index(
&mut self,
request: impl tonic::IntoRequest<super::UpdateIndexRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.IndexService/UpdateIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexService",
"UpdateIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an Index.
/// An Index can only be deleted when all its
/// [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had
/// been undeployed.
pub async fn delete_index(
&mut self,
request: impl tonic::IntoRequest<super::DeleteIndexRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.IndexService/DeleteIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexService",
"DeleteIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Add/update Datapoints into an Index.
pub async fn upsert_datapoints(
&mut self,
request: impl tonic::IntoRequest<super::UpsertDatapointsRequest>,
) -> std::result::Result<
tonic::Response<super::UpsertDatapointsResponse>,
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.aiplatform.v1.IndexService/UpsertDatapoints",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexService",
"UpsertDatapoints",
),
);
self.inner.unary(req, path, codec).await
}
/// Remove Datapoints from an Index.
pub async fn remove_datapoints(
&mut self,
request: impl tonic::IntoRequest<super::RemoveDatapointsRequest>,
) -> std::result::Result<
tonic::Response<super::RemoveDatapointsResponse>,
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.aiplatform.v1.IndexService/RemoveDatapoints",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexService",
"RemoveDatapoints",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Represents one resource that exists in automl.googleapis.com,
/// datalabeling.googleapis.com or ml.googleapis.com.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MigratableResource {
/// Output only. Timestamp when the last migration attempt on this
/// MigratableResource started. Will not be set if there's no migration attempt
/// on this MigratableResource.
#[prost(message, optional, tag = "5")]
pub last_migrate_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this MigratableResource was last updated.
#[prost(message, optional, tag = "6")]
pub last_update_time: ::core::option::Option<::prost_types::Timestamp>,
#[prost(oneof = "migratable_resource::Resource", tags = "1, 2, 3, 4")]
pub resource: ::core::option::Option<migratable_resource::Resource>,
}
/// Nested message and enum types in `MigratableResource`.
pub mod migratable_resource {
/// Represents one model Version in ml.googleapis.com.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MlEngineModelVersion {
/// The ml.googleapis.com endpoint that this model Version currently lives
/// in.
/// Example values:
///
/// * ml.googleapis.com
/// * us-centrall-ml.googleapis.com
/// * europe-west4-ml.googleapis.com
/// * asia-east1-ml.googleapis.com
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Full resource name of ml engine model Version.
/// Format: `projects/{project}/models/{model}/versions/{version}`.
#[prost(string, tag = "2")]
pub version: ::prost::alloc::string::String,
}
/// Represents one Model in automl.googleapis.com.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AutomlModel {
/// Full resource name of automl Model.
/// Format:
/// `projects/{project}/locations/{location}/models/{model}`.
#[prost(string, tag = "1")]
pub model: ::prost::alloc::string::String,
/// The Model's display name in automl.googleapis.com.
#[prost(string, tag = "3")]
pub model_display_name: ::prost::alloc::string::String,
}
/// Represents one Dataset in automl.googleapis.com.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AutomlDataset {
/// Full resource name of automl Dataset.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`.
#[prost(string, tag = "1")]
pub dataset: ::prost::alloc::string::String,
/// The Dataset's display name in automl.googleapis.com.
#[prost(string, tag = "4")]
pub dataset_display_name: ::prost::alloc::string::String,
}
/// Represents one Dataset in datalabeling.googleapis.com.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataLabelingDataset {
/// Full resource name of data labeling Dataset.
/// Format:
/// `projects/{project}/datasets/{dataset}`.
#[prost(string, tag = "1")]
pub dataset: ::prost::alloc::string::String,
/// The Dataset's display name in datalabeling.googleapis.com.
#[prost(string, tag = "4")]
pub dataset_display_name: ::prost::alloc::string::String,
/// The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to
/// the data labeling Dataset.
#[prost(message, repeated, tag = "3")]
pub data_labeling_annotated_datasets: ::prost::alloc::vec::Vec<
data_labeling_dataset::DataLabelingAnnotatedDataset,
>,
}
/// Nested message and enum types in `DataLabelingDataset`.
pub mod data_labeling_dataset {
/// Represents one AnnotatedDataset in datalabeling.googleapis.com.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataLabelingAnnotatedDataset {
/// Full resource name of data labeling AnnotatedDataset.
/// Format:
/// `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
#[prost(string, tag = "1")]
pub annotated_dataset: ::prost::alloc::string::String,
/// The AnnotatedDataset's display name in datalabeling.googleapis.com.
#[prost(string, tag = "3")]
pub annotated_dataset_display_name: ::prost::alloc::string::String,
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Resource {
/// Output only. Represents one Version in ml.googleapis.com.
#[prost(message, tag = "1")]
MlEngineModelVersion(MlEngineModelVersion),
/// Output only. Represents one Model in automl.googleapis.com.
#[prost(message, tag = "2")]
AutomlModel(AutomlModel),
/// Output only. Represents one Dataset in automl.googleapis.com.
#[prost(message, tag = "3")]
AutomlDataset(AutomlDataset),
/// Output only. Represents one Dataset in datalabeling.googleapis.com.
#[prost(message, tag = "4")]
DataLabelingDataset(DataLabelingDataset),
}
}
/// Request message for
/// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchMigratableResourcesRequest {
/// Required. The location that the migratable resources should be searched
/// from. It's the Vertex AI location that the resources can be migrated to,
/// not the resources' original location. Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard page size.
/// The default and maximum value is 100.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The standard page token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// A filter for your search. You can use the following types of filters:
///
/// * Resource type filters. The following strings filter for a specific type
/// of [MigratableResource][google.cloud.aiplatform.v1.MigratableResource]:
/// * `ml_engine_model_version:*`
/// * `automl_model:*`
/// * `automl_dataset:*`
/// * `data_labeling_dataset:*`
/// * "Migrated or not" filters. The following strings filter for resources
/// that either have or have not already been migrated:
/// * `last_migrate_time:*` filters for migrated resources.
/// * `NOT last_migrate_time:*` filters for not yet migrated resources.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
}
/// Response message for
/// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchMigratableResourcesResponse {
/// All migratable resources that can be migrated to the
/// location specified in the request.
#[prost(message, repeated, tag = "1")]
pub migratable_resources: ::prost::alloc::vec::Vec<MigratableResource>,
/// The standard next-page token.
/// The migratable_resources may not fill page_size in
/// SearchMigratableResourcesRequest even when there are subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchMigrateResourcesRequest {
/// Required. The location of the migrated resource will live in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The request messages specifying the resources to migrate.
/// They must be in the same location as the destination.
/// Up to 50 resources can be migrated in one batch.
#[prost(message, repeated, tag = "2")]
pub migrate_resource_requests: ::prost::alloc::vec::Vec<MigrateResourceRequest>,
}
/// Config of migrating one resource from automl.googleapis.com,
/// datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MigrateResourceRequest {
#[prost(oneof = "migrate_resource_request::Request", tags = "1, 2, 3, 4")]
pub request: ::core::option::Option<migrate_resource_request::Request>,
}
/// Nested message and enum types in `MigrateResourceRequest`.
pub mod migrate_resource_request {
/// Config for migrating version in ml.googleapis.com to Vertex AI's Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MigrateMlEngineModelVersionConfig {
/// Required. The ml.googleapis.com endpoint that this model version should
/// be migrated from. Example values:
///
/// * ml.googleapis.com
///
/// * us-centrall-ml.googleapis.com
///
/// * europe-west4-ml.googleapis.com
///
/// * asia-east1-ml.googleapis.com
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Required. Full resource name of ml engine model version.
/// Format: `projects/{project}/models/{model}/versions/{version}`.
#[prost(string, tag = "2")]
pub model_version: ::prost::alloc::string::String,
/// Required. Display name of the model in Vertex AI.
/// System will pick a display name if unspecified.
#[prost(string, tag = "3")]
pub model_display_name: ::prost::alloc::string::String,
}
/// Config for migrating Model in automl.googleapis.com to Vertex AI's Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MigrateAutomlModelConfig {
/// Required. Full resource name of automl Model.
/// Format:
/// `projects/{project}/locations/{location}/models/{model}`.
#[prost(string, tag = "1")]
pub model: ::prost::alloc::string::String,
/// Optional. Display name of the model in Vertex AI.
/// System will pick a display name if unspecified.
#[prost(string, tag = "2")]
pub model_display_name: ::prost::alloc::string::String,
}
/// Config for migrating Dataset in automl.googleapis.com to Vertex AI's
/// Dataset.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MigrateAutomlDatasetConfig {
/// Required. Full resource name of automl Dataset.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`.
#[prost(string, tag = "1")]
pub dataset: ::prost::alloc::string::String,
/// Required. Display name of the Dataset in Vertex AI.
/// System will pick a display name if unspecified.
#[prost(string, tag = "2")]
pub dataset_display_name: ::prost::alloc::string::String,
}
/// Config for migrating Dataset in datalabeling.googleapis.com to Vertex
/// AI's Dataset.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MigrateDataLabelingDatasetConfig {
/// Required. Full resource name of data labeling Dataset.
/// Format:
/// `projects/{project}/datasets/{dataset}`.
#[prost(string, tag = "1")]
pub dataset: ::prost::alloc::string::String,
/// Optional. Display name of the Dataset in Vertex AI.
/// System will pick a display name if unspecified.
#[prost(string, tag = "2")]
pub dataset_display_name: ::prost::alloc::string::String,
/// Optional. Configs for migrating AnnotatedDataset in
/// datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified
/// AnnotatedDatasets have to belong to the datalabeling Dataset.
#[prost(message, repeated, tag = "3")]
pub migrate_data_labeling_annotated_dataset_configs: ::prost::alloc::vec::Vec<
migrate_data_labeling_dataset_config::MigrateDataLabelingAnnotatedDatasetConfig,
>,
}
/// Nested message and enum types in `MigrateDataLabelingDatasetConfig`.
pub mod migrate_data_labeling_dataset_config {
/// Config for migrating AnnotatedDataset in datalabeling.googleapis.com to
/// Vertex AI's SavedQuery.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MigrateDataLabelingAnnotatedDatasetConfig {
/// Required. Full resource name of data labeling AnnotatedDataset.
/// Format:
/// `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
#[prost(string, tag = "1")]
pub annotated_dataset: ::prost::alloc::string::String,
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Request {
/// Config for migrating Version in ml.googleapis.com to Vertex AI's Model.
#[prost(message, tag = "1")]
MigrateMlEngineModelVersionConfig(MigrateMlEngineModelVersionConfig),
/// Config for migrating Model in automl.googleapis.com to Vertex AI's
/// Model.
#[prost(message, tag = "2")]
MigrateAutomlModelConfig(MigrateAutomlModelConfig),
/// Config for migrating Dataset in automl.googleapis.com to Vertex AI's
/// Dataset.
#[prost(message, tag = "3")]
MigrateAutomlDatasetConfig(MigrateAutomlDatasetConfig),
/// Config for migrating Dataset in datalabeling.googleapis.com to
/// Vertex AI's Dataset.
#[prost(message, tag = "4")]
MigrateDataLabelingDatasetConfig(MigrateDataLabelingDatasetConfig),
}
}
/// Response message for
/// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchMigrateResourcesResponse {
/// Successfully migrated resources.
#[prost(message, repeated, tag = "1")]
pub migrate_resource_responses: ::prost::alloc::vec::Vec<MigrateResourceResponse>,
}
/// Describes a successfully migrated resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MigrateResourceResponse {
/// Before migration, the identifier in ml.googleapis.com,
/// automl.googleapis.com or datalabeling.googleapis.com.
#[prost(message, optional, tag = "3")]
pub migratable_resource: ::core::option::Option<MigratableResource>,
/// After migration, the resource name in Vertex AI.
#[prost(oneof = "migrate_resource_response::MigratedResource", tags = "1, 2")]
pub migrated_resource: ::core::option::Option<
migrate_resource_response::MigratedResource,
>,
}
/// Nested message and enum types in `MigrateResourceResponse`.
pub mod migrate_resource_response {
/// After migration, the resource name in Vertex AI.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum MigratedResource {
/// Migrated Dataset's resource name.
#[prost(string, tag = "1")]
Dataset(::prost::alloc::string::String),
/// Migrated Model's resource name.
#[prost(string, tag = "2")]
Model(::prost::alloc::string::String),
}
}
/// Runtime operation information for
/// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchMigrateResourcesOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// Partial results that reflect the latest migration operation progress.
#[prost(message, repeated, tag = "2")]
pub partial_results: ::prost::alloc::vec::Vec<
batch_migrate_resources_operation_metadata::PartialResult,
>,
}
/// Nested message and enum types in `BatchMigrateResourcesOperationMetadata`.
pub mod batch_migrate_resources_operation_metadata {
/// Represents a partial result in batch migration operation for one
/// [MigrateResourceRequest][google.cloud.aiplatform.v1.MigrateResourceRequest].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PartialResult {
/// It's the same as the value in
/// [MigrateResourceRequest.migrate_resource_requests][].
#[prost(message, optional, tag = "1")]
pub request: ::core::option::Option<super::MigrateResourceRequest>,
/// If the resource's migration is ongoing, none of the result will be set.
/// If the resource's migration is finished, either error or one of the
/// migrated resource name will be filled.
#[prost(oneof = "partial_result::Result", tags = "2, 3, 4")]
pub result: ::core::option::Option<partial_result::Result>,
}
/// Nested message and enum types in `PartialResult`.
pub mod partial_result {
/// If the resource's migration is ongoing, none of the result will be set.
/// If the resource's migration is finished, either error or one of the
/// migrated resource name will be filled.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Result {
/// The error result of the migration request in case of failure.
#[prost(message, tag = "2")]
Error(super::super::super::super::super::rpc::Status),
/// Migrated model resource name.
#[prost(string, tag = "3")]
Model(::prost::alloc::string::String),
/// Migrated dataset resource name.
#[prost(string, tag = "4")]
Dataset(::prost::alloc::string::String),
}
}
}
/// Generated client implementations.
pub mod migration_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service that migrates resources from automl.googleapis.com,
/// datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
#[derive(Debug, Clone)]
pub struct MigrationServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> MigrationServiceClient<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,
) -> MigrationServiceClient<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,
{
MigrationServiceClient::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 all of the resources in automl.googleapis.com,
/// datalabeling.googleapis.com and ml.googleapis.com that can be migrated to
/// Vertex AI's given location.
pub async fn search_migratable_resources(
&mut self,
request: impl tonic::IntoRequest<super::SearchMigratableResourcesRequest>,
) -> std::result::Result<
tonic::Response<super::SearchMigratableResourcesResponse>,
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.aiplatform.v1.MigrationService/SearchMigratableResources",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MigrationService",
"SearchMigratableResources",
),
);
self.inner.unary(req, path, codec).await
}
/// Batch migrates resources from ml.googleapis.com, automl.googleapis.com,
/// and datalabeling.googleapis.com to Vertex AI.
pub async fn batch_migrate_resources(
&mut self,
request: impl tonic::IntoRequest<super::BatchMigrateResourcesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MigrationService/BatchMigrateResources",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MigrationService",
"BatchMigrateResources",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Represents long-lasting resources that are dedicated to users to runs custom
/// workloads.
/// A PersistentResource can have multiple node pools and each node
/// pool can have its own machine spec.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PersistentResource {
/// Immutable. Resource name of a PersistentResource.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The display name of the PersistentResource.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. The spec of the pools of different resources.
#[prost(message, repeated, tag = "4")]
pub resource_pools: ::prost::alloc::vec::Vec<ResourcePool>,
/// Output only. The detailed state of a Study.
#[prost(enumeration = "persistent_resource::State", tag = "5")]
pub state: i32,
/// Output only. Only populated when persistent resource's state is `STOPPING`
/// or `ERROR`.
#[prost(message, optional, tag = "6")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// Output only. Time when the PersistentResource was created.
#[prost(message, optional, tag = "7")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the PersistentResource for the first time entered
/// the `RUNNING` state.
#[prost(message, optional, tag = "8")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the PersistentResource was most recently updated.
#[prost(message, optional, tag = "9")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. The labels with user-defined metadata to organize
/// PersistentResource.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "10")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. The full name of the Compute Engine
/// [network](/compute/docs/networks-and-firewalls#networks) to peered with
/// Vertex AI to host the persistent resources.
/// For example, `projects/12345/global/networks/myVPC`.
/// [Format](/compute/docs/reference/rest/v1/networks/insert)
/// is of the form `projects/{project}/global/networks/{network}`.
/// Where {project} is a project number, as in `12345`, and {network} is a
/// network name.
///
/// To specify this field, you must have already [configured VPC Network
/// Peering for Vertex
/// AI](<https://cloud.google.com/vertex-ai/docs/general/vpc-peering>).
///
/// If this field is left unspecified, the resources aren't peered with any
/// network.
#[prost(string, tag = "11")]
pub network: ::prost::alloc::string::String,
/// Optional. Customer-managed encryption key spec for a PersistentResource.
/// If set, this PersistentResource and all sub-resources of this
/// PersistentResource will be secured by this key.
#[prost(message, optional, tag = "12")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Optional. Persistent Resource runtime spec.
/// For example, used for Ray cluster configuration.
#[prost(message, optional, tag = "13")]
pub resource_runtime_spec: ::core::option::Option<ResourceRuntimeSpec>,
/// Output only. Runtime information of the Persistent Resource.
#[prost(message, optional, tag = "14")]
pub resource_runtime: ::core::option::Option<ResourceRuntime>,
/// Optional. A list of names for the reserved IP ranges under the VPC network
/// that can be used for this persistent resource.
///
/// If set, we will deploy the persistent resource within the provided IP
/// ranges. Otherwise, the persistent resource is deployed to any IP
/// ranges under the provided VPC network.
///
/// Example: \['vertex-ai-ip-range'\].
#[prost(string, repeated, tag = "15")]
pub reserved_ip_ranges: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Nested message and enum types in `PersistentResource`.
pub mod persistent_resource {
/// Describes the PersistentResource state.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Not set.
Unspecified = 0,
/// The PROVISIONING state indicates the persistent resources is being
/// created.
Provisioning = 1,
/// The RUNNING state indicates the persistent resource is healthy and fully
/// usable.
Running = 3,
/// The STOPPING state indicates the persistent resource is being deleted.
Stopping = 4,
/// The ERROR state indicates the persistent resource may be unusable.
/// Details can be found in the `error` field.
Error = 5,
/// The REBOOTING state indicates the persistent resource is being rebooted
/// (PR is not available right now but is expected to be ready again later).
Rebooting = 6,
/// The UPDATING state indicates the persistent resource is being updated.
Updating = 7,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Provisioning => "PROVISIONING",
State::Running => "RUNNING",
State::Stopping => "STOPPING",
State::Error => "ERROR",
State::Rebooting => "REBOOTING",
State::Updating => "UPDATING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"PROVISIONING" => Some(Self::Provisioning),
"RUNNING" => Some(Self::Running),
"STOPPING" => Some(Self::Stopping),
"ERROR" => Some(Self::Error),
"REBOOTING" => Some(Self::Rebooting),
"UPDATING" => Some(Self::Updating),
_ => None,
}
}
}
}
/// Represents the spec of a group of resources of the same type,
/// for example machine type, disk, and accelerators, in a PersistentResource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResourcePool {
/// Immutable. The unique ID in a PersistentResource for referring to this
/// resource pool. User can specify it if necessary. Otherwise, it's generated
/// automatically.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Required. Immutable. The specification of a single machine.
#[prost(message, optional, tag = "2")]
pub machine_spec: ::core::option::Option<MachineSpec>,
/// Optional. The total number of machines to use for this resource pool.
#[prost(int64, optional, tag = "3")]
pub replica_count: ::core::option::Option<i64>,
/// Optional. Disk spec for the machine in this node pool.
#[prost(message, optional, tag = "4")]
pub disk_spec: ::core::option::Option<DiskSpec>,
/// Output only. The number of machines currently in use by training jobs for
/// this resource pool. Will replace idle_replica_count.
#[prost(int64, tag = "6")]
pub used_replica_count: i64,
/// Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
#[prost(message, optional, tag = "7")]
pub autoscaling_spec: ::core::option::Option<resource_pool::AutoscalingSpec>,
}
/// Nested message and enum types in `ResourcePool`.
pub mod resource_pool {
/// The min/max number of replicas allowed if enabling autoscaling
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AutoscalingSpec {
/// Optional. min replicas in the node pool,
/// must be ≤ replica_count and < max_replica_count or will throw error.
/// For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a
/// resource_pool to be 0 to match the OSS Ray
/// behavior(<https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters>).
/// As for Persistent Resource, the min_replica_count must be > 0, we added
/// a corresponding validation inside
/// CreatePersistentResourceRequestValidator.java.
#[prost(int64, optional, tag = "1")]
pub min_replica_count: ::core::option::Option<i64>,
/// Optional. max replicas in the node pool,
/// must be ≥ replica_count and > min_replica_count or will throw error
#[prost(int64, optional, tag = "2")]
pub max_replica_count: ::core::option::Option<i64>,
}
}
/// Configuration for the runtime on a PersistentResource instance, including
/// but not limited to:
///
/// * Service accounts used to run the workloads.
/// * Whether to make it a dedicated Ray Cluster.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResourceRuntimeSpec {
/// Optional. Configure the use of workload identity on the PersistentResource
#[prost(message, optional, tag = "2")]
pub service_account_spec: ::core::option::Option<ServiceAccountSpec>,
/// Optional. Ray cluster configuration.
/// Required when creating a dedicated RayCluster on the PersistentResource.
#[prost(message, optional, tag = "1")]
pub ray_spec: ::core::option::Option<RaySpec>,
}
/// Configuration information for the Ray cluster.
/// For experimental launch, Ray cluster creation and Persistent
/// cluster creation are 1:1 mapping: We will provision all the nodes within the
/// Persistent cluster as Ray nodes.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RaySpec {
/// Optional. Default image for user to choose a preferred ML framework
/// (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt
/// images](<https://cloud.google.com/vertex-ai/docs/training/pre-built-containers>).
/// Either this or the resource_pool_images is required. Use this field if
/// you need all the resource pools to have the same Ray image. Otherwise, use
/// the {@code resource_pool_images} field.
#[prost(string, tag = "1")]
pub image_uri: ::prost::alloc::string::String,
/// Optional. Required if image_uri isn't set. A map of resource_pool_id to
/// prebuild Ray image if user need to use different images for different
/// head/worker pools. This map needs to cover all the resource pool ids.
/// Example:
/// {
/// "ray_head_node_pool": "head image"
/// "ray_worker_node_pool1": "worker image"
/// "ray_worker_node_pool2": "another worker image"
/// }
#[prost(btree_map = "string, string", tag = "6")]
pub resource_pool_images: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. This will be used to indicate which resource pool will serve as
/// the Ray head node(the first node within that pool). Will use the machine
/// from the first workerpool as the head node by default if this field isn't
/// set.
#[prost(string, tag = "7")]
pub head_node_resource_pool_id: ::prost::alloc::string::String,
/// Optional. Ray metrics configurations.
#[prost(message, optional, tag = "8")]
pub ray_metric_spec: ::core::option::Option<RayMetricSpec>,
/// Optional. OSS Ray logging configurations.
#[prost(message, optional, tag = "10")]
pub ray_logs_spec: ::core::option::Option<RayLogsSpec>,
}
/// Persistent Cluster runtime information as output
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResourceRuntime {
/// Output only. URIs for user to connect to the Cluster.
/// Example:
/// {
/// "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001"
/// "RAY_DASHBOARD_URI": "ray-dashboard-address:8888"
/// }
#[prost(btree_map = "string, string", tag = "1")]
pub access_uris: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
}
/// Configuration for the use of custom service account to run the workloads.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ServiceAccountSpec {
/// Required. If true, custom user-managed service account is enforced to run
/// any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses
/// the [Vertex AI Custom Code Service
/// Agent](<https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents>).
#[prost(bool, tag = "1")]
pub enable_custom_service_account: bool,
/// Optional. Required when all below conditions are met
/// * `enable_custom_service_account` is true;
/// * any runtime is specified via `ResourceRuntimeSpec` on creation time,
/// for example, Ray
///
/// The users must have `iam.serviceAccounts.actAs` permission on this service
/// account and then the specified runtime containers will run as it.
///
/// Do not set this field if you want to submit jobs using custom service
/// account to this PersistentResource after creation, but only specify the
/// `service_account` inside the job.
#[prost(string, tag = "2")]
pub service_account: ::prost::alloc::string::String,
}
/// Configuration for the Ray metrics.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RayMetricSpec {
/// Optional. Flag to disable the Ray metrics collection.
#[prost(bool, tag = "1")]
pub disabled: bool,
}
/// Configuration for the Ray OSS Logs.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RayLogsSpec {
/// Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.
#[prost(bool, tag = "1")]
pub disabled: bool,
}
/// Request message for
/// [PersistentResourceService.CreatePersistentResource][google.cloud.aiplatform.v1.PersistentResourceService.CreatePersistentResource].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreatePersistentResourceRequest {
/// Required. The resource name of the Location to create the
/// PersistentResource in. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The PersistentResource to create.
#[prost(message, optional, tag = "2")]
pub persistent_resource: ::core::option::Option<PersistentResource>,
/// Required. The ID to use for the PersistentResource, which become the final
/// component of the PersistentResource's resource name.
///
/// The maximum length is 63 characters, and valid characters
/// are `/^[a-z](\[a-z0-9-\]{0,61}\[a-z0-9\])?$/`.
#[prost(string, tag = "3")]
pub persistent_resource_id: ::prost::alloc::string::String,
}
/// Details of operations that perform create PersistentResource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreatePersistentResourceOperationMetadata {
/// Operation metadata for PersistentResource.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// Progress Message for Create LRO
#[prost(string, tag = "2")]
pub progress_message: ::prost::alloc::string::String,
}
/// Details of operations that perform update PersistentResource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdatePersistentResourceOperationMetadata {
/// Operation metadata for PersistentResource.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// Progress Message for Update LRO
#[prost(string, tag = "2")]
pub progress_message: ::prost::alloc::string::String,
}
/// Details of operations that perform reboot PersistentResource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RebootPersistentResourceOperationMetadata {
/// Operation metadata for PersistentResource.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// Progress Message for Reboot LRO
#[prost(string, tag = "2")]
pub progress_message: ::prost::alloc::string::String,
}
/// Request message for
/// [PersistentResourceService.GetPersistentResource][google.cloud.aiplatform.v1.PersistentResourceService.GetPersistentResource].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPersistentResourceRequest {
/// Required. The name of the PersistentResource resource.
/// Format:
/// `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for [PersistentResourceService.ListPersistentResource][].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPersistentResourcesRequest {
/// Required. The resource name of the Location to list the PersistentResources
/// from. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. The standard list page token.
/// Typically obtained via
/// [ListPersistentResourceResponse.next_page_token][] of the previous
/// [PersistentResourceService.ListPersistentResource][] call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [PersistentResourceService.ListPersistentResources][google.cloud.aiplatform.v1.PersistentResourceService.ListPersistentResources]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPersistentResourcesResponse {
#[prost(message, repeated, tag = "1")]
pub persistent_resources: ::prost::alloc::vec::Vec<PersistentResource>,
/// A token to retrieve next page of results.
/// Pass to
/// [ListPersistentResourcesRequest.page_token][google.cloud.aiplatform.v1.ListPersistentResourcesRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [PersistentResourceService.DeletePersistentResource][google.cloud.aiplatform.v1.PersistentResourceService.DeletePersistentResource].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeletePersistentResourceRequest {
/// Required. The name of the PersistentResource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for UpdatePersistentResource method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdatePersistentResourceRequest {
/// Required. The PersistentResource to update.
///
/// The PersistentResource's `name` field is used to identify the
/// PersistentResource to update. Format:
/// `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
#[prost(message, optional, tag = "1")]
pub persistent_resource: ::core::option::Option<PersistentResource>,
/// Required. Specify the fields to be overwritten in the PersistentResource by
/// the update method.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [PersistentResourceService.RebootPersistentResource][google.cloud.aiplatform.v1.PersistentResourceService.RebootPersistentResource].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RebootPersistentResourceRequest {
/// Required. The name of the PersistentResource resource.
/// Format:
/// `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod persistent_resource_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for managing Vertex AI's machine learning PersistentResource.
#[derive(Debug, Clone)]
pub struct PersistentResourceServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> PersistentResourceServiceClient<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,
) -> PersistentResourceServiceClient<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,
{
PersistentResourceServiceClient::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 PersistentResource.
pub async fn create_persistent_resource(
&mut self,
request: impl tonic::IntoRequest<super::CreatePersistentResourceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.PersistentResourceService/CreatePersistentResource",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PersistentResourceService",
"CreatePersistentResource",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a PersistentResource.
pub async fn get_persistent_resource(
&mut self,
request: impl tonic::IntoRequest<super::GetPersistentResourceRequest>,
) -> std::result::Result<
tonic::Response<super::PersistentResource>,
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.aiplatform.v1.PersistentResourceService/GetPersistentResource",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PersistentResourceService",
"GetPersistentResource",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists PersistentResources in a Location.
pub async fn list_persistent_resources(
&mut self,
request: impl tonic::IntoRequest<super::ListPersistentResourcesRequest>,
) -> std::result::Result<
tonic::Response<super::ListPersistentResourcesResponse>,
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.aiplatform.v1.PersistentResourceService/ListPersistentResources",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PersistentResourceService",
"ListPersistentResources",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a PersistentResource.
pub async fn delete_persistent_resource(
&mut self,
request: impl tonic::IntoRequest<super::DeletePersistentResourceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.PersistentResourceService/DeletePersistentResource",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PersistentResourceService",
"DeletePersistentResource",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a PersistentResource.
pub async fn update_persistent_resource(
&mut self,
request: impl tonic::IntoRequest<super::UpdatePersistentResourceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.PersistentResourceService/UpdatePersistentResource",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PersistentResourceService",
"UpdatePersistentResource",
),
);
self.inner.unary(req, path, codec).await
}
/// Reboots a PersistentResource.
pub async fn reboot_persistent_resource(
&mut self,
request: impl tonic::IntoRequest<super::RebootPersistentResourceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.PersistentResourceService/RebootPersistentResource",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PersistentResourceService",
"RebootPersistentResource",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for
/// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Required. The instances that are the input to the prediction call.
/// A DeployedModel may have an upper limit on the number of instances it
/// supports per request, and when it is exceeded the prediction call errors
/// in case of AutoML Models, or, in case of customer created Models, the
/// behaviour is as documented by that Model.
/// The schema of any single instance may be specified via Endpoint's
/// DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// The parameters that govern the prediction. The schema of the parameters may
/// be specified via Endpoint's DeployedModels' [Model's
/// ][google.cloud.aiplatform.v1.DeployedModel.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
#[prost(message, optional, tag = "3")]
pub parameters: ::core::option::Option<::prost_types::Value>,
}
/// Response message for
/// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PredictResponse {
/// The predictions that are the output of the predictions call.
/// The schema of any single prediction may be specified via Endpoint's
/// DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
#[prost(message, repeated, tag = "1")]
pub predictions: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// ID of the Endpoint's DeployedModel that served this prediction.
#[prost(string, tag = "2")]
pub deployed_model_id: ::prost::alloc::string::String,
/// Output only. The resource name of the Model which is deployed as the
/// DeployedModel that this prediction hits.
#[prost(string, tag = "3")]
pub model: ::prost::alloc::string::String,
/// Output only. The version ID of the Model which is deployed as the
/// DeployedModel that this prediction hits.
#[prost(string, tag = "5")]
pub model_version_id: ::prost::alloc::string::String,
/// Output only. The [display
/// name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is
/// deployed as the DeployedModel that this prediction hits.
#[prost(string, tag = "4")]
pub model_display_name: ::prost::alloc::string::String,
/// Output only. Request-level metadata returned by the model. The metadata
/// type will be dependent upon the model implementation.
#[prost(message, optional, tag = "6")]
pub metadata: ::core::option::Option<::prost_types::Value>,
}
/// Request message for
/// [PredictionService.RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RawPredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// The prediction input. Supports HTTP headers and arbitrary data payload.
///
/// A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an
/// upper limit on the number of instances it supports per request. When this
/// limit it is exceeded for an AutoML model, the
/// [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict]
/// method returns an error. When this limit is exceeded for a custom-trained
/// model, the behavior varies depending on the model.
///
/// You can specify the schema for each instance in the
/// [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
/// field when you create a [Model][google.cloud.aiplatform.v1.Model]. This
/// schema applies when you deploy the `Model` as a `DeployedModel` to an
/// [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict`
/// method.
#[prost(message, optional, tag = "2")]
pub http_body: ::core::option::Option<super::super::super::api::HttpBody>,
}
/// Request message for
/// [PredictionService.StreamRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamRawPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamRawPredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// The prediction input. Supports HTTP headers and arbitrary data payload.
#[prost(message, optional, tag = "2")]
pub http_body: ::core::option::Option<super::super::super::api::HttpBody>,
}
/// Request message for
/// [PredictionService.DirectPredict][google.cloud.aiplatform.v1.PredictionService.DirectPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DirectPredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// The prediction input.
#[prost(message, repeated, tag = "2")]
pub inputs: ::prost::alloc::vec::Vec<Tensor>,
/// The parameters that govern the prediction.
#[prost(message, optional, tag = "3")]
pub parameters: ::core::option::Option<Tensor>,
}
/// Response message for
/// [PredictionService.DirectPredict][google.cloud.aiplatform.v1.PredictionService.DirectPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DirectPredictResponse {
/// The prediction output.
#[prost(message, repeated, tag = "1")]
pub outputs: ::prost::alloc::vec::Vec<Tensor>,
/// The parameters that govern the prediction.
#[prost(message, optional, tag = "2")]
pub parameters: ::core::option::Option<Tensor>,
}
/// Request message for
/// [PredictionService.DirectRawPredict][google.cloud.aiplatform.v1.PredictionService.DirectRawPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DirectRawPredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Fully qualified name of the API method being invoked to perform
/// predictions.
///
/// Format:
/// `/namespace.Service/Method/`
/// Example:
/// `/tensorflow.serving.PredictionService/Predict`
#[prost(string, tag = "2")]
pub method_name: ::prost::alloc::string::String,
/// The prediction input.
#[prost(bytes = "bytes", tag = "3")]
pub input: ::prost::bytes::Bytes,
}
/// Response message for
/// [PredictionService.DirectRawPredict][google.cloud.aiplatform.v1.PredictionService.DirectRawPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DirectRawPredictResponse {
/// The prediction output.
#[prost(bytes = "bytes", tag = "1")]
pub output: ::prost::bytes::Bytes,
}
/// Request message for
/// [PredictionService.StreamDirectPredict][google.cloud.aiplatform.v1.PredictionService.StreamDirectPredict].
///
/// The first message must contain
/// [endpoint][google.cloud.aiplatform.v1.StreamDirectPredictRequest.endpoint]
/// field and optionally [input][]. The subsequent messages must contain
/// [input][].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamDirectPredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Optional. The prediction input.
#[prost(message, repeated, tag = "2")]
pub inputs: ::prost::alloc::vec::Vec<Tensor>,
/// Optional. The parameters that govern the prediction.
#[prost(message, optional, tag = "3")]
pub parameters: ::core::option::Option<Tensor>,
}
/// Response message for
/// [PredictionService.StreamDirectPredict][google.cloud.aiplatform.v1.PredictionService.StreamDirectPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamDirectPredictResponse {
/// The prediction output.
#[prost(message, repeated, tag = "1")]
pub outputs: ::prost::alloc::vec::Vec<Tensor>,
/// The parameters that govern the prediction.
#[prost(message, optional, tag = "2")]
pub parameters: ::core::option::Option<Tensor>,
}
/// Request message for
/// [PredictionService.StreamDirectRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamDirectRawPredict].
///
/// The first message must contain
/// [endpoint][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.endpoint]
/// and
/// [method_name][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.method_name]
/// fields and optionally
/// [input][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.input]. The
/// subsequent messages must contain
/// [input][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.input].
/// [method_name][google.cloud.aiplatform.v1.StreamDirectRawPredictRequest.method_name]
/// in the subsequent messages have no effect.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamDirectRawPredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Optional. Fully qualified name of the API method being invoked to perform
/// predictions.
///
/// Format:
/// `/namespace.Service/Method/`
/// Example:
/// `/tensorflow.serving.PredictionService/Predict`
#[prost(string, tag = "2")]
pub method_name: ::prost::alloc::string::String,
/// Optional. The prediction input.
#[prost(bytes = "bytes", tag = "3")]
pub input: ::prost::bytes::Bytes,
}
/// Response message for
/// [PredictionService.StreamDirectRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamDirectRawPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamDirectRawPredictResponse {
/// The prediction output.
#[prost(bytes = "bytes", tag = "1")]
pub output: ::prost::bytes::Bytes,
}
/// Request message for
/// [PredictionService.StreamingPredict][google.cloud.aiplatform.v1.PredictionService.StreamingPredict].
///
/// The first message must contain
/// [endpoint][google.cloud.aiplatform.v1.StreamingPredictRequest.endpoint] field
/// and optionally [input][]. The subsequent messages must contain [input][].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingPredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// The prediction input.
#[prost(message, repeated, tag = "2")]
pub inputs: ::prost::alloc::vec::Vec<Tensor>,
/// The parameters that govern the prediction.
#[prost(message, optional, tag = "3")]
pub parameters: ::core::option::Option<Tensor>,
}
/// Response message for
/// [PredictionService.StreamingPredict][google.cloud.aiplatform.v1.PredictionService.StreamingPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingPredictResponse {
/// The prediction output.
#[prost(message, repeated, tag = "1")]
pub outputs: ::prost::alloc::vec::Vec<Tensor>,
/// The parameters that govern the prediction.
#[prost(message, optional, tag = "2")]
pub parameters: ::core::option::Option<Tensor>,
}
/// Request message for
/// [PredictionService.StreamingRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamingRawPredict].
///
/// The first message must contain
/// [endpoint][google.cloud.aiplatform.v1.StreamingRawPredictRequest.endpoint]
/// and
/// [method_name][google.cloud.aiplatform.v1.StreamingRawPredictRequest.method_name]
/// fields and optionally
/// [input][google.cloud.aiplatform.v1.StreamingRawPredictRequest.input]. The
/// subsequent messages must contain
/// [input][google.cloud.aiplatform.v1.StreamingRawPredictRequest.input].
/// [method_name][google.cloud.aiplatform.v1.StreamingRawPredictRequest.method_name]
/// in the subsequent messages have no effect.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingRawPredictRequest {
/// Required. The name of the Endpoint requested to serve the prediction.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Fully qualified name of the API method being invoked to perform
/// predictions.
///
/// Format:
/// `/namespace.Service/Method/`
/// Example:
/// `/tensorflow.serving.PredictionService/Predict`
#[prost(string, tag = "2")]
pub method_name: ::prost::alloc::string::String,
/// The prediction input.
#[prost(bytes = "bytes", tag = "3")]
pub input: ::prost::bytes::Bytes,
}
/// Response message for
/// [PredictionService.StreamingRawPredict][google.cloud.aiplatform.v1.PredictionService.StreamingRawPredict].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingRawPredictResponse {
/// The prediction output.
#[prost(bytes = "bytes", tag = "1")]
pub output: ::prost::bytes::Bytes,
}
/// Request message for
/// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplainRequest {
/// Required. The name of the Endpoint requested to serve the explanation.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Required. The instances that are the input to the explanation call.
/// A DeployedModel may have an upper limit on the number of instances it
/// supports per request, and when it is exceeded the explanation call errors
/// in case of AutoML Models, or, in case of customer created Models, the
/// behaviour is as documented by that Model.
/// The schema of any single instance may be specified via Endpoint's
/// DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// The parameters that govern the prediction. The schema of the parameters may
/// be specified via Endpoint's DeployedModels' [Model's
/// ][google.cloud.aiplatform.v1.DeployedModel.model]
/// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
/// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
#[prost(message, optional, tag = "4")]
pub parameters: ::core::option::Option<::prost_types::Value>,
/// If specified, overrides the
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
/// of the DeployedModel. Can be used for explaining prediction results with
/// different configurations, such as:
/// - Explaining top-5 predictions results as opposed to top-1;
/// - Increasing path count or step count of the attribution methods to reduce
/// approximate errors;
/// - Using different baselines for explaining the prediction results.
#[prost(message, optional, tag = "5")]
pub explanation_spec_override: ::core::option::Option<ExplanationSpecOverride>,
/// If specified, this ExplainRequest will be served by the chosen
/// DeployedModel, overriding
/// [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
#[prost(string, tag = "3")]
pub deployed_model_id: ::prost::alloc::string::String,
}
/// Response message for
/// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplainResponse {
/// The explanations of the Model's
/// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
///
/// It has the same number of elements as
/// [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be
/// explained.
#[prost(message, repeated, tag = "1")]
pub explanations: ::prost::alloc::vec::Vec<Explanation>,
/// ID of the Endpoint's DeployedModel that served this explanation.
#[prost(string, tag = "2")]
pub deployed_model_id: ::prost::alloc::string::String,
/// The predictions that are the output of the predictions call.
/// Same as
/// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
#[prost(message, repeated, tag = "3")]
pub predictions: ::prost::alloc::vec::Vec<::prost_types::Value>,
}
/// Request message for [PredictionService.CountTokens][].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CountTokensRequest {
/// Required. The name of the Endpoint requested to perform token counting.
/// Format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Optional. The name of the publisher model requested to serve the
/// prediction. Format:
/// `projects/{project}/locations/{location}/publishers/*/models/*`
#[prost(string, tag = "3")]
pub model: ::prost::alloc::string::String,
/// Optional. The instances that are the input to token counting call.
/// Schema is identical to the prediction schema of the underlying model.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// Optional. Input content.
#[prost(message, repeated, tag = "4")]
pub contents: ::prost::alloc::vec::Vec<Content>,
/// Optional. The user provided system instructions for the model.
/// Note: only text should be used in parts and content in each part will be in
/// a separate paragraph.
#[prost(message, optional, tag = "5")]
pub system_instruction: ::core::option::Option<Content>,
/// Optional. A list of `Tools` the model may use to generate the next
/// response.
///
/// A `Tool` is a piece of code that enables the system to interact with
/// external systems to perform an action, or set of actions, outside of
/// knowledge and scope of the model.
#[prost(message, repeated, tag = "6")]
pub tools: ::prost::alloc::vec::Vec<Tool>,
}
/// Response message for [PredictionService.CountTokens][].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CountTokensResponse {
/// The total number of tokens counted across all instances from the request.
#[prost(int32, tag = "1")]
pub total_tokens: i32,
/// The total number of billable characters counted across all instances from
/// the request.
#[prost(int32, tag = "2")]
pub total_billable_characters: i32,
}
/// Request message for \[PredictionService.GenerateContent\].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GenerateContentRequest {
/// Required. The fully qualified name of the publisher model or tuned model
/// endpoint to use.
///
/// Publisher model format:
/// `projects/{project}/locations/{location}/publishers/*/models/*`
///
/// Tuned model endpoint format:
/// `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "5")]
pub model: ::prost::alloc::string::String,
/// Required. The content of the current conversation with the model.
///
/// For single-turn queries, this is a single instance. For multi-turn queries,
/// this is a repeated field that contains conversation history + latest
/// request.
#[prost(message, repeated, tag = "2")]
pub contents: ::prost::alloc::vec::Vec<Content>,
/// Optional. The user provided system instructions for the model.
/// Note: only text should be used in parts and content in each part will be in
/// a separate paragraph.
#[prost(message, optional, tag = "8")]
pub system_instruction: ::core::option::Option<Content>,
/// Optional. A list of `Tools` the model may use to generate the next
/// response.
///
/// A `Tool` is a piece of code that enables the system to interact with
/// external systems to perform an action, or set of actions, outside of
/// knowledge and scope of the model.
#[prost(message, repeated, tag = "6")]
pub tools: ::prost::alloc::vec::Vec<Tool>,
/// Optional. Tool config. This config is shared for all tools provided in the
/// request.
#[prost(message, optional, tag = "7")]
pub tool_config: ::core::option::Option<ToolConfig>,
/// Optional. Per request settings for blocking unsafe content.
/// Enforced on GenerateContentResponse.candidates.
#[prost(message, repeated, tag = "3")]
pub safety_settings: ::prost::alloc::vec::Vec<SafetySetting>,
/// Optional. Generation config.
#[prost(message, optional, tag = "4")]
pub generation_config: ::core::option::Option<GenerationConfig>,
}
/// Response message for \[PredictionService.GenerateContent\].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GenerateContentResponse {
/// Output only. Generated candidates.
#[prost(message, repeated, tag = "2")]
pub candidates: ::prost::alloc::vec::Vec<Candidate>,
/// Output only. Content filter results for a prompt sent in the request.
/// Note: Sent only in the first stream chunk.
/// Only happens when no candidates were generated due to content violations.
#[prost(message, optional, tag = "3")]
pub prompt_feedback: ::core::option::Option<
generate_content_response::PromptFeedback,
>,
/// Usage metadata about the response(s).
#[prost(message, optional, tag = "4")]
pub usage_metadata: ::core::option::Option<generate_content_response::UsageMetadata>,
}
/// Nested message and enum types in `GenerateContentResponse`.
pub mod generate_content_response {
/// Content filter results for a prompt sent in the request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PromptFeedback {
/// Output only. Blocked reason.
#[prost(enumeration = "prompt_feedback::BlockedReason", tag = "1")]
pub block_reason: i32,
/// Output only. Safety ratings.
#[prost(message, repeated, tag = "2")]
pub safety_ratings: ::prost::alloc::vec::Vec<super::SafetyRating>,
/// Output only. A readable block reason message.
#[prost(string, tag = "3")]
pub block_reason_message: ::prost::alloc::string::String,
}
/// Nested message and enum types in `PromptFeedback`.
pub mod prompt_feedback {
/// Blocked reason enumeration.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum BlockedReason {
/// Unspecified blocked reason.
Unspecified = 0,
/// Candidates blocked due to safety.
Safety = 1,
/// Candidates blocked due to other reason.
Other = 2,
/// Candidates blocked due to the terms which are included from the
/// terminology blocklist.
Blocklist = 3,
/// Candidates blocked due to prohibited content.
ProhibitedContent = 4,
}
impl BlockedReason {
/// 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 {
BlockedReason::Unspecified => "BLOCKED_REASON_UNSPECIFIED",
BlockedReason::Safety => "SAFETY",
BlockedReason::Other => "OTHER",
BlockedReason::Blocklist => "BLOCKLIST",
BlockedReason::ProhibitedContent => "PROHIBITED_CONTENT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"BLOCKED_REASON_UNSPECIFIED" => Some(Self::Unspecified),
"SAFETY" => Some(Self::Safety),
"OTHER" => Some(Self::Other),
"BLOCKLIST" => Some(Self::Blocklist),
"PROHIBITED_CONTENT" => Some(Self::ProhibitedContent),
_ => None,
}
}
}
}
/// Usage metadata about response(s).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UsageMetadata {
/// Number of tokens in the request. When `cached_content` is set, this is
/// still the total effective prompt size meaning this includes the number of
/// tokens in the cached content.
#[prost(int32, tag = "1")]
pub prompt_token_count: i32,
/// Number of tokens in the response(s).
#[prost(int32, tag = "2")]
pub candidates_token_count: i32,
#[prost(int32, tag = "3")]
pub total_token_count: i32,
}
}
/// Generated client implementations.
pub mod prediction_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for online predictions and explanations.
#[derive(Debug, Clone)]
pub struct PredictionServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> PredictionServiceClient<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,
) -> PredictionServiceClient<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,
{
PredictionServiceClient::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
}
/// Perform an online prediction.
pub async fn predict(
&mut self,
request: impl tonic::IntoRequest<super::PredictRequest>,
) -> std::result::Result<
tonic::Response<super::PredictResponse>,
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.aiplatform.v1.PredictionService/Predict",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"Predict",
),
);
self.inner.unary(req, path, codec).await
}
/// Perform an online prediction with an arbitrary HTTP payload.
///
/// The response includes the following HTTP headers:
///
/// * `X-Vertex-AI-Endpoint-Id`: ID of the
/// [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this
/// prediction.
///
/// * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
/// [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this
/// prediction.
pub async fn raw_predict(
&mut self,
request: impl tonic::IntoRequest<super::RawPredictRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::api::HttpBody>,
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.aiplatform.v1.PredictionService/RawPredict",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"RawPredict",
),
);
self.inner.unary(req, path, codec).await
}
/// Perform a streaming online prediction with an arbitrary HTTP payload.
pub async fn stream_raw_predict(
&mut self,
request: impl tonic::IntoRequest<super::StreamRawPredictRequest>,
) -> std::result::Result<
tonic::Response<
tonic::codec::Streaming<super::super::super::super::api::HttpBody>,
>,
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.aiplatform.v1.PredictionService/StreamRawPredict",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"StreamRawPredict",
),
);
self.inner.server_streaming(req, path, codec).await
}
/// Perform an unary online prediction request to a gRPC model server for
/// Vertex first-party products and frameworks.
pub async fn direct_predict(
&mut self,
request: impl tonic::IntoRequest<super::DirectPredictRequest>,
) -> std::result::Result<
tonic::Response<super::DirectPredictResponse>,
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.aiplatform.v1.PredictionService/DirectPredict",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"DirectPredict",
),
);
self.inner.unary(req, path, codec).await
}
/// Perform an unary online prediction request to a gRPC model server for
/// custom containers.
pub async fn direct_raw_predict(
&mut self,
request: impl tonic::IntoRequest<super::DirectRawPredictRequest>,
) -> std::result::Result<
tonic::Response<super::DirectRawPredictResponse>,
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.aiplatform.v1.PredictionService/DirectRawPredict",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"DirectRawPredict",
),
);
self.inner.unary(req, path, codec).await
}
/// Perform a streaming online prediction request to a gRPC model server for
/// Vertex first-party products and frameworks.
pub async fn stream_direct_predict(
&mut self,
request: impl tonic::IntoStreamingRequest<
Message = super::StreamDirectPredictRequest,
>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::StreamDirectPredictResponse>>,
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.aiplatform.v1.PredictionService/StreamDirectPredict",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"StreamDirectPredict",
),
);
self.inner.streaming(req, path, codec).await
}
/// Perform a streaming online prediction request to a gRPC model server for
/// custom containers.
pub async fn stream_direct_raw_predict(
&mut self,
request: impl tonic::IntoStreamingRequest<
Message = super::StreamDirectRawPredictRequest,
>,
) -> std::result::Result<
tonic::Response<
tonic::codec::Streaming<super::StreamDirectRawPredictResponse>,
>,
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.aiplatform.v1.PredictionService/StreamDirectRawPredict",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"StreamDirectRawPredict",
),
);
self.inner.streaming(req, path, codec).await
}
/// Perform a streaming online prediction request for Vertex first-party
/// products and frameworks.
pub async fn streaming_predict(
&mut self,
request: impl tonic::IntoStreamingRequest<
Message = super::StreamingPredictRequest,
>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::StreamingPredictResponse>>,
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.aiplatform.v1.PredictionService/StreamingPredict",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"StreamingPredict",
),
);
self.inner.streaming(req, path, codec).await
}
/// Perform a server-side streaming online prediction request for Vertex
/// LLM streaming.
pub async fn server_streaming_predict(
&mut self,
request: impl tonic::IntoRequest<super::StreamingPredictRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::StreamingPredictResponse>>,
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.aiplatform.v1.PredictionService/ServerStreamingPredict",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"ServerStreamingPredict",
),
);
self.inner.server_streaming(req, path, codec).await
}
/// Perform a streaming online prediction request through gRPC.
pub async fn streaming_raw_predict(
&mut self,
request: impl tonic::IntoStreamingRequest<
Message = super::StreamingRawPredictRequest,
>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::StreamingRawPredictResponse>>,
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.aiplatform.v1.PredictionService/StreamingRawPredict",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"StreamingRawPredict",
),
);
self.inner.streaming(req, path, codec).await
}
/// Perform an online explanation.
///
/// If
/// [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
/// is specified, the corresponding DeployModel must have
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
/// populated. If
/// [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
/// is not specified, all DeployedModels must have
/// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
/// populated.
pub async fn explain(
&mut self,
request: impl tonic::IntoRequest<super::ExplainRequest>,
) -> std::result::Result<
tonic::Response<super::ExplainResponse>,
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.aiplatform.v1.PredictionService/Explain",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"Explain",
),
);
self.inner.unary(req, path, codec).await
}
/// Generate content with multimodal inputs.
pub async fn generate_content(
&mut self,
request: impl tonic::IntoRequest<super::GenerateContentRequest>,
) -> std::result::Result<
tonic::Response<super::GenerateContentResponse>,
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.aiplatform.v1.PredictionService/GenerateContent",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"GenerateContent",
),
);
self.inner.unary(req, path, codec).await
}
/// Generate content with multimodal inputs with streaming support.
pub async fn stream_generate_content(
&mut self,
request: impl tonic::IntoRequest<super::GenerateContentRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::GenerateContentResponse>>,
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.aiplatform.v1.PredictionService/StreamGenerateContent",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.PredictionService",
"StreamGenerateContent",
),
);
self.inner.server_streaming(req, path, codec).await
}
}
}
/// A SavedQuery is a view of the dataset. It references a subset of annotations
/// by problem type and filters.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SavedQuery {
/// Output only. Resource name of the SavedQuery.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user-defined name of the SavedQuery.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Some additional information about the SavedQuery.
#[prost(message, optional, tag = "12")]
pub metadata: ::core::option::Option<::prost_types::Value>,
/// Output only. Timestamp when this SavedQuery was created.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when SavedQuery was last updated.
#[prost(message, optional, tag = "4")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Filters on the Annotations in the dataset.
#[prost(string, tag = "5")]
pub annotation_filter: ::prost::alloc::string::String,
/// Required. Problem type of the SavedQuery.
/// Allowed values:
///
/// * IMAGE_CLASSIFICATION_SINGLE_LABEL
/// * IMAGE_CLASSIFICATION_MULTI_LABEL
/// * IMAGE_BOUNDING_POLY
/// * IMAGE_BOUNDING_BOX
/// * TEXT_CLASSIFICATION_SINGLE_LABEL
/// * TEXT_CLASSIFICATION_MULTI_LABEL
/// * TEXT_EXTRACTION
/// * TEXT_SENTIMENT
/// * VIDEO_CLASSIFICATION
/// * VIDEO_OBJECT_TRACKING
#[prost(string, tag = "6")]
pub problem_type: ::prost::alloc::string::String,
/// Output only. Number of AnnotationSpecs in the context of the SavedQuery.
#[prost(int32, tag = "10")]
pub annotation_spec_count: i32,
/// Used to perform a consistent read-modify-write update. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "8")]
pub etag: ::prost::alloc::string::String,
/// Output only. If the Annotations belonging to the SavedQuery can be used for
/// AutoML training.
#[prost(bool, tag = "9")]
pub support_automl_training: bool,
}
/// True positive, false positive, or false negative.
///
/// EvaluatedAnnotation is only available under ModelEvaluationSlice with slice
/// of `annotationSpec` dimension.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EvaluatedAnnotation {
/// Output only. Type of the EvaluatedAnnotation.
#[prost(enumeration = "evaluated_annotation::EvaluatedAnnotationType", tag = "1")]
pub r#type: i32,
/// Output only. The model predicted annotations.
///
/// For true positive, there is one and only one prediction, which matches the
/// only one ground truth annotation in
/// [ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
///
/// For false positive, there is one and only one prediction, which doesn't
/// match any ground truth annotation of the corresponding
/// [data_item_view_id][EvaluatedAnnotation.data_item_view_id].
///
/// For false negative, there are zero or more predictions which are similar to
/// the only ground truth annotation in
/// [ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths]
/// but not enough for a match.
///
/// The schema of the prediction is stored in
/// [ModelEvaluation.annotation_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.annotation_schema_uri]
#[prost(message, repeated, tag = "2")]
pub predictions: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// Output only. The ground truth Annotations, i.e. the Annotations that exist
/// in the test data the Model is evaluated on.
///
/// For true positive, there is one and only one ground truth annotation, which
/// matches the only prediction in
/// [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions].
///
/// For false positive, there are zero or more ground truth annotations that
/// are similar to the only prediction in
/// [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
/// but not enough for a match.
///
/// For false negative, there is one and only one ground truth annotation,
/// which doesn't match any predictions created by the model.
///
/// The schema of the ground truth is stored in
/// [ModelEvaluation.annotation_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.annotation_schema_uri]
#[prost(message, repeated, tag = "3")]
pub ground_truths: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// Output only. The data item payload that the Model predicted this
/// EvaluatedAnnotation on.
#[prost(message, optional, tag = "5")]
pub data_item_payload: ::core::option::Option<::prost_types::Value>,
/// Output only. ID of the EvaluatedDataItemView under the same ancestor
/// ModelEvaluation. The EvaluatedDataItemView consists of all ground truths
/// and predictions on
/// [data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
#[prost(string, tag = "6")]
pub evaluated_data_item_view_id: ::prost::alloc::string::String,
/// Explanations of
/// [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions].
/// Each element of the explanations indicates the explanation for one
/// explanation Method.
///
/// The attributions list in the
/// [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation.explanation]
/// object corresponds to the
/// [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions]
/// list. For example, the second element in the attributions list explains the
/// second element in the predictions list.
#[prost(message, repeated, tag = "8")]
pub explanations: ::prost::alloc::vec::Vec<EvaluatedAnnotationExplanation>,
/// Annotations of model error analysis results.
#[prost(message, repeated, tag = "9")]
pub error_analysis_annotations: ::prost::alloc::vec::Vec<ErrorAnalysisAnnotation>,
}
/// Nested message and enum types in `EvaluatedAnnotation`.
pub mod evaluated_annotation {
/// Describes the type of the EvaluatedAnnotation. The type is determined
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum EvaluatedAnnotationType {
/// Invalid value.
Unspecified = 0,
/// The EvaluatedAnnotation is a true positive. It has a prediction created
/// by the Model and a ground truth Annotation which the prediction matches.
TruePositive = 1,
/// The EvaluatedAnnotation is false positive. It has a prediction created by
/// the Model which does not match any ground truth annotation.
FalsePositive = 2,
/// The EvaluatedAnnotation is false negative. It has a ground truth
/// annotation which is not matched by any of the model created predictions.
FalseNegative = 3,
}
impl EvaluatedAnnotationType {
/// 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 {
EvaluatedAnnotationType::Unspecified => {
"EVALUATED_ANNOTATION_TYPE_UNSPECIFIED"
}
EvaluatedAnnotationType::TruePositive => "TRUE_POSITIVE",
EvaluatedAnnotationType::FalsePositive => "FALSE_POSITIVE",
EvaluatedAnnotationType::FalseNegative => "FALSE_NEGATIVE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"EVALUATED_ANNOTATION_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"TRUE_POSITIVE" => Some(Self::TruePositive),
"FALSE_POSITIVE" => Some(Self::FalsePositive),
"FALSE_NEGATIVE" => Some(Self::FalseNegative),
_ => None,
}
}
}
}
/// Explanation result of the prediction produced by the Model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EvaluatedAnnotationExplanation {
/// Explanation type.
///
/// For AutoML Image Classification models, possible values are:
///
/// * `image-integrated-gradients`
/// * `image-xrai`
#[prost(string, tag = "1")]
pub explanation_type: ::prost::alloc::string::String,
/// Explanation attribution response details.
#[prost(message, optional, tag = "2")]
pub explanation: ::core::option::Option<Explanation>,
}
/// Model error analysis for each annotation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ErrorAnalysisAnnotation {
/// Attributed items for a given annotation, typically representing neighbors
/// from the training sets constrained by the query type.
#[prost(message, repeated, tag = "1")]
pub attributed_items: ::prost::alloc::vec::Vec<
error_analysis_annotation::AttributedItem,
>,
/// The query type used for finding the attributed items.
#[prost(enumeration = "error_analysis_annotation::QueryType", tag = "2")]
pub query_type: i32,
/// The outlier score of this annotated item. Usually defined as the min of all
/// distances from attributed items.
#[prost(double, tag = "3")]
pub outlier_score: f64,
/// The threshold used to determine if this annotation is an outlier or not.
#[prost(double, tag = "4")]
pub outlier_threshold: f64,
}
/// Nested message and enum types in `ErrorAnalysisAnnotation`.
pub mod error_analysis_annotation {
/// Attributed items for a given annotation, typically representing neighbors
/// from the training sets constrained by the query type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AttributedItem {
/// The unique ID for each annotation. Used by FE to allocate the annotation
/// in DB.
#[prost(string, tag = "1")]
pub annotation_resource_name: ::prost::alloc::string::String,
/// The distance of this item to the annotation.
#[prost(double, tag = "2")]
pub distance: f64,
}
/// The query type used for finding the attributed items.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum QueryType {
/// Unspecified query type for model error analysis.
Unspecified = 0,
/// Query similar samples across all classes in the dataset.
AllSimilar = 1,
/// Query similar samples from the same class of the input sample.
SameClassSimilar = 2,
/// Query dissimilar samples from the same class of the input sample.
SameClassDissimilar = 3,
}
impl QueryType {
/// 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 {
QueryType::Unspecified => "QUERY_TYPE_UNSPECIFIED",
QueryType::AllSimilar => "ALL_SIMILAR",
QueryType::SameClassSimilar => "SAME_CLASS_SIMILAR",
QueryType::SameClassDissimilar => "SAME_CLASS_DISSIMILAR",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"QUERY_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"ALL_SIMILAR" => Some(Self::AllSimilar),
"SAME_CLASS_SIMILAR" => Some(Self::SameClassSimilar),
"SAME_CLASS_DISSIMILAR" => Some(Self::SameClassDissimilar),
_ => None,
}
}
}
}
/// A collection of metrics calculated by comparing Model's predictions on all of
/// the test data against annotations from the test data.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelEvaluation {
/// Output only. The resource name of the ModelEvaluation.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The display name of the ModelEvaluation.
#[prost(string, tag = "10")]
pub display_name: ::prost::alloc::string::String,
/// Points to a YAML file stored on Google Cloud Storage describing the
/// [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this
/// ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
#[prost(string, tag = "2")]
pub metrics_schema_uri: ::prost::alloc::string::String,
/// Evaluation metrics of the Model. The schema of the metrics is stored in
/// [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.metrics_schema_uri]
#[prost(message, optional, tag = "3")]
pub metrics: ::core::option::Option<::prost_types::Value>,
/// Output only. Timestamp when this ModelEvaluation was created.
#[prost(message, optional, tag = "4")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// All possible
/// [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension]
/// of ModelEvaluationSlices. The dimensions can be used as the filter of the
/// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
/// request, in the form of `slice.dimension = <dimension>`.
#[prost(string, repeated, tag = "5")]
pub slice_dimensions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Points to a YAML file stored on Google Cloud Storage describing
/// [EvaluatedDataItemView.data_item_payload][] and
/// [EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
/// The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
///
/// This field is not populated if there are neither EvaluatedDataItemViews nor
/// EvaluatedAnnotations under this ModelEvaluation.
#[prost(string, tag = "6")]
pub data_item_schema_uri: ::prost::alloc::string::String,
/// Points to a YAML file stored on Google Cloud Storage describing
/// [EvaluatedDataItemView.predictions][],
/// [EvaluatedDataItemView.ground_truths][],
/// [EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
/// and
/// [EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
/// The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
///
/// This field is not populated if there are neither EvaluatedDataItemViews nor
/// EvaluatedAnnotations under this ModelEvaluation.
#[prost(string, tag = "7")]
pub annotation_schema_uri: ::prost::alloc::string::String,
/// Aggregated explanation metrics for the Model's prediction output over the
/// data this ModelEvaluation uses. This field is populated only if the Model
/// is evaluated with explanations, and only for AutoML tabular Models.
///
#[prost(message, optional, tag = "8")]
pub model_explanation: ::core::option::Option<ModelExplanation>,
/// Describes the values of
/// [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
/// for explaining the predicted values on the evaluated data.
#[prost(message, repeated, tag = "9")]
pub explanation_specs: ::prost::alloc::vec::Vec<
model_evaluation::ModelEvaluationExplanationSpec,
>,
/// The metadata of the ModelEvaluation.
/// For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
/// structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
/// "evaluation_dataset_path", "row_based_metrics_path".
#[prost(message, optional, tag = "11")]
pub metadata: ::core::option::Option<::prost_types::Value>,
}
/// Nested message and enum types in `ModelEvaluation`.
pub mod model_evaluation {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelEvaluationExplanationSpec {
/// Explanation type.
///
/// For AutoML Image Classification models, possible values are:
///
/// * `image-integrated-gradients`
/// * `image-xrai`
#[prost(string, tag = "1")]
pub explanation_type: ::prost::alloc::string::String,
/// Explanation spec details.
#[prost(message, optional, tag = "2")]
pub explanation_spec: ::core::option::Option<super::ExplanationSpec>,
}
}
/// Request message for
/// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UploadModelRequest {
/// Required. The resource name of the Location into which to upload the Model.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The resource name of the model into which to upload the version.
/// Only specify this field when uploading a new version.
#[prost(string, tag = "4")]
pub parent_model: ::prost::alloc::string::String,
/// Optional. The ID to use for the uploaded Model, which will become the final
/// component of the model resource name.
///
/// This value may be up to 63 characters, and valid characters are
/// `\[a-z0-9_-\]`. The first character cannot be a number or hyphen.
#[prost(string, tag = "5")]
pub model_id: ::prost::alloc::string::String,
/// Required. The Model to create.
#[prost(message, optional, tag = "2")]
pub model: ::core::option::Option<Model>,
/// Optional. The user-provided custom service account to use to do the model
/// upload. If empty, [Vertex AI Service
/// Agent](<https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents>)
/// will be used to access resources needed to upload the model. This account
/// must belong to the target project where the model is uploaded to, i.e., the
/// project specified in the `parent` field of this request and have necessary
/// read permissions (to Google Cloud Storage, Artifact Registry, etc.).
#[prost(string, tag = "6")]
pub service_account: ::prost::alloc::string::String,
}
/// Details of
/// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]
/// operation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UploadModelOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Response message of
/// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]
/// operation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UploadModelResponse {
/// The name of the uploaded Model resource.
/// Format: `projects/{project}/locations/{location}/models/{model}`
#[prost(string, tag = "1")]
pub model: ::prost::alloc::string::String,
/// Output only. The version ID of the model that is uploaded.
#[prost(string, tag = "2")]
pub model_version_id: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.GetModel][google.cloud.aiplatform.v1.ModelService.GetModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetModelRequest {
/// Required. The name of the Model resource.
/// Format: `projects/{project}/locations/{location}/models/{model}`
///
/// In order to retrieve a specific version of the model, also provide
/// the version ID or version alias.
/// Example: `projects/{project}/locations/{location}/models/{model}@2`
/// or
/// `projects/{project}/locations/{location}/models/{model}@golden`
/// If no version ID or alias is specified, the "default" version will be
/// returned. The "default" version alias is created for the first version of
/// the model, and can be moved to other versions later on. There will be
/// exactly one default version.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelsRequest {
/// Required. The resource name of the Location to list the Models from.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// An expression for filtering the results of the request. For field names
/// both snake_case and camelCase are supported.
///
/// * `model` supports = and !=. `model` represents the Model ID,
/// i.e. the last segment of the Model's [resource
/// name][google.cloud.aiplatform.v1.Model.name].
/// * `display_name` supports = and !=
/// * `labels` supports general map functions that is:
/// * `labels.key=value` - key:value equality
/// * `labels.key:* or labels:key - key existence
/// * A key including a space must be quoted. `labels."a key"`.
/// * `base_model_name` only supports =
///
/// Some examples:
///
/// * `model=1234`
/// * `displayName="myDisplayName"`
/// * `labels.myKey="myValue"`
/// * `baseModelName="text-bison"`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token]
/// of the previous
/// [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
/// Supported fields:
///
/// * `display_name`
/// * `create_time`
/// * `update_time`
///
/// Example: `display_name, create_time desc`.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelsResponse {
/// List of Models in the requested page.
#[prost(message, repeated, tag = "1")]
pub models: ::prost::alloc::vec::Vec<Model>,
/// A token to retrieve next page of results.
/// Pass to
/// [ListModelsRequest.page_token][google.cloud.aiplatform.v1.ListModelsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelVersionsRequest {
/// Required. The name of the model to list versions for.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [next_page_token][google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token]
/// of the previous
/// [ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions]
/// call.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// An expression for filtering the results of the request. For field names
/// both snake_case and camelCase are supported.
///
/// * `labels` supports general map functions that is:
/// * `labels.key=value` - key:value equality
/// * `labels.key:* or labels:key - key existence
/// * A key including a space must be quoted. `labels."a key"`.
///
/// Some examples:
///
/// * `labels.myKey="myValue"`
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
/// Supported fields:
///
/// * `create_time`
/// * `update_time`
///
/// Example: `update_time asc, create_time desc`.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelVersionsResponse {
/// List of Model versions in the requested page.
/// In the returned Model name field, version ID instead of regvision tag will
/// be included.
#[prost(message, repeated, tag = "1")]
pub models: ::prost::alloc::vec::Vec<Model>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1.ListModelVersionsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.UpdateModel][google.cloud.aiplatform.v1.ModelService.UpdateModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateModelRequest {
/// Required. The Model which replaces the resource on the server.
/// When Model Versioning is enabled, the model.name will be used to determine
/// whether to update the model or model version.
/// 1. model.name with the @ value, e.g. models/123@1, refers to a version
/// specific update.
/// 2. model.name without the @ value, e.g. models/123, refers to a model
/// update.
/// 3. model.name with @-, e.g. models/123@-, refers to a model update.
/// 4. Supported model fields: display_name, description; supported
/// version-specific fields: version_description. Labels are supported in both
/// scenarios. Both the model labels and the version labels are merged when a
/// model is returned. When updating labels, if the request is for
/// model-specific update, model label gets updated. Otherwise, version labels
/// get updated.
/// 5. A model name or model version name fields update mismatch will cause a
/// precondition error.
/// 6. One request cannot update both the model and the version fields. You
/// must update them separately.
#[prost(message, optional, tag = "1")]
pub model: ::core::option::Option<Model>,
/// Required. The update mask applies to the resource.
/// For the `FieldMask` definition, see
/// [google.protobuf.FieldMask][google.protobuf.FieldMask].
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateExplanationDatasetRequest {
/// Required. The resource name of the Model to update.
/// Format: `projects/{project}/locations/{location}/models/{model}`
#[prost(string, tag = "1")]
pub model: ::prost::alloc::string::String,
/// The example config containing the location of the dataset.
#[prost(message, optional, tag = "2")]
pub examples: ::core::option::Option<Examples>,
}
/// Runtime operation information for
/// [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateExplanationDatasetOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [ModelService.DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteModelRequest {
/// Required. The name of the Model resource to be deleted.
/// Format: `projects/{project}/locations/{location}/models/{model}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1.ModelService.DeleteModelVersion].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteModelVersionRequest {
/// Required. The name of the model version to be deleted, with a version ID
/// explicitly included.
///
/// Example: `projects/{project}/locations/{location}/models/{model}@1234`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1.ModelService.MergeVersionAliases].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MergeVersionAliasesRequest {
/// Required. The name of the model version to merge aliases, with a version ID
/// explicitly included.
///
/// Example: `projects/{project}/locations/{location}/models/{model}@1234`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The set of version aliases to merge.
/// The alias should be at most 128 characters, and match
/// `[a-z][a-zA-Z0-9-]{0,126}\[a-z-0-9\]`.
/// Add the `-` prefix to an alias means removing that alias from the version.
/// `-` is NOT counted in the 128 characters. Example: `-golden` means removing
/// the `golden` alias from the version.
///
/// There is NO ordering in aliases, which means
/// 1) The aliases returned from GetModel API might not have the exactly same
/// order from this MergeVersionAliases API. 2) Adding and deleting the same
/// alias in the request is not recommended, and the 2 operations will be
/// cancelled out.
#[prost(string, repeated, tag = "2")]
pub version_aliases: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request message for
/// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportModelRequest {
/// Required. The resource name of the Model to export.
/// The resource name may contain version id or version alias to specify the
/// version, if no version is specified, the default version will be exported.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The desired output location and configuration.
#[prost(message, optional, tag = "2")]
pub output_config: ::core::option::Option<export_model_request::OutputConfig>,
}
/// Nested message and enum types in `ExportModelRequest`.
pub mod export_model_request {
/// Output configuration for the Model export.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OutputConfig {
/// The ID of the format in which the Model must be exported. Each Model
/// lists the [export formats it
/// supports][google.cloud.aiplatform.v1.Model.supported_export_formats]. If
/// no value is provided here, then the first from the list of the Model's
/// supported formats is used by default.
#[prost(string, tag = "1")]
pub export_format_id: ::prost::alloc::string::String,
/// The Cloud Storage location where the Model artifact is to be
/// written to. Under the directory given as the destination a new one with
/// name "`model-export-<model-display-name>-<timestamp-of-export-call>`",
/// where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format,
/// will be created. Inside, the Model and any of its supporting files
/// will be written.
/// This field should only be set when the `exportableContent` field of the
/// \[Model.supported_export_formats\] object contains `ARTIFACT`.
#[prost(message, optional, tag = "3")]
pub artifact_destination: ::core::option::Option<super::GcsDestination>,
/// The Google Container Registry or Artifact Registry uri where the
/// Model container image will be copied to.
/// This field should only be set when the `exportableContent` field of the
/// \[Model.supported_export_formats\] object contains `IMAGE`.
#[prost(message, optional, tag = "4")]
pub image_destination: ::core::option::Option<
super::ContainerRegistryDestination,
>,
}
}
/// Details of
/// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel]
/// operation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportModelOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// Output only. Information further describing the output of this Model
/// export.
#[prost(message, optional, tag = "2")]
pub output_info: ::core::option::Option<export_model_operation_metadata::OutputInfo>,
}
/// Nested message and enum types in `ExportModelOperationMetadata`.
pub mod export_model_operation_metadata {
/// Further describes the output of the ExportModel. Supplements
/// [ExportModelRequest.OutputConfig][google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OutputInfo {
/// Output only. If the Model artifact is being exported to Google Cloud
/// Storage this is the full path of the directory created, into which the
/// Model files are being written to.
#[prost(string, tag = "2")]
pub artifact_output_uri: ::prost::alloc::string::String,
/// Output only. If the Model image is being exported to Google Container
/// Registry or Artifact Registry this is the full path of the image created.
#[prost(string, tag = "3")]
pub image_output_uri: ::prost::alloc::string::String,
}
}
/// Response message of
/// [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset]
/// operation.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UpdateExplanationDatasetResponse {}
/// Response message of
/// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel]
/// operation.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ExportModelResponse {}
/// Request message for
/// [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CopyModelRequest {
/// Required. The resource name of the Location into which to copy the Model.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The resource name of the Model to copy. That Model must be in the
/// same Project. Format:
/// `projects/{project}/locations/{location}/models/{model}`
#[prost(string, tag = "2")]
pub source_model: ::prost::alloc::string::String,
/// Customer-managed encryption key options. If this is set,
/// then the Model copy will be encrypted with the provided encryption key.
#[prost(message, optional, tag = "3")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// If both fields are unset, a new Model will be created with a generated ID.
#[prost(oneof = "copy_model_request::DestinationModel", tags = "4, 5")]
pub destination_model: ::core::option::Option<copy_model_request::DestinationModel>,
}
/// Nested message and enum types in `CopyModelRequest`.
pub mod copy_model_request {
/// If both fields are unset, a new Model will be created with a generated ID.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum DestinationModel {
/// Optional. Copy source_model into a new Model with this ID. The ID will
/// become the final component of the model resource name.
///
/// This value may be up to 63 characters, and valid characters are
/// `\[a-z0-9_-\]`. The first character cannot be a number or hyphen.
#[prost(string, tag = "4")]
ModelId(::prost::alloc::string::String),
/// Optional. Specify this field to copy source_model into this existing
/// Model as a new version. Format:
/// `projects/{project}/locations/{location}/models/{model}`
#[prost(string, tag = "5")]
ParentModel(::prost::alloc::string::String),
}
}
/// Details of
/// [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel]
/// operation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CopyModelOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Response message of
/// [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel]
/// operation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CopyModelResponse {
/// The name of the copied Model resource.
/// Format: `projects/{project}/locations/{location}/models/{model}`
#[prost(string, tag = "1")]
pub model: ::prost::alloc::string::String,
/// Output only. The version ID of the model that is copied.
#[prost(string, tag = "2")]
pub model_version_id: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportModelEvaluationRequest {
/// Required. The name of the parent model resource.
/// Format: `projects/{project}/locations/{location}/models/{model}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Model evaluation resource to be imported.
#[prost(message, optional, tag = "2")]
pub model_evaluation: ::core::option::Option<ModelEvaluation>,
}
/// Request message for
/// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchImportModelEvaluationSlicesRequest {
/// Required. The name of the parent ModelEvaluation resource.
/// Format:
/// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Model evaluation slice resource to be imported.
#[prost(message, repeated, tag = "2")]
pub model_evaluation_slices: ::prost::alloc::vec::Vec<ModelEvaluationSlice>,
}
/// Response message for
/// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchImportModelEvaluationSlicesResponse {
/// Output only. List of imported
/// [ModelEvaluationSlice.name][google.cloud.aiplatform.v1.ModelEvaluationSlice.name].
#[prost(string, repeated, tag = "1")]
pub imported_model_evaluation_slices: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
/// Request message for
/// [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchImportEvaluatedAnnotationsRequest {
/// Required. The name of the parent ModelEvaluationSlice resource.
/// Format:
/// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Evaluated annotations resource to be imported.
#[prost(message, repeated, tag = "2")]
pub evaluated_annotations: ::prost::alloc::vec::Vec<EvaluatedAnnotation>,
}
/// Response message for
/// [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations]
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BatchImportEvaluatedAnnotationsResponse {
/// Output only. Number of EvaluatedAnnotations imported.
#[prost(int32, tag = "1")]
pub imported_evaluated_annotations_count: i32,
}
/// Request message for
/// [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1.ModelService.GetModelEvaluation].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetModelEvaluationRequest {
/// Required. The name of the ModelEvaluation resource.
/// Format:
/// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelEvaluationsRequest {
/// Required. The resource name of the Model to list the ModelEvaluations from.
/// Format: `projects/{project}/locations/{location}/models/{model}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token]
/// of the previous
/// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelEvaluationsResponse {
/// List of ModelEvaluations in the requested page.
#[prost(message, repeated, tag = "1")]
pub model_evaluations: ::prost::alloc::vec::Vec<ModelEvaluation>,
/// A token to retrieve next page of results.
/// Pass to
/// [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetModelEvaluationSliceRequest {
/// Required. The name of the ModelEvaluationSlice resource.
/// Format:
/// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelEvaluationSlicesRequest {
/// Required. The resource name of the ModelEvaluation to list the
/// ModelEvaluationSlices from. Format:
/// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
///
/// * `slice.dimension` - for =.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token]
/// of the previous
/// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelEvaluationSlicesResponse {
/// List of ModelEvaluations in the requested page.
#[prost(message, repeated, tag = "1")]
pub model_evaluation_slices: ::prost::alloc::vec::Vec<ModelEvaluationSlice>,
/// A token to retrieve next page of results.
/// Pass to
/// [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod model_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for managing Vertex AI's machine learning Models.
#[derive(Debug, Clone)]
pub struct ModelServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> ModelServiceClient<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,
) -> ModelServiceClient<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,
{
ModelServiceClient::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
}
/// Uploads a Model artifact into Vertex AI.
pub async fn upload_model(
&mut self,
request: impl tonic::IntoRequest<super::UploadModelRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.ModelService/UploadModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"UploadModel",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a Model.
pub async fn get_model(
&mut self,
request: impl tonic::IntoRequest<super::GetModelRequest>,
) -> std::result::Result<tonic::Response<super::Model>, 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.aiplatform.v1.ModelService/GetModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"GetModel",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Models in a Location.
pub async fn list_models(
&mut self,
request: impl tonic::IntoRequest<super::ListModelsRequest>,
) -> std::result::Result<
tonic::Response<super::ListModelsResponse>,
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.aiplatform.v1.ModelService/ListModels",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"ListModels",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists versions of the specified model.
pub async fn list_model_versions(
&mut self,
request: impl tonic::IntoRequest<super::ListModelVersionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListModelVersionsResponse>,
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.aiplatform.v1.ModelService/ListModelVersions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"ListModelVersions",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a Model.
pub async fn update_model(
&mut self,
request: impl tonic::IntoRequest<super::UpdateModelRequest>,
) -> std::result::Result<tonic::Response<super::Model>, 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.aiplatform.v1.ModelService/UpdateModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"UpdateModel",
),
);
self.inner.unary(req, path, codec).await
}
/// Incrementally update the dataset used for an examples model.
pub async fn update_explanation_dataset(
&mut self,
request: impl tonic::IntoRequest<super::UpdateExplanationDatasetRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.ModelService/UpdateExplanationDataset",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"UpdateExplanationDataset",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a Model.
///
/// A model cannot be deleted if any
/// [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a
/// [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the
/// model in its
/// [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
/// field.
pub async fn delete_model(
&mut self,
request: impl tonic::IntoRequest<super::DeleteModelRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.ModelService/DeleteModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"DeleteModel",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a Model version.
///
/// Model version can only be deleted if there are no
/// [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it.
/// Deleting the only version in the Model is not allowed. Use
/// [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for
/// deleting the Model instead.
pub async fn delete_model_version(
&mut self,
request: impl tonic::IntoRequest<super::DeleteModelVersionRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.ModelService/DeleteModelVersion",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"DeleteModelVersion",
),
);
self.inner.unary(req, path, codec).await
}
/// Merges a set of aliases for a Model version.
pub async fn merge_version_aliases(
&mut self,
request: impl tonic::IntoRequest<super::MergeVersionAliasesRequest>,
) -> std::result::Result<tonic::Response<super::Model>, 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.aiplatform.v1.ModelService/MergeVersionAliases",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"MergeVersionAliases",
),
);
self.inner.unary(req, path, codec).await
}
/// Exports a trained, exportable Model to a location specified by the
/// user. A Model is considered to be exportable if it has at least one
/// [supported export
/// format][google.cloud.aiplatform.v1.Model.supported_export_formats].
pub async fn export_model(
&mut self,
request: impl tonic::IntoRequest<super::ExportModelRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.ModelService/ExportModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"ExportModel",
),
);
self.inner.unary(req, path, codec).await
}
/// Copies an already existing Vertex AI Model into the specified Location.
/// The source Model must exist in the same Project.
/// When copying custom Models, the users themselves are responsible for
/// [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be
/// region-agnostic, as well as making sure that any resources (e.g. files) it
/// depends on remain accessible.
pub async fn copy_model(
&mut self,
request: impl tonic::IntoRequest<super::CopyModelRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.ModelService/CopyModel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"CopyModel",
),
);
self.inner.unary(req, path, codec).await
}
/// Imports an externally generated ModelEvaluation.
pub async fn import_model_evaluation(
&mut self,
request: impl tonic::IntoRequest<super::ImportModelEvaluationRequest>,
) -> std::result::Result<
tonic::Response<super::ModelEvaluation>,
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.aiplatform.v1.ModelService/ImportModelEvaluation",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"ImportModelEvaluation",
),
);
self.inner.unary(req, path, codec).await
}
/// Imports a list of externally generated ModelEvaluationSlice.
pub async fn batch_import_model_evaluation_slices(
&mut self,
request: impl tonic::IntoRequest<
super::BatchImportModelEvaluationSlicesRequest,
>,
) -> std::result::Result<
tonic::Response<super::BatchImportModelEvaluationSlicesResponse>,
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.aiplatform.v1.ModelService/BatchImportModelEvaluationSlices",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"BatchImportModelEvaluationSlices",
),
);
self.inner.unary(req, path, codec).await
}
/// Imports a list of externally generated EvaluatedAnnotations.
pub async fn batch_import_evaluated_annotations(
&mut self,
request: impl tonic::IntoRequest<
super::BatchImportEvaluatedAnnotationsRequest,
>,
) -> std::result::Result<
tonic::Response<super::BatchImportEvaluatedAnnotationsResponse>,
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.aiplatform.v1.ModelService/BatchImportEvaluatedAnnotations",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"BatchImportEvaluatedAnnotations",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a ModelEvaluation.
pub async fn get_model_evaluation(
&mut self,
request: impl tonic::IntoRequest<super::GetModelEvaluationRequest>,
) -> std::result::Result<
tonic::Response<super::ModelEvaluation>,
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.aiplatform.v1.ModelService/GetModelEvaluation",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"GetModelEvaluation",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists ModelEvaluations in a Model.
pub async fn list_model_evaluations(
&mut self,
request: impl tonic::IntoRequest<super::ListModelEvaluationsRequest>,
) -> std::result::Result<
tonic::Response<super::ListModelEvaluationsResponse>,
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.aiplatform.v1.ModelService/ListModelEvaluations",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"ListModelEvaluations",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a ModelEvaluationSlice.
pub async fn get_model_evaluation_slice(
&mut self,
request: impl tonic::IntoRequest<super::GetModelEvaluationSliceRequest>,
) -> std::result::Result<
tonic::Response<super::ModelEvaluationSlice>,
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.aiplatform.v1.ModelService/GetModelEvaluationSlice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"GetModelEvaluationSlice",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists ModelEvaluationSlices in a ModelEvaluation.
pub async fn list_model_evaluation_slices(
&mut self,
request: impl tonic::IntoRequest<super::ListModelEvaluationSlicesRequest>,
) -> std::result::Result<
tonic::Response<super::ListModelEvaluationSlicesResponse>,
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.aiplatform.v1.ModelService/ListModelEvaluationSlices",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ModelService",
"ListModelEvaluationSlices",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for ComputeTokens RPC call.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ComputeTokensRequest {
/// Required. The name of the Endpoint requested to get lists of tokens and
/// token ids.
#[prost(string, tag = "1")]
pub endpoint: ::prost::alloc::string::String,
/// Optional. The instances that are the input to token computing API call.
/// Schema is identical to the prediction schema of the text model, even for
/// the non-text models, like chat models, or Codey models.
#[prost(message, repeated, tag = "2")]
pub instances: ::prost::alloc::vec::Vec<::prost_types::Value>,
/// Optional. The name of the publisher model requested to serve the
/// prediction. Format:
/// projects/{project}/locations/{location}/publishers/*/models/*
#[prost(string, tag = "3")]
pub model: ::prost::alloc::string::String,
/// Optional. Input content.
#[prost(message, repeated, tag = "4")]
pub contents: ::prost::alloc::vec::Vec<Content>,
}
/// Tokens info with a list of tokens and the corresponding list of token ids.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TokensInfo {
/// A list of tokens from the input.
#[prost(bytes = "bytes", repeated, tag = "1")]
pub tokens: ::prost::alloc::vec::Vec<::prost::bytes::Bytes>,
/// A list of token ids from the input.
#[prost(int64, repeated, tag = "2")]
pub token_ids: ::prost::alloc::vec::Vec<i64>,
/// Optional. Optional fields for the role from the corresponding Content.
#[prost(string, tag = "3")]
pub role: ::prost::alloc::string::String,
}
/// Response message for ComputeTokens RPC call.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ComputeTokensResponse {
/// Lists of tokens info from the input. A ComputeTokensRequest could have
/// multiple instances with a prompt in each instance. We also need to return
/// lists of tokens info for the request with multiple instances.
#[prost(message, repeated, tag = "1")]
pub tokens_info: ::prost::alloc::vec::Vec<TokensInfo>,
}
/// Generated client implementations.
pub mod llm_utility_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Service for LLM related utility functions.
#[derive(Debug, Clone)]
pub struct LlmUtilityServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> LlmUtilityServiceClient<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,
) -> LlmUtilityServiceClient<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,
{
LlmUtilityServiceClient::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
}
/// Perform a token counting.
pub async fn count_tokens(
&mut self,
request: impl tonic::IntoRequest<super::CountTokensRequest>,
) -> std::result::Result<
tonic::Response<super::CountTokensResponse>,
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.aiplatform.v1.LlmUtilityService/CountTokens",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.LlmUtilityService",
"CountTokens",
),
);
self.inner.unary(req, path, codec).await
}
/// Return a list of tokens based on the input text.
pub async fn compute_tokens(
&mut self,
request: impl tonic::IntoRequest<super::ComputeTokensRequest>,
) -> std::result::Result<
tonic::Response<super::ComputeTokensResponse>,
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.aiplatform.v1.LlmUtilityService/ComputeTokens",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.LlmUtilityService",
"ComputeTokens",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Vertex AI Feature Online Store provides a centralized repository for serving
/// ML features and embedding indexes at low latency. The Feature Online Store is
/// a top-level container.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureOnlineStore {
/// Identifier. Name of the FeatureOnlineStore. Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Timestamp when this FeatureOnlineStore was created.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this FeatureOnlineStore was last updated.
#[prost(message, optional, tag = "4")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Used to perform consistent read-modify-write updates. If not set,
/// a blind "overwrite" update happens.
#[prost(string, tag = "5")]
pub etag: ::prost::alloc::string::String,
/// Optional. The labels with user-defined metadata to organize your
/// FeatureOnlineStore.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information on and examples of labels.
/// No more than 64 user labels can be associated with one
/// FeatureOnlineStore(System labels are excluded)." System reserved label keys
/// are prefixed with "aiplatform.googleapis.com/" and are immutable.
#[prost(btree_map = "string, string", tag = "6")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. State of the featureOnlineStore.
#[prost(enumeration = "feature_online_store::State", tag = "7")]
pub state: i32,
/// Optional. The dedicated serving endpoint for this FeatureOnlineStore, which
/// is different from common Vertex service endpoint.
#[prost(message, optional, tag = "10")]
pub dedicated_serving_endpoint: ::core::option::Option<
feature_online_store::DedicatedServingEndpoint,
>,
/// Optional. Customer-managed encryption key spec for data storage. If set,
/// online store will be secured by this key.
#[prost(message, optional, tag = "13")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "15")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "16")]
pub satisfies_pzi: bool,
#[prost(oneof = "feature_online_store::StorageType", tags = "8, 12")]
pub storage_type: ::core::option::Option<feature_online_store::StorageType>,
}
/// Nested message and enum types in `FeatureOnlineStore`.
pub mod feature_online_store {
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Bigtable {
/// Required. Autoscaling config applied to Bigtable Instance.
#[prost(message, optional, tag = "1")]
pub auto_scaling: ::core::option::Option<bigtable::AutoScaling>,
}
/// Nested message and enum types in `Bigtable`.
pub mod bigtable {
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AutoScaling {
/// Required. The minimum number of nodes to scale down to. Must be greater
/// than or equal to 1.
#[prost(int32, tag = "1")]
pub min_node_count: i32,
/// Required. The maximum number of nodes to scale up to. Must be greater
/// than or equal to min_node_count, and less than or equal to 10 times of
/// 'min_node_count'.
#[prost(int32, tag = "2")]
pub max_node_count: i32,
/// Optional. A percentage of the cluster's CPU capacity. Can be from 10%
/// to 80%. When a cluster's CPU utilization exceeds the target that you
/// have set, Bigtable immediately adds nodes to the cluster. When CPU
/// utilization is substantially lower than the target, Bigtable removes
/// nodes. If not set will default to 50%.
#[prost(int32, tag = "3")]
pub cpu_utilization_target: i32,
}
}
/// Optimized storage type
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Optimized {}
/// The dedicated serving endpoint for this FeatureOnlineStore. Only need to
/// set when you choose Optimized storage type. Public endpoint is provisioned
/// by default.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DedicatedServingEndpoint {
/// Output only. This field will be populated with the domain name to use for
/// this FeatureOnlineStore
#[prost(string, tag = "2")]
pub public_endpoint_domain_name: ::prost::alloc::string::String,
/// Optional. Private service connect config. The private service connection
/// is available only for Optimized storage type, not for embedding
/// management now. If
/// [PrivateServiceConnectConfig.enable_private_service_connect][google.cloud.aiplatform.v1.PrivateServiceConnectConfig.enable_private_service_connect]
/// set to true, customers will use private service connection to send
/// request. Otherwise, the connection will set to public endpoint.
#[prost(message, optional, tag = "3")]
pub private_service_connect_config: ::core::option::Option<
super::PrivateServiceConnectConfig,
>,
/// Output only. The name of the service attachment resource. Populated if
/// private service connect is enabled and after FeatureViewSync is created.
#[prost(string, tag = "4")]
pub service_attachment: ::prost::alloc::string::String,
}
/// Possible states a featureOnlineStore can have.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Default value. This value is unused.
Unspecified = 0,
/// State when the featureOnlineStore configuration is not being updated and
/// the fields reflect the current configuration of the featureOnlineStore.
/// The featureOnlineStore is usable in this state.
Stable = 1,
/// The state of the featureOnlineStore configuration when it is being
/// updated. During an update, the fields reflect either the original
/// configuration or the updated configuration of the featureOnlineStore. The
/// featureOnlineStore is still usable in this state.
Updating = 2,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Stable => "STABLE",
State::Updating => "UPDATING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"STABLE" => Some(Self::Stable),
"UPDATING" => Some(Self::Updating),
_ => None,
}
}
}
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum StorageType {
/// Contains settings for the Cloud Bigtable instance that will be created
/// to serve featureValues for all FeatureViews under this
/// FeatureOnlineStore.
#[prost(message, tag = "8")]
Bigtable(Bigtable),
/// Contains settings for the Optimized store that will be created
/// to serve featureValues for all FeatureViews under this
/// FeatureOnlineStore. When choose Optimized storage type, need to set
/// [PrivateServiceConnectConfig.enable_private_service_connect][google.cloud.aiplatform.v1.PrivateServiceConnectConfig.enable_private_service_connect]
/// to use private endpoint. Otherwise will use public endpoint by default.
#[prost(message, tag = "12")]
Optimized(Optimized),
}
}
/// FeatureView is representation of values that the FeatureOnlineStore will
/// serve based on its syncConfig.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureView {
/// Identifier. Name of the FeatureView. Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Timestamp when this FeatureView was created.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this FeatureView was last updated.
#[prost(message, optional, tag = "3")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Used to perform consistent read-modify-write updates. If not set,
/// a blind "overwrite" update happens.
#[prost(string, tag = "4")]
pub etag: ::prost::alloc::string::String,
/// Optional. The labels with user-defined metadata to organize your
/// FeatureViews.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information on and examples of labels.
/// No more than 64 user labels can be associated with one
/// FeatureOnlineStore(System labels are excluded)." System reserved label keys
/// are prefixed with "aiplatform.googleapis.com/" and are immutable.
#[prost(btree_map = "string, string", tag = "5")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Configures when data is to be synced/updated for this FeatureView. At the
/// end of the sync the latest featureValues for each entityId of this
/// FeatureView are made ready for online serving.
#[prost(message, optional, tag = "7")]
pub sync_config: ::core::option::Option<feature_view::SyncConfig>,
/// Optional. Configuration for index preparation for vector search. It
/// contains the required configurations to create an index from source data,
/// so that approximate nearest neighbor (a.k.a ANN) algorithms search can be
/// performed during online serving.
#[prost(message, optional, tag = "15")]
pub index_config: ::core::option::Option<feature_view::IndexConfig>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "19")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "20")]
pub satisfies_pzi: bool,
#[prost(oneof = "feature_view::Source", tags = "6, 9")]
pub source: ::core::option::Option<feature_view::Source>,
}
/// Nested message and enum types in `FeatureView`.
pub mod feature_view {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQuerySource {
/// Required. The BigQuery view URI that will be materialized on each sync
/// trigger based on FeatureView.SyncConfig.
#[prost(string, tag = "1")]
pub uri: ::prost::alloc::string::String,
/// Required. Columns to construct entity_id / row keys.
#[prost(string, repeated, tag = "2")]
pub entity_id_columns: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Configuration for Sync. Only one option is set.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SyncConfig {
/// Cron schedule (<https://en.wikipedia.org/wiki/Cron>) to launch scheduled
/// runs. To explicitly set a timezone to the cron tab, apply a prefix in
/// the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
/// The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
/// database. For example, "CRON_TZ=America/New_York 1 * * * *", or
/// "TZ=America/New_York 1 * * * *".
#[prost(string, tag = "1")]
pub cron: ::prost::alloc::string::String,
}
/// Configuration for vector indexing.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IndexConfig {
/// Optional. Column of embedding. This column contains the source data to
/// create index for vector search. embedding_column must be set when using
/// vector search.
#[prost(string, tag = "1")]
pub embedding_column: ::prost::alloc::string::String,
/// Optional. Columns of features that're used to filter vector search
/// results.
#[prost(string, repeated, tag = "2")]
pub filter_columns: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. Column of crowding. This column contains crowding attribute
/// which is a constraint on a neighbor list produced by
/// [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities]
/// to diversify search results. If
/// [NearestNeighborQuery.per_crowding_attribute_neighbor_count][google.cloud.aiplatform.v1.NearestNeighborQuery.per_crowding_attribute_neighbor_count]
/// is set to K in
/// [SearchNearestEntitiesRequest][google.cloud.aiplatform.v1.SearchNearestEntitiesRequest],
/// it's guaranteed that no more than K entities of the same crowding
/// attribute are returned in the response.
#[prost(string, tag = "3")]
pub crowding_column: ::prost::alloc::string::String,
/// Optional. The number of dimensions of the input embedding.
#[prost(int32, optional, tag = "4")]
pub embedding_dimension: ::core::option::Option<i32>,
/// Optional. The distance measure used in nearest neighbor search.
#[prost(enumeration = "index_config::DistanceMeasureType", tag = "5")]
pub distance_measure_type: i32,
/// The configuration with regard to the algorithms used for efficient
/// search.
#[prost(oneof = "index_config::AlgorithmConfig", tags = "6, 7")]
pub algorithm_config: ::core::option::Option<index_config::AlgorithmConfig>,
}
/// Nested message and enum types in `IndexConfig`.
pub mod index_config {
/// Configuration options for using brute force search.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BruteForceConfig {}
/// Configuration options for the tree-AH algorithm.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TreeAhConfig {
/// Optional. Number of embeddings on each leaf node. The default value is
/// 1000 if not set.
#[prost(int64, optional, tag = "1")]
pub leaf_node_embedding_count: ::core::option::Option<i64>,
}
/// The distance measure used in nearest neighbor search.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DistanceMeasureType {
/// Should not be set.
Unspecified = 0,
/// Euclidean (L_2) Distance.
SquaredL2Distance = 1,
/// Cosine Distance. Defined as 1 - cosine similarity.
///
/// We strongly suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead
/// of COSINE distance. Our algorithms have been more optimized for
/// DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is
/// mathematically equivalent to COSINE distance and results in the same
/// ranking.
CosineDistance = 2,
/// Dot Product Distance. Defined as a negative of the dot product.
DotProductDistance = 3,
}
impl DistanceMeasureType {
/// 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 {
DistanceMeasureType::Unspecified => {
"DISTANCE_MEASURE_TYPE_UNSPECIFIED"
}
DistanceMeasureType::SquaredL2Distance => "SQUARED_L2_DISTANCE",
DistanceMeasureType::CosineDistance => "COSINE_DISTANCE",
DistanceMeasureType::DotProductDistance => "DOT_PRODUCT_DISTANCE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DISTANCE_MEASURE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"SQUARED_L2_DISTANCE" => Some(Self::SquaredL2Distance),
"COSINE_DISTANCE" => Some(Self::CosineDistance),
"DOT_PRODUCT_DISTANCE" => Some(Self::DotProductDistance),
_ => None,
}
}
}
/// The configuration with regard to the algorithms used for efficient
/// search.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum AlgorithmConfig {
/// Optional. Configuration options for the tree-AH algorithm (Shallow tree
/// + Asymmetric Hashing). Please refer to this paper for more details:
/// <https://arxiv.org/abs/1908.10396>
#[prost(message, tag = "6")]
TreeAhConfig(TreeAhConfig),
/// Optional. Configuration options for using brute force search, which
/// simply implements the standard linear search in the database for each
/// query. It is primarily meant for benchmarking and to generate the
/// ground truth for approximate search.
#[prost(message, tag = "7")]
BruteForceConfig(BruteForceConfig),
}
}
/// A Feature Registry source for features that need to be synced to Online
/// Store.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureRegistrySource {
/// Required. List of features that need to be synced to Online Store.
#[prost(message, repeated, tag = "1")]
pub feature_groups: ::prost::alloc::vec::Vec<
feature_registry_source::FeatureGroup,
>,
/// Optional. The project number of the parent project of the Feature Groups.
#[prost(int64, optional, tag = "2")]
pub project_number: ::core::option::Option<i64>,
}
/// Nested message and enum types in `FeatureRegistrySource`.
pub mod feature_registry_source {
/// Features belonging to a single feature group that will be
/// synced to Online Store.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureGroup {
/// Required. Identifier of the feature group.
#[prost(string, tag = "1")]
pub feature_group_id: ::prost::alloc::string::String,
/// Required. Identifiers of features under the feature group.
#[prost(string, repeated, tag = "2")]
pub feature_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// Optional. Configures how data is supposed to be extracted from a BigQuery
/// source to be loaded onto the FeatureOnlineStore.
#[prost(message, tag = "6")]
BigQuerySource(BigQuerySource),
/// Optional. Configures the features from a Feature Registry source that
/// need to be loaded onto the FeatureOnlineStore.
#[prost(message, tag = "9")]
FeatureRegistrySource(FeatureRegistrySource),
}
}
/// FeatureViewSync is a representation of sync operation which copies data from
/// data source to Feature View in Online Store.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureViewSync {
/// Identifier. Name of the FeatureViewSync. Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Time when this FeatureViewSync is created. Creation of a
/// FeatureViewSync means that the job is pending / waiting for sufficient
/// resources but may not have started the actual data transfer yet.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when this FeatureViewSync is finished.
#[prost(message, optional, tag = "5")]
pub run_time: ::core::option::Option<super::super::super::r#type::Interval>,
/// Output only. Final status of the FeatureViewSync.
#[prost(message, optional, tag = "4")]
pub final_status: ::core::option::Option<super::super::super::rpc::Status>,
/// Output only. Summary of the sync job.
#[prost(message, optional, tag = "6")]
pub sync_summary: ::core::option::Option<feature_view_sync::SyncSummary>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "7")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "8")]
pub satisfies_pzi: bool,
}
/// Nested message and enum types in `FeatureViewSync`.
pub mod feature_view_sync {
/// Summary from the Sync job. For continuous syncs, the summary is updated
/// periodically. For batch syncs, it gets updated on completion of the sync.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SyncSummary {
/// Output only. Total number of rows synced.
#[prost(int64, tag = "1")]
pub row_synced: i64,
/// Output only. BigQuery slot milliseconds consumed for the sync job.
#[prost(int64, tag = "2")]
pub total_slot: i64,
}
}
/// Request message for
/// [FeatureOnlineStoreAdminService.CreateFeatureOnlineStore][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.CreateFeatureOnlineStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeatureOnlineStoreRequest {
/// Required. The resource name of the Location to create FeatureOnlineStores.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The FeatureOnlineStore to create.
#[prost(message, optional, tag = "2")]
pub feature_online_store: ::core::option::Option<FeatureOnlineStore>,
/// Required. The ID to use for this FeatureOnlineStore, which will become the
/// final component of the FeatureOnlineStore's resource name.
///
/// This value may be up to 60 characters, and valid characters are
/// `\[a-z0-9_\]`. The first character cannot be a number.
///
/// The value must be unique within the project and location.
#[prost(string, tag = "3")]
pub feature_online_store_id: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.GetFeatureOnlineStore][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.GetFeatureOnlineStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetFeatureOnlineStoreRequest {
/// Required. The name of the FeatureOnlineStore resource.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.ListFeatureOnlineStores][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeatureOnlineStoresRequest {
/// Required. The resource name of the Location to list FeatureOnlineStores.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the FeatureOnlineStores that match the filter expression. The
/// following fields are supported:
///
/// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be
/// in RFC 3339 format.
/// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be
/// in RFC 3339 format.
/// * `labels`: Supports key-value equality and key presence.
///
/// Examples:
///
/// * `create_time > "2020-01-01" OR update_time > "2020-01-01"`
/// FeatureOnlineStores created or updated after 2020-01-01.
/// * `labels.env = "prod"`
/// FeatureOnlineStores with label "env" set to "prod".
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of FeatureOnlineStores to return. The service may return
/// fewer than this value. If unspecified, at most 100 FeatureOnlineStores will
/// be returned. The maximum value is 100; any value greater than 100 will be
/// coerced to 100.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [FeatureOnlineStoreAdminService.ListFeatureOnlineStores][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [FeatureOnlineStoreAdminService.ListFeatureOnlineStores][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
/// Supported Fields:
///
/// * `create_time`
/// * `update_time`
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [FeatureOnlineStoreAdminService.ListFeatureOnlineStores][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeatureOnlineStoresResponse {
/// The FeatureOnlineStores matching the request.
#[prost(message, repeated, tag = "1")]
pub feature_online_stores: ::prost::alloc::vec::Vec<FeatureOnlineStore>,
/// A token, which can be sent as
/// [ListFeatureOnlineStoresRequest.page_token][google.cloud.aiplatform.v1.ListFeatureOnlineStoresRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.UpdateFeatureOnlineStore][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.UpdateFeatureOnlineStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeatureOnlineStoreRequest {
/// Required. The FeatureOnlineStore's `name` field is used to identify the
/// FeatureOnlineStore to be updated. Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
#[prost(message, optional, tag = "1")]
pub feature_online_store: ::core::option::Option<FeatureOnlineStore>,
/// Field mask is used to specify the fields to be overwritten in the
/// FeatureOnlineStore resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then only the non-empty fields present in the
/// request will be overwritten. Set the update_mask to `*` to override all
/// fields.
///
/// Updatable fields:
///
/// * `labels`
/// * `description`
/// * `bigtable`
/// * `bigtable.auto_scaling`
/// * `bigtable.enable_multi_region_replica`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.DeleteFeatureOnlineStore][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.DeleteFeatureOnlineStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFeatureOnlineStoreRequest {
/// Required. The name of the FeatureOnlineStore to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// If set to true, any FeatureViews and Features for this FeatureOnlineStore
/// will also be deleted. (Otherwise, the request will only work if the
/// FeatureOnlineStore has no FeatureViews.)
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.CreateFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.CreateFeatureView].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeatureViewRequest {
/// Required. The resource name of the FeatureOnlineStore to create
/// FeatureViews. Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The FeatureView to create.
#[prost(message, optional, tag = "2")]
pub feature_view: ::core::option::Option<FeatureView>,
/// Required. The ID to use for the FeatureView, which will become the final
/// component of the FeatureView's resource name.
///
/// This value may be up to 60 characters, and valid characters are
/// `\[a-z0-9_\]`. The first character cannot be a number.
///
/// The value must be unique within a FeatureOnlineStore.
#[prost(string, tag = "3")]
pub feature_view_id: ::prost::alloc::string::String,
/// Immutable. If set to true, one on demand sync will be run immediately,
/// regardless whether the
/// [FeatureView.sync_config][google.cloud.aiplatform.v1.FeatureView.sync_config]
/// is configured or not.
#[prost(bool, tag = "4")]
pub run_sync_immediately: bool,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.GetFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.GetFeatureView].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetFeatureViewRequest {
/// Required. The name of the FeatureView resource.
/// Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.ListFeatureViews][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViews].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeatureViewsRequest {
/// Required. The resource name of the FeatureOnlineStore to list FeatureViews.
/// Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the FeatureViews that match the filter expression. The following
/// filters are supported:
///
/// * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
/// Values must be in RFC 3339 format.
/// * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
/// Values must be in RFC 3339 format.
/// * `labels`: Supports key-value equality as well as key presence.
///
/// Examples:
///
/// * `create_time > \"2020-01-31T15:30:00.000000Z\" OR
/// update_time > \"2020-01-31T15:30:00.000000Z\"` --> FeatureViews
/// created or updated after 2020-01-31T15:30:00.000000Z.
/// * `labels.active = yes AND labels.env = prod` --> FeatureViews having both
/// (active: yes) and (env: prod) labels.
/// * `labels.env: *` --> Any FeatureView which has a label with 'env' as the
/// key.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of FeatureViews to return. The service may return fewer
/// than this value. If unspecified, at most 1000 FeatureViews will be
/// returned. The maximum value is 1000; any value greater than 1000 will be
/// coerced to 1000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [FeatureOnlineStoreAdminService.ListFeatureViews][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViews]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [FeatureOnlineStoreAdminService.ListFeatureViews][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViews]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
///
/// Supported fields:
///
/// * `feature_view_id`
/// * `create_time`
/// * `update_time`
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [FeatureOnlineStoreAdminService.ListFeatureViews][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViews].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeatureViewsResponse {
/// The FeatureViews matching the request.
#[prost(message, repeated, tag = "1")]
pub feature_views: ::prost::alloc::vec::Vec<FeatureView>,
/// A token, which can be sent as
/// [ListFeatureViewsRequest.page_token][google.cloud.aiplatform.v1.ListFeatureViewsRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.UpdateFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.UpdateFeatureView].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeatureViewRequest {
/// Required. The FeatureView's `name` field is used to identify the
/// FeatureView to be updated. Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
#[prost(message, optional, tag = "1")]
pub feature_view: ::core::option::Option<FeatureView>,
/// Field mask is used to specify the fields to be overwritten in the
/// FeatureView resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then only the non-empty fields present in the
/// request will be overwritten. Set the update_mask to `*` to override all
/// fields.
///
/// Updatable fields:
///
/// * `labels`
/// * `service_agent_type`
/// * `big_query_source`
/// * `big_query_source.uri`
/// * `big_query_source.entity_id_columns`
/// * `feature_registry_source`
/// * `feature_registry_source.feature_groups`
/// * `sync_config`
/// * `sync_config.cron`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for [FeatureOnlineStoreAdminService.DeleteFeatureViews][].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFeatureViewRequest {
/// Required. The name of the FeatureView to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Details of operations that perform create FeatureOnlineStore.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeatureOnlineStoreOperationMetadata {
/// Operation metadata for FeatureOnlineStore.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform update FeatureOnlineStore.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeatureOnlineStoreOperationMetadata {
/// Operation metadata for FeatureOnlineStore.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform create FeatureView.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFeatureViewOperationMetadata {
/// Operation metadata for FeatureView Create.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform update FeatureView.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFeatureViewOperationMetadata {
/// Operation metadata for FeatureView Update.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.SyncFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.SyncFeatureView].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SyncFeatureViewRequest {
/// Required. Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
#[prost(string, tag = "1")]
pub feature_view: ::prost::alloc::string::String,
}
/// Respose message for
/// [FeatureOnlineStoreAdminService.SyncFeatureView][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.SyncFeatureView].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SyncFeatureViewResponse {
/// Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
#[prost(string, tag = "1")]
pub feature_view_sync: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.GetFeatureViewSync][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.GetFeatureViewSync].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetFeatureViewSyncRequest {
/// Required. The name of the FeatureViewSync resource.
/// Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [FeatureOnlineStoreAdminService.ListFeatureViewSyncs][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeatureViewSyncsRequest {
/// Required. The resource name of the FeatureView to list FeatureViewSyncs.
/// Format:
/// `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the FeatureViewSyncs that match the filter expression. The following
/// filters are supported:
///
/// * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
/// Values must be in RFC 3339 format.
///
/// Examples:
///
/// * `create_time > \"2020-01-31T15:30:00.000000Z\"` --> FeatureViewSyncs
/// created after 2020-01-31T15:30:00.000000Z.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of FeatureViewSyncs to return. The service may return
/// fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will
/// be returned. The maximum value is 1000; any value greater than 1000 will be
/// coerced to 1000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [FeatureOnlineStoreAdminService.ListFeatureViewSyncs][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [FeatureOnlineStoreAdminService.ListFeatureViewSyncs][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
///
/// Supported fields:
///
/// * `create_time`
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [FeatureOnlineStoreAdminService.ListFeatureViewSyncs][google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFeatureViewSyncsResponse {
/// The FeatureViewSyncs matching the request.
#[prost(message, repeated, tag = "1")]
pub feature_view_syncs: ::prost::alloc::vec::Vec<FeatureViewSync>,
/// A token, which can be sent as
/// [ListFeatureViewSyncsRequest.page_token][google.cloud.aiplatform.v1.ListFeatureViewSyncsRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod feature_online_store_admin_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The service that handles CRUD and List for resources for
/// FeatureOnlineStore.
#[derive(Debug, Clone)]
pub struct FeatureOnlineStoreAdminServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> FeatureOnlineStoreAdminServiceClient<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,
) -> FeatureOnlineStoreAdminServiceClient<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,
{
FeatureOnlineStoreAdminServiceClient::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 new FeatureOnlineStore in a given project and location.
pub async fn create_feature_online_store(
&mut self,
request: impl tonic::IntoRequest<super::CreateFeatureOnlineStoreRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService/CreateFeatureOnlineStore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"CreateFeatureOnlineStore",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single FeatureOnlineStore.
pub async fn get_feature_online_store(
&mut self,
request: impl tonic::IntoRequest<super::GetFeatureOnlineStoreRequest>,
) -> std::result::Result<
tonic::Response<super::FeatureOnlineStore>,
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.aiplatform.v1.FeatureOnlineStoreAdminService/GetFeatureOnlineStore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"GetFeatureOnlineStore",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists FeatureOnlineStores in a given project and location.
pub async fn list_feature_online_stores(
&mut self,
request: impl tonic::IntoRequest<super::ListFeatureOnlineStoresRequest>,
) -> std::result::Result<
tonic::Response<super::ListFeatureOnlineStoresResponse>,
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.aiplatform.v1.FeatureOnlineStoreAdminService/ListFeatureOnlineStores",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"ListFeatureOnlineStores",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single FeatureOnlineStore.
pub async fn update_feature_online_store(
&mut self,
request: impl tonic::IntoRequest<super::UpdateFeatureOnlineStoreRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService/UpdateFeatureOnlineStore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"UpdateFeatureOnlineStore",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not
/// contain any FeatureViews.
pub async fn delete_feature_online_store(
&mut self,
request: impl tonic::IntoRequest<super::DeleteFeatureOnlineStoreRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService/DeleteFeatureOnlineStore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"DeleteFeatureOnlineStore",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new FeatureView in a given FeatureOnlineStore.
pub async fn create_feature_view(
&mut self,
request: impl tonic::IntoRequest<super::CreateFeatureViewRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService/CreateFeatureView",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"CreateFeatureView",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single FeatureView.
pub async fn get_feature_view(
&mut self,
request: impl tonic::IntoRequest<super::GetFeatureViewRequest>,
) -> std::result::Result<tonic::Response<super::FeatureView>, 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.aiplatform.v1.FeatureOnlineStoreAdminService/GetFeatureView",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"GetFeatureView",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists FeatureViews in a given FeatureOnlineStore.
pub async fn list_feature_views(
&mut self,
request: impl tonic::IntoRequest<super::ListFeatureViewsRequest>,
) -> std::result::Result<
tonic::Response<super::ListFeatureViewsResponse>,
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.aiplatform.v1.FeatureOnlineStoreAdminService/ListFeatureViews",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"ListFeatureViews",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single FeatureView.
pub async fn update_feature_view(
&mut self,
request: impl tonic::IntoRequest<super::UpdateFeatureViewRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService/UpdateFeatureView",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"UpdateFeatureView",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single FeatureView.
pub async fn delete_feature_view(
&mut self,
request: impl tonic::IntoRequest<super::DeleteFeatureViewRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService/DeleteFeatureView",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"DeleteFeatureView",
),
);
self.inner.unary(req, path, codec).await
}
/// Triggers on-demand sync for the FeatureView.
pub async fn sync_feature_view(
&mut self,
request: impl tonic::IntoRequest<super::SyncFeatureViewRequest>,
) -> std::result::Result<
tonic::Response<super::SyncFeatureViewResponse>,
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.aiplatform.v1.FeatureOnlineStoreAdminService/SyncFeatureView",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"SyncFeatureView",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single FeatureViewSync.
pub async fn get_feature_view_sync(
&mut self,
request: impl tonic::IntoRequest<super::GetFeatureViewSyncRequest>,
) -> std::result::Result<
tonic::Response<super::FeatureViewSync>,
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.aiplatform.v1.FeatureOnlineStoreAdminService/GetFeatureViewSync",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"GetFeatureViewSync",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists FeatureViewSyncs in a given FeatureView.
pub async fn list_feature_view_syncs(
&mut self,
request: impl tonic::IntoRequest<super::ListFeatureViewSyncsRequest>,
) -> std::result::Result<
tonic::Response<super::ListFeatureViewSyncsResponse>,
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.aiplatform.v1.FeatureOnlineStoreAdminService/ListFeatureViewSyncs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService",
"ListFeatureViewSyncs",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// TensorboardTimeSeries maps to times series produced in training runs
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TensorboardTimeSeries {
/// Output only. Name of the TensorboardTimeSeries.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. User provided name of this TensorboardTimeSeries.
/// This value should be unique among all TensorboardTimeSeries resources
/// belonging to the same TensorboardRun resource (parent resource).
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Description of this TensorboardTimeSeries.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Required. Immutable. Type of TensorboardTimeSeries value.
#[prost(enumeration = "tensorboard_time_series::ValueType", tag = "4")]
pub value_type: i32,
/// Output only. Timestamp when this TensorboardTimeSeries was created.
#[prost(message, optional, tag = "5")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this TensorboardTimeSeries was last updated.
#[prost(message, optional, tag = "6")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Used to perform a consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "7")]
pub etag: ::prost::alloc::string::String,
/// Immutable. Name of the plugin this time series pertain to. Such as Scalar,
/// Tensor, Blob
#[prost(string, tag = "8")]
pub plugin_name: ::prost::alloc::string::String,
/// Data of the current plugin, with the size limited to 65KB.
#[prost(bytes = "bytes", tag = "9")]
pub plugin_data: ::prost::bytes::Bytes,
/// Output only. Scalar, Tensor, or Blob metadata for this
/// TensorboardTimeSeries.
#[prost(message, optional, tag = "10")]
pub metadata: ::core::option::Option<tensorboard_time_series::Metadata>,
}
/// Nested message and enum types in `TensorboardTimeSeries`.
pub mod tensorboard_time_series {
/// Describes metadata for a TensorboardTimeSeries.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Metadata {
/// Output only. Max step index of all data points within a
/// TensorboardTimeSeries.
#[prost(int64, tag = "1")]
pub max_step: i64,
/// Output only. Max wall clock timestamp of all data points within a
/// TensorboardTimeSeries.
#[prost(message, optional, tag = "2")]
pub max_wall_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The largest blob sequence length (number of blobs) of all
/// data points in this time series, if its ValueType is BLOB_SEQUENCE.
#[prost(int64, tag = "3")]
pub max_blob_sequence_length: i64,
}
/// An enum representing the value type of a TensorboardTimeSeries.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ValueType {
/// The value type is unspecified.
Unspecified = 0,
/// Used for TensorboardTimeSeries that is a list of scalars.
/// E.g. accuracy of a model over epochs/time.
Scalar = 1,
/// Used for TensorboardTimeSeries that is a list of tensors.
/// E.g. histograms of weights of layer in a model over epoch/time.
Tensor = 2,
/// Used for TensorboardTimeSeries that is a list of blob sequences.
/// E.g. set of sample images with labels over epochs/time.
BlobSequence = 3,
}
impl ValueType {
/// 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 {
ValueType::Unspecified => "VALUE_TYPE_UNSPECIFIED",
ValueType::Scalar => "SCALAR",
ValueType::Tensor => "TENSOR",
ValueType::BlobSequence => "BLOB_SEQUENCE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"VALUE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"SCALAR" => Some(Self::Scalar),
"TENSOR" => Some(Self::Tensor),
"BLOB_SEQUENCE" => Some(Self::BlobSequence),
_ => None,
}
}
}
}
/// References an API call. It contains more information about long running
/// operation and Jobs that are triggered by the API call.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UserActionReference {
/// The method name of the API RPC call. For example,
/// "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset"
#[prost(string, tag = "3")]
pub method: ::prost::alloc::string::String,
#[prost(oneof = "user_action_reference::Reference", tags = "1, 2")]
pub reference: ::core::option::Option<user_action_reference::Reference>,
}
/// Nested message and enum types in `UserActionReference`.
pub mod user_action_reference {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Reference {
/// For API calls that return a long running operation.
/// Resource name of the long running operation.
/// Format:
/// `projects/{project}/locations/{location}/operations/{operation}`
#[prost(string, tag = "1")]
Operation(::prost::alloc::string::String),
/// For API calls that start a LabelingJob.
/// Resource name of the LabelingJob.
/// Format:
/// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
#[prost(string, tag = "2")]
DataLabelingJob(::prost::alloc::string::String),
}
}
/// Used to assign specific AnnotationSpec to a particular area of a DataItem or
/// the whole part of the DataItem.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Annotation {
/// Output only. Resource name of the Annotation.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. Google Cloud Storage URI points to a YAML file describing
/// [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
/// defined as an [OpenAPI 3.0.2 Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// The schema files that can be used here are found in
/// gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
/// chosen schema must be consistent with the parent Dataset's
/// [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri].
#[prost(string, tag = "2")]
pub payload_schema_uri: ::prost::alloc::string::String,
/// Required. The schema of the payload can be found in
/// [payload_schema][google.cloud.aiplatform.v1.Annotation.payload_schema_uri].
#[prost(message, optional, tag = "3")]
pub payload: ::core::option::Option<::prost_types::Value>,
/// Output only. Timestamp when this Annotation was created.
#[prost(message, optional, tag = "4")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Annotation was last updated.
#[prost(message, optional, tag = "7")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Used to perform consistent read-modify-write updates. If not set,
/// a blind "overwrite" update happens.
#[prost(string, tag = "8")]
pub etag: ::prost::alloc::string::String,
/// Output only. The source of the Annotation.
#[prost(message, optional, tag = "5")]
pub annotation_source: ::core::option::Option<UserActionReference>,
/// Optional. The labels with user-defined metadata to organize your
/// Annotations.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one Annotation(System
/// labels are excluded).
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable. Following system labels exist for each Annotation:
///
/// * "aiplatform.googleapis.com/annotation_set_name":
/// optional, name of the UI's annotation set this Annotation belongs to.
/// If not set, the Annotation is not visible in the UI.
///
/// * "aiplatform.googleapis.com/payload_schema":
/// output only, its value is the
/// [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
/// title.
#[prost(btree_map = "string, string", tag = "6")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
}
/// An edge describing the relationship between an Artifact and an Execution in
/// a lineage graph.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Event {
/// Required. The relative resource name of the Artifact in the Event.
#[prost(string, tag = "1")]
pub artifact: ::prost::alloc::string::String,
/// Output only. The relative resource name of the Execution in the Event.
#[prost(string, tag = "2")]
pub execution: ::prost::alloc::string::String,
/// Output only. Time the Event occurred.
#[prost(message, optional, tag = "3")]
pub event_time: ::core::option::Option<::prost_types::Timestamp>,
/// Required. The type of the Event.
#[prost(enumeration = "event::Type", tag = "4")]
pub r#type: i32,
/// The labels with user-defined metadata to annotate Events.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one Event (System
/// labels are excluded).
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "5")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
}
/// Nested message and enum types in `Event`.
pub mod event {
/// Describes whether an Event's Artifact is the Execution's input or output.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// Unspecified whether input or output of the Execution.
Unspecified = 0,
/// An input of the Execution.
Input = 1,
/// An output of the Execution.
Output = 2,
}
impl Type {
/// 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 {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::Input => "INPUT",
Type::Output => "OUTPUT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"INPUT" => Some(Self::Input),
"OUTPUT" => Some(Self::Output),
_ => None,
}
}
}
}
/// Identifies a concept with which DataItems may be annotated with.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AnnotationSpec {
/// Output only. Resource name of the AnnotationSpec.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user-defined name of the AnnotationSpec.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Output only. Timestamp when this AnnotationSpec was created.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when AnnotationSpec was last updated.
#[prost(message, optional, tag = "4")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Used to perform consistent read-modify-write updates. If not set,
/// a blind "overwrite" update happens.
#[prost(string, tag = "5")]
pub etag: ::prost::alloc::string::String,
}
/// A collection of DataItems and Annotations on them.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Dataset {
/// Output only. Identifier. The resource name of the Dataset.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user-defined name of the Dataset.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The description of the Dataset.
#[prost(string, tag = "16")]
pub description: ::prost::alloc::string::String,
/// Required. Points to a YAML file stored on Google Cloud Storage describing
/// additional information about the Dataset. The schema is defined as an
/// OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
/// found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
#[prost(string, tag = "3")]
pub metadata_schema_uri: ::prost::alloc::string::String,
/// Required. Additional information about the Dataset.
#[prost(message, optional, tag = "8")]
pub metadata: ::core::option::Option<::prost_types::Value>,
/// Output only. The number of DataItems in this Dataset. Only apply for
/// non-structured Dataset.
#[prost(int64, tag = "10")]
pub data_item_count: i64,
/// Output only. Timestamp when this Dataset was created.
#[prost(message, optional, tag = "4")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Dataset was last updated.
#[prost(message, optional, tag = "5")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Used to perform consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "6")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize your Datasets.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one Dataset (System
/// labels are excluded).
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable. Following system labels exist for each Dataset:
///
/// * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
/// value is the
/// [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
/// title.
#[prost(btree_map = "string, string", tag = "7")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// All SavedQueries belong to the Dataset will be returned in List/Get
/// Dataset response. The annotation_specs field
/// will not be populated except for UI cases which will only use
/// [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count].
/// In CreateDataset request, a SavedQuery is created together if
/// this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
/// The SavedQuery should not contain any AnnotationSpec.
#[prost(message, repeated, tag = "9")]
pub saved_queries: ::prost::alloc::vec::Vec<SavedQuery>,
/// Customer-managed encryption key spec for a Dataset. If set, this Dataset
/// and all sub-resources of this Dataset will be secured by this key.
#[prost(message, optional, tag = "11")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. The resource name of the Artifact that was created in
/// MetadataStore when creating the Dataset. The Artifact resource name pattern
/// is
/// `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
#[prost(string, tag = "17")]
pub metadata_artifact: ::prost::alloc::string::String,
/// Optional. Reference to the public base model last used by the dataset. Only
/// set for prompt datasets.
#[prost(string, tag = "18")]
pub model_reference: ::prost::alloc::string::String,
/// Output only. Reserved for future use.
#[prost(bool, tag = "19")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "20")]
pub satisfies_pzi: bool,
}
/// Describes the location from where we import data into a Dataset, together
/// with the labels that will be applied to the DataItems and the Annotations.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportDataConfig {
/// Labels that will be applied to newly imported DataItems. If an identical
/// DataItem as one being imported already exists in the Dataset, then these
/// labels will be appended to these of the already existing one, and if labels
/// with identical key is imported before, the old label value will be
/// overwritten. If two DataItems are identical in the same import data
/// operation, the labels will be combined and if key collision happens in this
/// case, one of the values will be picked randomly. Two DataItems are
/// considered identical if their content bytes are identical (e.g. image bytes
/// or pdf bytes).
/// These labels will be overridden by Annotation labels specified inside index
/// file referenced by
/// [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri],
/// e.g. jsonl file.
#[prost(btree_map = "string, string", tag = "2")]
pub data_item_labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Labels that will be applied to newly imported Annotations. If two
/// Annotations are identical, one of them will be deduped. Two Annotations are
/// considered identical if their
/// [payload][google.cloud.aiplatform.v1.Annotation.payload],
/// [payload_schema_uri][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
/// and all of their [labels][google.cloud.aiplatform.v1.Annotation.labels] are
/// the same. These labels will be overridden by Annotation labels specified
/// inside index file referenced by
/// [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri],
/// e.g. jsonl file.
#[prost(btree_map = "string, string", tag = "3")]
pub annotation_labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Required. Points to a YAML file stored on Google Cloud Storage describing
/// the import format. Validation will be done against the schema. The schema
/// is defined as an [OpenAPI 3.0.2 Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
#[prost(string, tag = "4")]
pub import_schema_uri: ::prost::alloc::string::String,
/// The source of the input.
#[prost(oneof = "import_data_config::Source", tags = "1")]
pub source: ::core::option::Option<import_data_config::Source>,
}
/// Nested message and enum types in `ImportDataConfig`.
pub mod import_data_config {
/// The source of the input.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// The Google Cloud Storage location for the input content.
#[prost(message, tag = "1")]
GcsSource(super::GcsSource),
}
}
/// Describes what part of the Dataset is to be exported, the destination of
/// the export and how to export.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportDataConfig {
/// An expression for filtering what part of the Dataset is to be exported.
/// Only Annotations that match this filter will be exported. The filter syntax
/// is the same as in
/// [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
#[prost(string, tag = "2")]
pub annotations_filter: ::prost::alloc::string::String,
/// The ID of a SavedQuery (annotation set) under the Dataset specified by
/// [dataset_id][] used for filtering Annotations for training.
///
/// Only used for custom training data export use cases.
/// Only applicable to Datasets that have SavedQueries.
///
/// Only Annotations that are associated with this SavedQuery are used in
/// respectively training. When used in conjunction with
/// [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter],
/// the Annotations used for training are filtered by both
/// [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id]
/// and
/// [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter].
///
/// Only one of
/// [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id]
/// and
/// [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri]
/// should be specified as both of them represent the same thing: problem type.
#[prost(string, tag = "11")]
pub saved_query_id: ::prost::alloc::string::String,
/// The Cloud Storage URI that points to a YAML file describing the annotation
/// schema. The schema is defined as an OpenAPI 3.0.2 [Schema
/// Object](<https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject>).
/// The schema files that can be used here are found in
/// gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
/// chosen schema must be consistent with
/// [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the
/// Dataset specified by [dataset_id][].
///
/// Only used for custom training data export use cases.
/// Only applicable to Datasets that have DataItems and Annotations.
///
/// Only Annotations that both match this schema and belong to DataItems not
/// ignored by the split method are used in respectively training, validation
/// or test role, depending on the role of the DataItem they are on.
///
/// When used in conjunction with
/// [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter],
/// the Annotations used for training are filtered by both
/// [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter]
/// and
/// [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri].
#[prost(string, tag = "12")]
pub annotation_schema_uri: ::prost::alloc::string::String,
/// Indicates the usage of the exported files.
#[prost(enumeration = "export_data_config::ExportUse", tag = "4")]
pub export_use: i32,
/// The destination of the output.
#[prost(oneof = "export_data_config::Destination", tags = "1")]
pub destination: ::core::option::Option<export_data_config::Destination>,
/// The instructions how the export data should be split between the
/// training, validation and test sets.
#[prost(oneof = "export_data_config::Split", tags = "5, 7")]
pub split: ::core::option::Option<export_data_config::Split>,
}
/// Nested message and enum types in `ExportDataConfig`.
pub mod export_data_config {
/// ExportUse indicates the usage of the exported files. It restricts file
/// destination, format, annotations to be exported, whether to allow
/// unannotated data to be exported and whether to clone files to temp Cloud
/// Storage bucket.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ExportUse {
/// Regular user export.
Unspecified = 0,
/// Export for custom code training.
CustomCodeTraining = 6,
}
impl ExportUse {
/// 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 {
ExportUse::Unspecified => "EXPORT_USE_UNSPECIFIED",
ExportUse::CustomCodeTraining => "CUSTOM_CODE_TRAINING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"EXPORT_USE_UNSPECIFIED" => Some(Self::Unspecified),
"CUSTOM_CODE_TRAINING" => Some(Self::CustomCodeTraining),
_ => None,
}
}
}
/// The destination of the output.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Destination {
/// The Google Cloud Storage location where the output is to be written to.
/// In the given directory a new directory will be created with name:
/// `export-data-<dataset-display-name>-<timestamp-of-export-call>` where
/// timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export
/// output will be written into that directory. Inside that directory,
/// annotations with the same schema will be grouped into sub directories
/// which are named with the corresponding annotations' schema title. Inside
/// these sub directories, a schema.yaml will be created to describe the
/// output format.
#[prost(message, tag = "1")]
GcsDestination(super::GcsDestination),
}
/// The instructions how the export data should be split between the
/// training, validation and test sets.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Split {
/// Split based on fractions defining the size of each set.
#[prost(message, tag = "5")]
FractionSplit(super::ExportFractionSplit),
/// Split based on the provided filters for each set.
#[prost(message, tag = "7")]
FilterSplit(super::ExportFilterSplit),
}
}
/// Assigns the input data to training, validation, and test sets as per the
/// given fractions. Any of `training_fraction`, `validation_fraction` and
/// `test_fraction` may optionally be provided, they must sum to up to 1. If the
/// provided ones sum to less than 1, the remainder is assigned to sets as
/// decided by Vertex AI. If none of the fractions are set, by default roughly
/// 80% of data is used for training, 10% for validation, and 10% for test.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ExportFractionSplit {
/// The fraction of the input data that is to be used to train the Model.
#[prost(double, tag = "1")]
pub training_fraction: f64,
/// The fraction of the input data that is to be used to validate the Model.
#[prost(double, tag = "2")]
pub validation_fraction: f64,
/// The fraction of the input data that is to be used to evaluate the Model.
#[prost(double, tag = "3")]
pub test_fraction: f64,
}
/// Assigns input data to training, validation, and test sets based on the given
/// filters, data pieces not matched by any filter are ignored. Currently only
/// supported for Datasets containing DataItems.
/// If any of the filters in this message are to match nothing, then they can be
/// set as '-' (the minus sign).
///
/// Supported only for unstructured Datasets.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportFilterSplit {
/// Required. A filter on DataItems of the Dataset. DataItems that match
/// this filter are used to train the Model. A filter with same syntax
/// as the one used in
/// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
/// may be used. If a single DataItem is matched by more than one of the
/// FilterSplit filters, then it is assigned to the first set that applies to
/// it in the training, validation, test order.
#[prost(string, tag = "1")]
pub training_filter: ::prost::alloc::string::String,
/// Required. A filter on DataItems of the Dataset. DataItems that match
/// this filter are used to validate the Model. A filter with same syntax
/// as the one used in
/// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
/// may be used. If a single DataItem is matched by more than one of the
/// FilterSplit filters, then it is assigned to the first set that applies to
/// it in the training, validation, test order.
#[prost(string, tag = "2")]
pub validation_filter: ::prost::alloc::string::String,
/// Required. A filter on DataItems of the Dataset. DataItems that match
/// this filter are used to test the Model. A filter with same syntax
/// as the one used in
/// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
/// may be used. If a single DataItem is matched by more than one of the
/// FilterSplit filters, then it is assigned to the first set that applies to
/// it in the training, validation, test order.
#[prost(string, tag = "3")]
pub test_filter: ::prost::alloc::string::String,
}
/// Describes the dataset version.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DatasetVersion {
/// Output only. Identifier. The resource name of the DatasetVersion.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Timestamp when this DatasetVersion was created.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this DatasetVersion was last updated.
#[prost(message, optional, tag = "6")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Used to perform consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "3")]
pub etag: ::prost::alloc::string::String,
/// Output only. Name of the associated BigQuery dataset.
#[prost(string, tag = "4")]
pub big_query_dataset_name: ::prost::alloc::string::String,
/// The user-defined name of the DatasetVersion.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "7")]
pub display_name: ::prost::alloc::string::String,
/// Required. Output only. Additional information about the DatasetVersion.
#[prost(message, optional, tag = "8")]
pub metadata: ::core::option::Option<::prost_types::Value>,
/// Output only. Reference to the public base model last used by the dataset
/// version. Only set for prompt dataset versions.
#[prost(string, tag = "9")]
pub model_reference: ::prost::alloc::string::String,
/// Output only. Reserved for future use.
#[prost(bool, tag = "10")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "11")]
pub satisfies_pzi: bool,
}
/// Request message for
/// [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDatasetRequest {
/// Required. The resource name of the Location to create the Dataset in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Dataset to create.
#[prost(message, optional, tag = "2")]
pub dataset: ::core::option::Option<Dataset>,
}
/// Runtime operation information for
/// [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDatasetOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [DatasetService.GetDataset][google.cloud.aiplatform.v1.DatasetService.GetDataset].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetDatasetRequest {
/// Required. The name of the Dataset resource.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "2")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DatasetService.UpdateDataset][google.cloud.aiplatform.v1.DatasetService.UpdateDataset].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateDatasetRequest {
/// Required. The Dataset which replaces the resource on the server.
#[prost(message, optional, tag = "1")]
pub dataset: ::core::option::Option<Dataset>,
/// Required. The update mask applies to the resource.
/// For the `FieldMask` definition, see
/// [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:
///
/// * `display_name`
/// * `description`
/// * `labels`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DatasetService.UpdateDatasetVersion][google.cloud.aiplatform.v1.DatasetService.UpdateDatasetVersion].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateDatasetVersionRequest {
/// Required. The DatasetVersion which replaces the resource on the server.
#[prost(message, optional, tag = "1")]
pub dataset_version: ::core::option::Option<DatasetVersion>,
/// Required. The update mask applies to the resource.
/// For the `FieldMask` definition, see
/// [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:
///
/// * `display_name`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDatasetsRequest {
/// Required. The name of the Dataset's parent resource.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// An expression for filtering the results of the request. For field names
/// both snake_case and camelCase are supported.
///
/// * `display_name`: supports = and !=
/// * `metadata_schema_uri`: supports = and !=
/// * `labels` supports general map functions that is:
/// * `labels.key=value` - key:value equality
/// * `labels.key:* or labels:key - key existence
/// * A key including a space must be quoted. `labels."a key"`.
///
/// Some examples:
///
/// * `displayName="myDisplayName"`
/// * `labels.myKey="myValue"`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
/// Supported fields:
///
/// * `display_name`
/// * `create_time`
/// * `update_time`
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDatasetsResponse {
/// A list of Datasets that matches the specified filter in the request.
#[prost(message, repeated, tag = "1")]
pub datasets: ::prost::alloc::vec::Vec<Dataset>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [DatasetService.DeleteDataset][google.cloud.aiplatform.v1.DatasetService.DeleteDataset].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDatasetRequest {
/// Required. The resource name of the Dataset to delete.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportDataRequest {
/// Required. The name of the Dataset resource.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The desired input locations. The contents of all input locations
/// will be imported in one batch.
#[prost(message, repeated, tag = "2")]
pub import_configs: ::prost::alloc::vec::Vec<ImportDataConfig>,
}
/// Response message for
/// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ImportDataResponse {}
/// Runtime operation information for
/// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportDataOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportDataRequest {
/// Required. The name of the Dataset resource.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The desired output location.
#[prost(message, optional, tag = "2")]
pub export_config: ::core::option::Option<ExportDataConfig>,
}
/// Response message for
/// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportDataResponse {
/// All of the files that are exported in this export operation. For custom
/// code training export, only three (training, validation and test)
/// Cloud Storage paths in wildcard format are populated
/// (for example, gs://.../training-*).
#[prost(string, repeated, tag = "1")]
pub exported_files: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Only present for custom code training export use case. Records data stats,
/// i.e., train/validation/test item/annotation counts calculated during
/// the export operation.
#[prost(message, optional, tag = "2")]
pub data_stats: ::core::option::Option<model::DataStats>,
}
/// Runtime operation information for
/// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportDataOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// A Google Cloud Storage directory which path ends with '/'. The exported
/// data is stored in the directory.
#[prost(string, tag = "2")]
pub gcs_output_directory: ::prost::alloc::string::String,
}
/// Request message for
/// [DatasetService.CreateDatasetVersion][google.cloud.aiplatform.v1.DatasetService.CreateDatasetVersion].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDatasetVersionRequest {
/// Required. The name of the Dataset resource.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The version to be created. The same CMEK policies with the
/// original Dataset will be applied the dataset version. So here we don't need
/// to specify the EncryptionSpecType here.
#[prost(message, optional, tag = "2")]
pub dataset_version: ::core::option::Option<DatasetVersion>,
}
/// Runtime operation information for
/// [DatasetService.CreateDatasetVersion][google.cloud.aiplatform.v1.DatasetService.CreateDatasetVersion].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDatasetVersionOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [DatasetService.DeleteDatasetVersion][google.cloud.aiplatform.v1.DatasetService.DeleteDatasetVersion].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDatasetVersionRequest {
/// Required. The resource name of the Dataset version to delete.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [DatasetService.GetDatasetVersion][google.cloud.aiplatform.v1.DatasetService.GetDatasetVersion].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetDatasetVersionRequest {
/// Required. The resource name of the Dataset version to delete.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "2")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DatasetService.ListDatasetVersions][google.cloud.aiplatform.v1.DatasetService.ListDatasetVersions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDatasetVersionsRequest {
/// Required. The resource name of the Dataset to list DatasetVersions from.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The standard list filter.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. The standard list page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Optional. Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Optional. A comma-separated list of fields to order by, sorted in ascending
/// order. Use "desc" after a field name for descending.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [DatasetService.ListDatasetVersions][google.cloud.aiplatform.v1.DatasetService.ListDatasetVersions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDatasetVersionsResponse {
/// A list of DatasetVersions that matches the specified filter in the request.
#[prost(message, repeated, tag = "1")]
pub dataset_versions: ::prost::alloc::vec::Vec<DatasetVersion>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [DatasetService.RestoreDatasetVersion][google.cloud.aiplatform.v1.DatasetService.RestoreDatasetVersion].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RestoreDatasetVersionRequest {
/// Required. The name of the DatasetVersion resource.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Runtime operation information for
/// [DatasetService.RestoreDatasetVersion][google.cloud.aiplatform.v1.DatasetService.RestoreDatasetVersion].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RestoreDatasetVersionOperationMetadata {
/// The common part of the operation metadata.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDataItemsRequest {
/// Required. The resource name of the Dataset to list DataItems from.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDataItemsResponse {
/// A list of DataItems that matches the specified filter in the request.
#[prost(message, repeated, tag = "1")]
pub data_items: ::prost::alloc::vec::Vec<DataItem>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchDataItemsRequest {
/// Required. The resource name of the Dataset from which to search DataItems.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, tag = "1")]
pub dataset: ::prost::alloc::string::String,
/// The resource name of a SavedQuery(annotation set in UI).
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
/// All of the search will be done in the context of this SavedQuery.
#[deprecated]
#[prost(string, tag = "2")]
pub saved_query: ::prost::alloc::string::String,
/// The resource name of a DataLabelingJob.
/// Format:
/// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
/// If this field is set, all of the search will be done in the context of
/// this DataLabelingJob.
#[prost(string, tag = "3")]
pub data_labeling_job: ::prost::alloc::string::String,
/// An expression for filtering the DataItem that will be returned.
///
/// * `data_item_id` - for = or !=.
/// * `labeled` - for = or !=.
/// * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
/// have at least one annotation with annotation_spec_id =
/// `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
///
/// For example:
///
/// * `data_item=1`
/// * `has_annotation(5)`
#[prost(string, tag = "4")]
pub data_item_filter: ::prost::alloc::string::String,
/// An expression for filtering the Annotations that will be returned per
/// DataItem.
/// * `annotation_spec_id` - for = or !=.
#[deprecated]
#[prost(string, tag = "5")]
pub annotations_filter: ::prost::alloc::string::String,
/// An expression that specifies what Annotations will be returned per
/// DataItem. Annotations satisfied either of the conditions will be returned.
/// * `annotation_spec_id` - for = or !=.
/// Must specify `saved_query_id=` - saved query id that annotations should
/// belong to.
#[prost(string, repeated, tag = "11")]
pub annotation_filters: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Mask specifying which fields of
/// [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
#[prost(message, optional, tag = "6")]
pub field_mask: ::core::option::Option<::prost_types::FieldMask>,
/// If set, only up to this many of Annotations will be returned per
/// DataItemView. The maximum value is 1000. If not set, the maximum value will
/// be used.
#[prost(int32, tag = "7")]
pub annotations_limit: i32,
/// Requested page size. Server may return fewer results than requested.
/// Default and maximum page size is 100.
#[prost(int32, tag = "8")]
pub page_size: i32,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
#[deprecated]
#[prost(string, tag = "9")]
pub order_by: ::prost::alloc::string::String,
/// A token identifying a page of results for the server to return
/// Typically obtained via
/// [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token]
/// of the previous
/// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]
/// call.
#[prost(string, tag = "10")]
pub page_token: ::prost::alloc::string::String,
#[prost(oneof = "search_data_items_request::Order", tags = "12, 13")]
pub order: ::core::option::Option<search_data_items_request::Order>,
}
/// Nested message and enum types in `SearchDataItemsRequest`.
pub mod search_data_items_request {
/// Expression that allows ranking results based on annotation's property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OrderByAnnotation {
/// Required. Saved query of the Annotation. Only Annotations belong to this
/// saved query will be considered for ordering.
#[prost(string, tag = "1")]
pub saved_query: ::prost::alloc::string::String,
/// A comma-separated list of annotation fields to order by, sorted in
/// ascending order. Use "desc" after a field name for descending. Must also
/// specify saved_query.
#[prost(string, tag = "2")]
pub order_by: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Order {
/// A comma-separated list of data item fields to order by, sorted in
/// ascending order. Use "desc" after a field name for descending.
#[prost(string, tag = "12")]
OrderByDataItem(::prost::alloc::string::String),
/// Expression that allows ranking results based on annotation's property.
#[prost(message, tag = "13")]
OrderByAnnotation(OrderByAnnotation),
}
}
/// Response message for
/// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchDataItemsResponse {
/// The DataItemViews read.
#[prost(message, repeated, tag = "1")]
pub data_item_views: ::prost::alloc::vec::Vec<DataItemView>,
/// A token to retrieve next page of results.
/// Pass to
/// [SearchDataItemsRequest.page_token][google.cloud.aiplatform.v1.SearchDataItemsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// A container for a single DataItem and Annotations on it.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataItemView {
/// The DataItem.
#[prost(message, optional, tag = "1")]
pub data_item: ::core::option::Option<DataItem>,
/// The Annotations on the DataItem. If too many Annotations should be returned
/// for the DataItem, this field will be truncated per annotations_limit in
/// request. If it was, then the has_truncated_annotations will be set to true.
#[prost(message, repeated, tag = "2")]
pub annotations: ::prost::alloc::vec::Vec<Annotation>,
/// True if and only if the Annotations field has been truncated. It happens if
/// more Annotations for this DataItem met the request's annotation_filter than
/// are allowed to be returned by annotations_limit.
/// Note that if Annotations field is not being returned due to field mask,
/// then this field will not be set to true no matter how many Annotations are
/// there.
#[prost(bool, tag = "3")]
pub has_truncated_annotations: bool,
}
/// Request message for
/// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSavedQueriesRequest {
/// Required. The resource name of the Dataset to list SavedQueries from.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSavedQueriesResponse {
/// A list of SavedQueries that match the specified filter in the request.
#[prost(message, repeated, tag = "1")]
pub saved_queries: ::prost::alloc::vec::Vec<SavedQuery>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [DatasetService.DeleteSavedQuery][google.cloud.aiplatform.v1.DatasetService.DeleteSavedQuery].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSavedQueryRequest {
/// Required. The resource name of the SavedQuery to delete.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetAnnotationSpecRequest {
/// Required. The name of the AnnotationSpec resource.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "2")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListAnnotationsRequest {
/// Required. The resource name of the DataItem to list Annotations from.
/// Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// A comma-separated list of fields to order by, sorted in ascending order.
/// Use "desc" after a field name for descending.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListAnnotationsResponse {
/// A list of Annotations that matches the specified filter in the request.
#[prost(message, repeated, tag = "1")]
pub annotations: ::prost::alloc::vec::Vec<Annotation>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod dataset_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The service that manages Vertex AI Dataset and its child resources.
#[derive(Debug, Clone)]
pub struct DatasetServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> DatasetServiceClient<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,
) -> DatasetServiceClient<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,
{
DatasetServiceClient::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 Dataset.
pub async fn create_dataset(
&mut self,
request: impl tonic::IntoRequest<super::CreateDatasetRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DatasetService/CreateDataset",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"CreateDataset",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a Dataset.
pub async fn get_dataset(
&mut self,
request: impl tonic::IntoRequest<super::GetDatasetRequest>,
) -> std::result::Result<tonic::Response<super::Dataset>, 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.aiplatform.v1.DatasetService/GetDataset",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"GetDataset",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a Dataset.
pub async fn update_dataset(
&mut self,
request: impl tonic::IntoRequest<super::UpdateDatasetRequest>,
) -> std::result::Result<tonic::Response<super::Dataset>, 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.aiplatform.v1.DatasetService/UpdateDataset",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"UpdateDataset",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Datasets in a Location.
pub async fn list_datasets(
&mut self,
request: impl tonic::IntoRequest<super::ListDatasetsRequest>,
) -> std::result::Result<
tonic::Response<super::ListDatasetsResponse>,
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.aiplatform.v1.DatasetService/ListDatasets",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"ListDatasets",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a Dataset.
pub async fn delete_dataset(
&mut self,
request: impl tonic::IntoRequest<super::DeleteDatasetRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DatasetService/DeleteDataset",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"DeleteDataset",
),
);
self.inner.unary(req, path, codec).await
}
/// Imports data into a Dataset.
pub async fn import_data(
&mut self,
request: impl tonic::IntoRequest<super::ImportDataRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DatasetService/ImportData",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"ImportData",
),
);
self.inner.unary(req, path, codec).await
}
/// Exports data from a Dataset.
pub async fn export_data(
&mut self,
request: impl tonic::IntoRequest<super::ExportDataRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DatasetService/ExportData",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"ExportData",
),
);
self.inner.unary(req, path, codec).await
}
/// Create a version from a Dataset.
pub async fn create_dataset_version(
&mut self,
request: impl tonic::IntoRequest<super::CreateDatasetVersionRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DatasetService/CreateDatasetVersion",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"CreateDatasetVersion",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a DatasetVersion.
pub async fn update_dataset_version(
&mut self,
request: impl tonic::IntoRequest<super::UpdateDatasetVersionRequest>,
) -> std::result::Result<tonic::Response<super::DatasetVersion>, 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.aiplatform.v1.DatasetService/UpdateDatasetVersion",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"UpdateDatasetVersion",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a Dataset version.
pub async fn delete_dataset_version(
&mut self,
request: impl tonic::IntoRequest<super::DeleteDatasetVersionRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DatasetService/DeleteDatasetVersion",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"DeleteDatasetVersion",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a Dataset version.
pub async fn get_dataset_version(
&mut self,
request: impl tonic::IntoRequest<super::GetDatasetVersionRequest>,
) -> std::result::Result<tonic::Response<super::DatasetVersion>, 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.aiplatform.v1.DatasetService/GetDatasetVersion",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"GetDatasetVersion",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists DatasetVersions in a Dataset.
pub async fn list_dataset_versions(
&mut self,
request: impl tonic::IntoRequest<super::ListDatasetVersionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListDatasetVersionsResponse>,
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.aiplatform.v1.DatasetService/ListDatasetVersions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"ListDatasetVersions",
),
);
self.inner.unary(req, path, codec).await
}
/// Restores a dataset version.
pub async fn restore_dataset_version(
&mut self,
request: impl tonic::IntoRequest<super::RestoreDatasetVersionRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DatasetService/RestoreDatasetVersion",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"RestoreDatasetVersion",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists DataItems in a Dataset.
pub async fn list_data_items(
&mut self,
request: impl tonic::IntoRequest<super::ListDataItemsRequest>,
) -> std::result::Result<
tonic::Response<super::ListDataItemsResponse>,
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.aiplatform.v1.DatasetService/ListDataItems",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"ListDataItems",
),
);
self.inner.unary(req, path, codec).await
}
/// Searches DataItems in a Dataset.
pub async fn search_data_items(
&mut self,
request: impl tonic::IntoRequest<super::SearchDataItemsRequest>,
) -> std::result::Result<
tonic::Response<super::SearchDataItemsResponse>,
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.aiplatform.v1.DatasetService/SearchDataItems",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"SearchDataItems",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists SavedQueries in a Dataset.
pub async fn list_saved_queries(
&mut self,
request: impl tonic::IntoRequest<super::ListSavedQueriesRequest>,
) -> std::result::Result<
tonic::Response<super::ListSavedQueriesResponse>,
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.aiplatform.v1.DatasetService/ListSavedQueries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"ListSavedQueries",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a SavedQuery.
pub async fn delete_saved_query(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSavedQueryRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.DatasetService/DeleteSavedQuery",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"DeleteSavedQuery",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets an AnnotationSpec.
pub async fn get_annotation_spec(
&mut self,
request: impl tonic::IntoRequest<super::GetAnnotationSpecRequest>,
) -> std::result::Result<tonic::Response<super::AnnotationSpec>, 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.aiplatform.v1.DatasetService/GetAnnotationSpec",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"GetAnnotationSpec",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Annotations belongs to a dataitem
pub async fn list_annotations(
&mut self,
request: impl tonic::IntoRequest<super::ListAnnotationsRequest>,
) -> std::result::Result<
tonic::Response<super::ListAnnotationsResponse>,
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.aiplatform.v1.DatasetService/ListAnnotations",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.DatasetService",
"ListAnnotations",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// The objective configuration for model monitoring, including the information
/// needed to detect anomalies for one particular model.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelMonitoringObjectiveConfig {
/// Training dataset for models. This field has to be set only if
/// TrainingPredictionSkewDetectionConfig is specified.
#[prost(message, optional, tag = "1")]
pub training_dataset: ::core::option::Option<
model_monitoring_objective_config::TrainingDataset,
>,
/// The config for skew between training data and prediction data.
#[prost(message, optional, tag = "2")]
pub training_prediction_skew_detection_config: ::core::option::Option<
model_monitoring_objective_config::TrainingPredictionSkewDetectionConfig,
>,
/// The config for drift of prediction data.
#[prost(message, optional, tag = "3")]
pub prediction_drift_detection_config: ::core::option::Option<
model_monitoring_objective_config::PredictionDriftDetectionConfig,
>,
/// The config for integrating with Vertex Explainable AI.
#[prost(message, optional, tag = "5")]
pub explanation_config: ::core::option::Option<
model_monitoring_objective_config::ExplanationConfig,
>,
}
/// Nested message and enum types in `ModelMonitoringObjectiveConfig`.
pub mod model_monitoring_objective_config {
/// Training Dataset information.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TrainingDataset {
/// Data format of the dataset, only applicable if the input is from
/// Google Cloud Storage.
/// The possible formats are:
///
/// "tf-record"
/// The source file is a TFRecord file.
///
/// "csv"
/// The source file is a CSV file.
/// "jsonl"
/// The source file is a JSONL file.
#[prost(string, tag = "2")]
pub data_format: ::prost::alloc::string::String,
/// The target field name the model is to predict.
/// This field will be excluded when doing Predict and (or) Explain for the
/// training data.
#[prost(string, tag = "6")]
pub target_field: ::prost::alloc::string::String,
/// Strategy to sample data from Training Dataset.
/// If not set, we process the whole dataset.
#[prost(message, optional, tag = "7")]
pub logging_sampling_strategy: ::core::option::Option<super::SamplingStrategy>,
#[prost(oneof = "training_dataset::DataSource", tags = "3, 4, 5")]
pub data_source: ::core::option::Option<training_dataset::DataSource>,
}
/// Nested message and enum types in `TrainingDataset`.
pub mod training_dataset {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum DataSource {
/// The resource name of the Dataset used to train this Model.
#[prost(string, tag = "3")]
Dataset(::prost::alloc::string::String),
/// The Google Cloud Storage uri of the unmanaged Dataset used to train
/// this Model.
#[prost(message, tag = "4")]
GcsSource(super::super::GcsSource),
/// The BigQuery table of the unmanaged Dataset used to train this
/// Model.
#[prost(message, tag = "5")]
BigquerySource(super::super::BigQuerySource),
}
}
/// The config for Training & Prediction data skew detection. It specifies the
/// training dataset sources and the skew detection parameters.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TrainingPredictionSkewDetectionConfig {
/// Key is the feature name and value is the threshold. If a feature needs to
/// be monitored for skew, a value threshold must be configured for that
/// feature. The threshold here is against feature distribution distance
/// between the training and prediction feature.
#[prost(btree_map = "string, message", tag = "1")]
pub skew_thresholds: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
super::ThresholdConfig,
>,
/// Key is the feature name and value is the threshold. The threshold here is
/// against attribution score distance between the training and prediction
/// feature.
#[prost(btree_map = "string, message", tag = "2")]
pub attribution_score_skew_thresholds: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
super::ThresholdConfig,
>,
/// Skew anomaly detection threshold used by all features.
/// When the per-feature thresholds are not set, this field can be used to
/// specify a threshold for all features.
#[prost(message, optional, tag = "6")]
pub default_skew_threshold: ::core::option::Option<super::ThresholdConfig>,
}
/// The config for Prediction data drift detection.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PredictionDriftDetectionConfig {
/// Key is the feature name and value is the threshold. If a feature needs to
/// be monitored for drift, a value threshold must be configured for that
/// feature. The threshold here is against feature distribution distance
/// between different time windws.
#[prost(btree_map = "string, message", tag = "1")]
pub drift_thresholds: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
super::ThresholdConfig,
>,
/// Key is the feature name and value is the threshold. The threshold here is
/// against attribution score distance between different time windows.
#[prost(btree_map = "string, message", tag = "2")]
pub attribution_score_drift_thresholds: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
super::ThresholdConfig,
>,
/// Drift anomaly detection threshold used by all features.
/// When the per-feature thresholds are not set, this field can be used to
/// specify a threshold for all features.
#[prost(message, optional, tag = "5")]
pub default_drift_threshold: ::core::option::Option<super::ThresholdConfig>,
}
/// The config for integrating with Vertex Explainable AI. Only applicable if
/// the Model has explanation_spec populated.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplanationConfig {
/// If want to analyze the Vertex Explainable AI feature attribute scores or
/// not. If set to true, Vertex AI will log the feature attributions from
/// explain response and do the skew/drift detection for them.
#[prost(bool, tag = "1")]
pub enable_feature_attributes: bool,
/// Predictions generated by the BatchPredictionJob using baseline dataset.
#[prost(message, optional, tag = "2")]
pub explanation_baseline: ::core::option::Option<
explanation_config::ExplanationBaseline,
>,
}
/// Nested message and enum types in `ExplanationConfig`.
pub mod explanation_config {
/// Output from
/// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] for
/// Model Monitoring baseline dataset, which can be used to generate baseline
/// attribution scores.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplanationBaseline {
/// The storage format of the predictions generated BatchPrediction job.
#[prost(enumeration = "explanation_baseline::PredictionFormat", tag = "1")]
pub prediction_format: i32,
/// The configuration specifying of BatchExplain job output. This can be
/// used to generate the baseline of feature attribution scores.
#[prost(oneof = "explanation_baseline::Destination", tags = "2, 3")]
pub destination: ::core::option::Option<explanation_baseline::Destination>,
}
/// Nested message and enum types in `ExplanationBaseline`.
pub mod explanation_baseline {
/// The storage format of the predictions generated BatchPrediction job.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum PredictionFormat {
/// Should not be set.
Unspecified = 0,
/// Predictions are in JSONL files.
Jsonl = 2,
/// Predictions are in BigQuery.
Bigquery = 3,
}
impl PredictionFormat {
/// 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 {
PredictionFormat::Unspecified => "PREDICTION_FORMAT_UNSPECIFIED",
PredictionFormat::Jsonl => "JSONL",
PredictionFormat::Bigquery => "BIGQUERY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PREDICTION_FORMAT_UNSPECIFIED" => Some(Self::Unspecified),
"JSONL" => Some(Self::Jsonl),
"BIGQUERY" => Some(Self::Bigquery),
_ => None,
}
}
}
/// The configuration specifying of BatchExplain job output. This can be
/// used to generate the baseline of feature attribution scores.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Destination {
/// Cloud Storage location for BatchExplain output.
#[prost(message, tag = "2")]
Gcs(super::super::super::GcsDestination),
/// BigQuery location for BatchExplain output.
#[prost(message, tag = "3")]
Bigquery(super::super::super::BigQueryDestination),
}
}
}
}
/// The alert config for model monitoring.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelMonitoringAlertConfig {
/// Dump the anomalies to Cloud Logging. The anomalies will be put to json
/// payload encoded from proto
/// [google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry][].
/// This can be further sinked to Pub/Sub or any other services supported
/// by Cloud Logging.
#[prost(bool, tag = "2")]
pub enable_logging: bool,
/// Resource names of the NotificationChannels to send alert.
/// Must be of the format
/// `projects/<project_id_or_number>/notificationChannels/<channel_id>`
#[prost(string, repeated, tag = "3")]
pub notification_channels: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
#[prost(oneof = "model_monitoring_alert_config::Alert", tags = "1")]
pub alert: ::core::option::Option<model_monitoring_alert_config::Alert>,
}
/// Nested message and enum types in `ModelMonitoringAlertConfig`.
pub mod model_monitoring_alert_config {
/// The config for email alert.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EmailAlertConfig {
/// The email addresses to send the alert.
#[prost(string, repeated, tag = "1")]
pub user_emails: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Alert {
/// Email alert config.
#[prost(message, tag = "1")]
EmailAlertConfig(EmailAlertConfig),
}
}
/// The config for feature monitoring threshold.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ThresholdConfig {
#[prost(oneof = "threshold_config::Threshold", tags = "1")]
pub threshold: ::core::option::Option<threshold_config::Threshold>,
}
/// Nested message and enum types in `ThresholdConfig`.
pub mod threshold_config {
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Threshold {
/// Specify a threshold value that can trigger the alert.
/// If this threshold config is for feature distribution distance:
/// 1. For categorical feature, the distribution distance is calculated by
/// L-inifinity norm.
/// 2. For numerical feature, the distribution distance is calculated by
/// Jensen–Shannon divergence.
/// Each feature must have a non-zero threshold if they need to be monitored.
/// Otherwise no alert will be triggered for that feature.
#[prost(double, tag = "1")]
Value(f64),
}
}
/// Sampling Strategy for logging, can be for both training and prediction
/// dataset.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SamplingStrategy {
/// Random sample config. Will support more sampling strategies later.
#[prost(message, optional, tag = "1")]
pub random_sample_config: ::core::option::Option<
sampling_strategy::RandomSampleConfig,
>,
}
/// Nested message and enum types in `SamplingStrategy`.
pub mod sampling_strategy {
/// Requests are randomly selected.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RandomSampleConfig {
/// Sample rate (0, 1]
#[prost(double, tag = "1")]
pub sample_rate: f64,
}
}
/// Represents a job that runs periodically to monitor the deployed models in an
/// endpoint. It will analyze the logged training & prediction data to detect any
/// abnormal behaviors.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelDeploymentMonitoringJob {
/// Output only. Resource name of a ModelDeploymentMonitoringJob.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user-defined name of the ModelDeploymentMonitoringJob.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
/// Display name of a ModelDeploymentMonitoringJob.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. Endpoint resource name.
/// Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
#[prost(string, tag = "3")]
pub endpoint: ::prost::alloc::string::String,
/// Output only. The detailed state of the monitoring job.
/// When the job is still creating, the state will be 'PENDING'.
/// Once the job is successfully created, the state will be 'RUNNING'.
/// Pause the job, the state will be 'PAUSED'.
/// Resume the job, the state will return to 'RUNNING'.
#[prost(enumeration = "JobState", tag = "4")]
pub state: i32,
/// Output only. Schedule state when the monitoring job is in Running state.
#[prost(
enumeration = "model_deployment_monitoring_job::MonitoringScheduleState",
tag = "5"
)]
pub schedule_state: i32,
/// Output only. Latest triggered monitoring pipeline metadata.
#[prost(message, optional, tag = "25")]
pub latest_monitoring_pipeline_metadata: ::core::option::Option<
model_deployment_monitoring_job::LatestMonitoringPipelineMetadata,
>,
/// Required. The config for monitoring objectives. This is a per DeployedModel
/// config. Each DeployedModel needs to be configured separately.
#[prost(message, repeated, tag = "6")]
pub model_deployment_monitoring_objective_configs: ::prost::alloc::vec::Vec<
ModelDeploymentMonitoringObjectiveConfig,
>,
/// Required. Schedule config for running the monitoring job.
#[prost(message, optional, tag = "7")]
pub model_deployment_monitoring_schedule_config: ::core::option::Option<
ModelDeploymentMonitoringScheduleConfig,
>,
/// Required. Sample Strategy for logging.
#[prost(message, optional, tag = "8")]
pub logging_sampling_strategy: ::core::option::Option<SamplingStrategy>,
/// Alert config for model monitoring.
#[prost(message, optional, tag = "15")]
pub model_monitoring_alert_config: ::core::option::Option<
ModelMonitoringAlertConfig,
>,
/// YAML schema file uri describing the format of a single instance,
/// which are given to format this Endpoint's prediction (and explanation).
/// If not set, we will generate predict schema from collected predict
/// requests.
#[prost(string, tag = "9")]
pub predict_instance_schema_uri: ::prost::alloc::string::String,
/// Sample Predict instance, same format as
/// [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
/// this can be set as a replacement of
/// [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
/// If not set, we will generate predict schema from collected predict
/// requests.
#[prost(message, optional, tag = "19")]
pub sample_predict_instance: ::core::option::Option<::prost_types::Value>,
/// YAML schema file uri describing the format of a single instance that you
/// want Tensorflow Data Validation (TFDV) to analyze.
///
/// If this field is empty, all the feature data types are inferred from
/// [predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri],
/// meaning that TFDV will use the data in the exact format(data type) as
/// prediction request/response.
/// If there are any data type differences between predict instance and TFDV
/// instance, this field can be used to override the schema.
/// For models trained with Vertex AI, this field must be set as all the
/// fields in predict instance formatted as string.
#[prost(string, tag = "16")]
pub analysis_instance_schema_uri: ::prost::alloc::string::String,
/// Output only. The created bigquery tables for the job under customer
/// project. Customer could do their own query & analysis. There could be 4 log
/// tables in maximum:
/// 1. Training data logging predict request/response
/// 2. Serving data logging predict request/response
#[prost(message, repeated, tag = "10")]
pub bigquery_tables: ::prost::alloc::vec::Vec<
ModelDeploymentMonitoringBigQueryTable,
>,
/// The TTL of BigQuery tables in user projects which stores logs.
/// A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
/// day). e.g. { second: 3600} indicates ttl = 1 day.
#[prost(message, optional, tag = "17")]
pub log_ttl: ::core::option::Option<::prost_types::Duration>,
/// The labels with user-defined metadata to organize your
/// ModelDeploymentMonitoringJob.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "11")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
#[prost(message, optional, tag = "12")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this ModelDeploymentMonitoringJob was updated
/// most recently.
#[prost(message, optional, tag = "13")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this monitoring pipeline will be scheduled to
/// run for the next round.
#[prost(message, optional, tag = "14")]
pub next_schedule_time: ::core::option::Option<::prost_types::Timestamp>,
/// Stats anomalies base folder path.
#[prost(message, optional, tag = "20")]
pub stats_anomalies_base_directory: ::core::option::Option<GcsDestination>,
/// Customer-managed encryption key spec for a ModelDeploymentMonitoringJob. If
/// set, this ModelDeploymentMonitoringJob and all sub-resources of this
/// ModelDeploymentMonitoringJob will be secured by this key.
#[prost(message, optional, tag = "21")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// If true, the scheduled monitoring pipeline logs are sent to
/// Google Cloud Logging, including pipeline status and anomalies detected.
/// Please note the logs incur cost, which are subject to [Cloud Logging
/// pricing](<https://cloud.google.com/logging#pricing>).
#[prost(bool, tag = "22")]
pub enable_monitoring_pipeline_logs: bool,
/// Output only. Only populated when the job's state is `JOB_STATE_FAILED` or
/// `JOB_STATE_CANCELLED`.
#[prost(message, optional, tag = "23")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "26")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "27")]
pub satisfies_pzi: bool,
}
/// Nested message and enum types in `ModelDeploymentMonitoringJob`.
pub mod model_deployment_monitoring_job {
/// All metadata of most recent monitoring pipelines.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LatestMonitoringPipelineMetadata {
/// The time that most recent monitoring pipelines that is related to this
/// run.
#[prost(message, optional, tag = "1")]
pub run_time: ::core::option::Option<::prost_types::Timestamp>,
/// The status of the most recent monitoring pipeline.
#[prost(message, optional, tag = "2")]
pub status: ::core::option::Option<super::super::super::super::rpc::Status>,
}
/// The state to Specify the monitoring pipeline.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum MonitoringScheduleState {
/// Unspecified state.
Unspecified = 0,
/// The pipeline is picked up and wait to run.
Pending = 1,
/// The pipeline is offline and will be scheduled for next run.
Offline = 2,
/// The pipeline is running.
Running = 3,
}
impl MonitoringScheduleState {
/// 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 {
MonitoringScheduleState::Unspecified => {
"MONITORING_SCHEDULE_STATE_UNSPECIFIED"
}
MonitoringScheduleState::Pending => "PENDING",
MonitoringScheduleState::Offline => "OFFLINE",
MonitoringScheduleState::Running => "RUNNING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MONITORING_SCHEDULE_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"PENDING" => Some(Self::Pending),
"OFFLINE" => Some(Self::Offline),
"RUNNING" => Some(Self::Running),
_ => None,
}
}
}
}
/// ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name
/// as well as some information of the logs stored in this table.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelDeploymentMonitoringBigQueryTable {
/// The source of log.
#[prost(
enumeration = "model_deployment_monitoring_big_query_table::LogSource",
tag = "1"
)]
pub log_source: i32,
/// The type of log.
#[prost(
enumeration = "model_deployment_monitoring_big_query_table::LogType",
tag = "2"
)]
pub log_type: i32,
/// The created BigQuery table to store logs. Customer could do their own query
/// & analysis. Format:
/// `bq://<project_id>.model_deployment_monitoring_<endpoint_id>.<tolower(log_source)>_<tolower(log_type)>`
#[prost(string, tag = "3")]
pub bigquery_table_path: ::prost::alloc::string::String,
/// Output only. The schema version of the request/response logging BigQuery
/// table. Default to v1 if unset.
#[prost(string, tag = "4")]
pub request_response_logging_schema_version: ::prost::alloc::string::String,
}
/// Nested message and enum types in `ModelDeploymentMonitoringBigQueryTable`.
pub mod model_deployment_monitoring_big_query_table {
/// Indicates where does the log come from.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum LogSource {
/// Unspecified source.
Unspecified = 0,
/// Logs coming from Training dataset.
Training = 1,
/// Logs coming from Serving traffic.
Serving = 2,
}
impl LogSource {
/// 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 {
LogSource::Unspecified => "LOG_SOURCE_UNSPECIFIED",
LogSource::Training => "TRAINING",
LogSource::Serving => "SERVING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"LOG_SOURCE_UNSPECIFIED" => Some(Self::Unspecified),
"TRAINING" => Some(Self::Training),
"SERVING" => Some(Self::Serving),
_ => None,
}
}
}
/// Indicates what type of traffic does the log belong to.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum LogType {
/// Unspecified type.
Unspecified = 0,
/// Predict logs.
Predict = 1,
/// Explain logs.
Explain = 2,
}
impl LogType {
/// 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 {
LogType::Unspecified => "LOG_TYPE_UNSPECIFIED",
LogType::Predict => "PREDICT",
LogType::Explain => "EXPLAIN",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"LOG_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"PREDICT" => Some(Self::Predict),
"EXPLAIN" => Some(Self::Explain),
_ => None,
}
}
}
}
/// ModelDeploymentMonitoringObjectiveConfig contains the pair of
/// deployed_model_id to ModelMonitoringObjectiveConfig.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelDeploymentMonitoringObjectiveConfig {
/// The DeployedModel ID of the objective config.
#[prost(string, tag = "1")]
pub deployed_model_id: ::prost::alloc::string::String,
/// The objective config of for the modelmonitoring job of this deployed model.
#[prost(message, optional, tag = "2")]
pub objective_config: ::core::option::Option<ModelMonitoringObjectiveConfig>,
}
/// The config for scheduling monitoring job.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ModelDeploymentMonitoringScheduleConfig {
/// Required. The model monitoring job scheduling interval. It will be rounded
/// up to next full hour. This defines how often the monitoring jobs are
/// triggered.
#[prost(message, optional, tag = "1")]
pub monitor_interval: ::core::option::Option<::prost_types::Duration>,
/// The time window of the prediction data being included in each prediction
/// dataset. This window specifies how long the data should be collected from
/// historical model results for each run. If not set,
/// [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig.monitor_interval]
/// will be used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and
/// the monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 to
/// 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
/// monitoring statistics.
#[prost(message, optional, tag = "2")]
pub monitor_window: ::core::option::Option<::prost_types::Duration>,
}
/// Statistics and anomalies generated by Model Monitoring.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModelMonitoringStatsAnomalies {
/// Model Monitoring Objective those stats and anomalies belonging to.
#[prost(enumeration = "ModelDeploymentMonitoringObjectiveType", tag = "1")]
pub objective: i32,
/// Deployed Model ID.
#[prost(string, tag = "2")]
pub deployed_model_id: ::prost::alloc::string::String,
/// Number of anomalies within all stats.
#[prost(int32, tag = "3")]
pub anomaly_count: i32,
/// A list of historical Stats and Anomalies generated for all Features.
#[prost(message, repeated, tag = "4")]
pub feature_stats: ::prost::alloc::vec::Vec<
model_monitoring_stats_anomalies::FeatureHistoricStatsAnomalies,
>,
}
/// Nested message and enum types in `ModelMonitoringStatsAnomalies`.
pub mod model_monitoring_stats_anomalies {
/// Historical Stats (and Anomalies) for a specific Feature.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureHistoricStatsAnomalies {
/// Display Name of the Feature.
#[prost(string, tag = "1")]
pub feature_display_name: ::prost::alloc::string::String,
/// Threshold for anomaly detection.
#[prost(message, optional, tag = "3")]
pub threshold: ::core::option::Option<super::ThresholdConfig>,
/// Stats calculated for the Training Dataset.
#[prost(message, optional, tag = "4")]
pub training_stats: ::core::option::Option<super::FeatureStatsAnomaly>,
/// A list of historical stats generated by different time window's
/// Prediction Dataset.
#[prost(message, repeated, tag = "5")]
pub prediction_stats: ::prost::alloc::vec::Vec<super::FeatureStatsAnomaly>,
}
}
/// The Model Monitoring Objective types.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ModelDeploymentMonitoringObjectiveType {
/// Default value, should not be set.
Unspecified = 0,
/// Raw feature values' stats to detect skew between Training-Prediction
/// datasets.
RawFeatureSkew = 1,
/// Raw feature values' stats to detect drift between Serving-Prediction
/// datasets.
RawFeatureDrift = 2,
/// Feature attribution scores to detect skew between Training-Prediction
/// datasets.
FeatureAttributionSkew = 3,
/// Feature attribution scores to detect skew between Prediction datasets
/// collected within different time windows.
FeatureAttributionDrift = 4,
}
impl ModelDeploymentMonitoringObjectiveType {
/// 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 {
ModelDeploymentMonitoringObjectiveType::Unspecified => {
"MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED"
}
ModelDeploymentMonitoringObjectiveType::RawFeatureSkew => "RAW_FEATURE_SKEW",
ModelDeploymentMonitoringObjectiveType::RawFeatureDrift => {
"RAW_FEATURE_DRIFT"
}
ModelDeploymentMonitoringObjectiveType::FeatureAttributionSkew => {
"FEATURE_ATTRIBUTION_SKEW"
}
ModelDeploymentMonitoringObjectiveType::FeatureAttributionDrift => {
"FEATURE_ATTRIBUTION_DRIFT"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED" => {
Some(Self::Unspecified)
}
"RAW_FEATURE_SKEW" => Some(Self::RawFeatureSkew),
"RAW_FEATURE_DRIFT" => Some(Self::RawFeatureDrift),
"FEATURE_ATTRIBUTION_SKEW" => Some(Self::FeatureAttributionSkew),
"FEATURE_ATTRIBUTION_DRIFT" => Some(Self::FeatureAttributionDrift),
_ => None,
}
}
}
/// Instance of a metadata store. Contains a set of metadata that can be
/// queried.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetadataStore {
/// Output only. The resource name of the MetadataStore instance.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Timestamp when this MetadataStore was created.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this MetadataStore was last updated.
#[prost(message, optional, tag = "4")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Customer-managed encryption key spec for a Metadata Store. If set, this
/// Metadata Store and all sub-resources of this Metadata Store are secured
/// using this key.
#[prost(message, optional, tag = "5")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Description of the MetadataStore.
#[prost(string, tag = "6")]
pub description: ::prost::alloc::string::String,
/// Output only. State information of the MetadataStore.
#[prost(message, optional, tag = "7")]
pub state: ::core::option::Option<metadata_store::MetadataStoreState>,
/// Optional. Dataplex integration settings.
#[prost(message, optional, tag = "8")]
pub dataplex_config: ::core::option::Option<metadata_store::DataplexConfig>,
}
/// Nested message and enum types in `MetadataStore`.
pub mod metadata_store {
/// Represents state information for a MetadataStore.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct MetadataStoreState {
/// The disk utilization of the MetadataStore in bytes.
#[prost(int64, tag = "1")]
pub disk_utilization_bytes: i64,
}
/// Represents Dataplex integration settings.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DataplexConfig {
/// Optional. Whether or not Data Lineage synchronization is enabled for
/// Vertex Pipelines.
#[prost(bool, tag = "1")]
pub enabled_pipelines_lineage: bool,
}
}
/// Indexes are deployed into it. An IndexEndpoint can have multiple
/// DeployedIndexes.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IndexEndpoint {
/// Output only. The resource name of the IndexEndpoint.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The display name of the IndexEndpoint.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// The description of the IndexEndpoint.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. The indexes deployed in this endpoint.
#[prost(message, repeated, tag = "4")]
pub deployed_indexes: ::prost::alloc::vec::Vec<DeployedIndex>,
/// Used to perform consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "5")]
pub etag: ::prost::alloc::string::String,
/// The labels with user-defined metadata to organize your IndexEndpoints.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "6")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Output only. Timestamp when this IndexEndpoint was created.
#[prost(message, optional, tag = "7")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this IndexEndpoint was last updated.
/// This timestamp is not updated when the endpoint's DeployedIndexes are
/// updated, e.g. due to updates of the original Indexes they are the
/// deployments of.
#[prost(message, optional, tag = "8")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. The full name of the Google Compute Engine
/// [network](<https://cloud.google.com/compute/docs/networks-and-firewalls#networks>)
/// to which the IndexEndpoint should be peered.
///
/// Private services access must already be configured for the network. If left
/// unspecified, the Endpoint is not peered with any network.
///
/// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
/// [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
/// are mutually exclusive.
///
/// [Format](<https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert>):
/// `projects/{project}/global/networks/{network}`.
/// Where {project} is a project number, as in '12345', and {network} is
/// network name.
#[prost(string, tag = "9")]
pub network: ::prost::alloc::string::String,
/// Optional. Deprecated: If true, expose the IndexEndpoint via private service
/// connect.
///
/// Only one of the fields,
/// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] or
/// [enable_private_service_connect][google.cloud.aiplatform.v1.IndexEndpoint.enable_private_service_connect],
/// can be set.
#[deprecated]
#[prost(bool, tag = "10")]
pub enable_private_service_connect: bool,
/// Optional. Configuration for private service connect.
///
/// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
/// [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
/// are mutually exclusive.
#[prost(message, optional, tag = "12")]
pub private_service_connect_config: ::core::option::Option<
PrivateServiceConnectConfig,
>,
/// Optional. If true, the deployed index will be accessible through public
/// endpoint.
#[prost(bool, tag = "13")]
pub public_endpoint_enabled: bool,
/// Output only. If
/// [public_endpoint_enabled][google.cloud.aiplatform.v1.IndexEndpoint.public_endpoint_enabled]
/// is true, this field will be populated with the domain name to use for this
/// index endpoint.
#[prost(string, tag = "14")]
pub public_endpoint_domain_name: ::prost::alloc::string::String,
/// Immutable. Customer-managed encryption key spec for an IndexEndpoint. If
/// set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be
/// secured by this key.
#[prost(message, optional, tag = "15")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. Reserved for future use.
#[prost(bool, tag = "17")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "18")]
pub satisfies_pzi: bool,
}
/// A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployedIndex {
/// Required. The user specified ID of the DeployedIndex.
/// The ID can be up to 128 characters long and must start with a letter and
/// only contain letters, numbers, and underscores.
/// The ID must be unique within the project it is created in.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Required. The name of the Index this is the deployment of.
/// We may refer to this Index as the DeployedIndex's "original" Index.
#[prost(string, tag = "2")]
pub index: ::prost::alloc::string::String,
/// The display name of the DeployedIndex. If not provided upon creation,
/// the Index's display_name is used.
#[prost(string, tag = "3")]
pub display_name: ::prost::alloc::string::String,
/// Output only. Timestamp when the DeployedIndex was created.
#[prost(message, optional, tag = "4")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Provides paths for users to send requests directly to the
/// deployed index services running on Cloud via private services access. This
/// field is populated if
/// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured.
#[prost(message, optional, tag = "5")]
pub private_endpoints: ::core::option::Option<IndexPrivateEndpoints>,
/// Output only. The DeployedIndex may depend on various data on its original
/// Index. Additionally when certain changes to the original Index are being
/// done (e.g. when what the Index contains is being changed) the DeployedIndex
/// may be asynchronously updated in the background to reflect these changes.
/// If this timestamp's value is at least the
/// [Index.update_time][google.cloud.aiplatform.v1.Index.update_time] of the
/// original Index, it means that this DeployedIndex and the original Index are
/// in sync. If this timestamp is older, then to see which updates this
/// DeployedIndex already contains (and which it does not), one must
/// [list][google.longrunning.Operations.ListOperations] the operations that
/// are running on the original Index. Only the successfully completed
/// Operations with
/// [update_time][google.cloud.aiplatform.v1.GenericOperationMetadata.update_time]
/// equal or before this sync time are contained in this DeployedIndex.
#[prost(message, optional, tag = "6")]
pub index_sync_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. A description of resources that the DeployedIndex uses, which to
/// large degree are decided by Vertex AI, and optionally allows only a modest
/// additional configuration.
/// If min_replica_count is not set, the default value is 2 (we don't provide
/// SLA when min_replica_count=1). If max_replica_count is not set, the
/// default value is min_replica_count. The max allowed replica count is
/// 1000.
#[prost(message, optional, tag = "7")]
pub automatic_resources: ::core::option::Option<AutomaticResources>,
/// Optional. A description of resources that are dedicated to the
/// DeployedIndex, and that need a higher degree of manual configuration. The
/// field min_replica_count must be set to a value strictly greater than 0, or
/// else validation will fail. We don't provide SLA when min_replica_count=1.
/// If max_replica_count is not set, the default value is min_replica_count.
/// The max allowed replica count is 1000.
///
/// Available machine types for SMALL shard:
/// e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
///
/// Available machine types for MEDIUM shard:
/// e2-standard-16 and all machine types available for LARGE shard.
///
/// Available machine types for LARGE shard:
/// e2-highmem-16, n2d-standard-32.
///
/// n1-standard-16 and n1-standard-32 are still available, but we recommend
/// e2-standard-16 and e2-highmem-16 for cost efficiency.
#[prost(message, optional, tag = "16")]
pub dedicated_resources: ::core::option::Option<DedicatedResources>,
/// Optional. If true, private endpoint's access logs are sent to Cloud
/// Logging.
///
/// These logs are like standard server access logs, containing
/// information like timestamp and latency for each MatchRequest.
///
/// Note that logs may incur a cost, especially if the deployed
/// index receives a high queries per second rate (QPS).
/// Estimate your costs before enabling this option.
#[prost(bool, tag = "8")]
pub enable_access_logging: bool,
/// Optional. If set, the authentication is enabled for the private endpoint.
#[prost(message, optional, tag = "9")]
pub deployed_index_auth_config: ::core::option::Option<DeployedIndexAuthConfig>,
/// Optional. A list of reserved ip ranges under the VPC network that can be
/// used for this DeployedIndex.
///
/// If set, we will deploy the index within the provided ip ranges. Otherwise,
/// the index might be deployed to any ip ranges under the provided VPC
/// network.
///
/// The value should be the name of the address
/// (<https://cloud.google.com/compute/docs/reference/rest/v1/addresses>)
/// Example: \['vertex-ai-ip-range'\].
///
/// For more information about subnets and network IP ranges, please see
/// <https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.>
#[prost(string, repeated, tag = "10")]
pub reserved_ip_ranges: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. The deployment group can be no longer than 64 characters (eg:
/// 'test', 'prod'). If not set, we will use the 'default' deployment group.
///
/// Creating `deployment_groups` with `reserved_ip_ranges` is a recommended
/// practice when the peered network has multiple peering ranges. This creates
/// your deployments from predictable IP spaces for easier traffic
/// administration. Also, one deployment_group (except 'default') can only be
/// used with the same reserved_ip_ranges which means if the deployment_group
/// has been used with reserved_ip_ranges: \[a, b, c\], using it with \[a, b\] or
/// \[d, e\] is disallowed.
///
/// Note: we only support up to 5 deployment groups(not including 'default').
#[prost(string, tag = "11")]
pub deployment_group: ::prost::alloc::string::String,
}
/// Used to set up the auth on the DeployedIndex's private endpoint.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployedIndexAuthConfig {
/// Defines the authentication provider that the DeployedIndex uses.
#[prost(message, optional, tag = "1")]
pub auth_provider: ::core::option::Option<deployed_index_auth_config::AuthProvider>,
}
/// Nested message and enum types in `DeployedIndexAuthConfig`.
pub mod deployed_index_auth_config {
/// Configuration for an authentication provider, including support for
/// [JSON Web Token
/// (JWT)](<https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AuthProvider {
/// The list of JWT
/// [audiences](<https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3>).
/// that are allowed to access. A JWT containing any of these audiences will
/// be accepted.
#[prost(string, repeated, tag = "1")]
pub audiences: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// A list of allowed JWT issuers. Each entry must be a valid Google
/// service account, in the following format:
///
/// `service-account-name@project-id.iam.gserviceaccount.com`
#[prost(string, repeated, tag = "2")]
pub allowed_issuers: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
}
/// IndexPrivateEndpoints proto is used to provide paths for users to send
/// requests via private endpoints (e.g. private service access, private service
/// connect).
/// To send request via private service access, use match_grpc_address.
/// To send request via private service connect, use service_attachment.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IndexPrivateEndpoints {
/// Output only. The ip address used to send match gRPC requests.
#[prost(string, tag = "1")]
pub match_grpc_address: ::prost::alloc::string::String,
/// Output only. The name of the service attachment resource. Populated if
/// private service connect is enabled.
#[prost(string, tag = "2")]
pub service_attachment: ::prost::alloc::string::String,
/// Output only. PscAutomatedEndpoints is populated if private service connect
/// is enabled if PscAutomatedConfig is set.
#[prost(message, repeated, tag = "3")]
pub psc_automated_endpoints: ::prost::alloc::vec::Vec<PscAutomatedEndpoints>,
}
/// Request message for
/// [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSpecialistPoolRequest {
/// Required. The parent Project name for the new SpecialistPool.
/// The form is `projects/{project}/locations/{location}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The SpecialistPool to create.
#[prost(message, optional, tag = "2")]
pub specialist_pool: ::core::option::Option<SpecialistPool>,
}
/// Runtime operation information for
/// [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSpecialistPoolOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSpecialistPoolRequest {
/// Required. The name of the SpecialistPool resource.
/// The form is
/// `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSpecialistPoolsRequest {
/// Required. The name of the SpecialistPool's parent resource.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained by
/// [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token]
/// of the previous
/// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools]
/// call. Return first page if empty.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read. FieldMask represents a set of
#[prost(message, optional, tag = "4")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSpecialistPoolsResponse {
/// A list of SpecialistPools that matches the specified filter in the request.
#[prost(message, repeated, tag = "1")]
pub specialist_pools: ::prost::alloc::vec::Vec<SpecialistPool>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSpecialistPoolRequest {
/// Required. The resource name of the SpecialistPool to delete. Format:
/// `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// If set to true, any specialist managers in this SpecialistPool will also be
/// deleted. (Otherwise, the request will only work if the SpecialistPool has
/// no specialist managers.)
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Request message for
/// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateSpecialistPoolRequest {
/// Required. The SpecialistPool which replaces the resource on the server.
#[prost(message, optional, tag = "1")]
pub specialist_pool: ::core::option::Option<SpecialistPool>,
/// Required. The update mask applies to the resource.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Runtime operation metadata for
/// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateSpecialistPoolOperationMetadata {
/// Output only. The name of the SpecialistPool to which the specialists are
/// being added. Format:
/// `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}`
#[prost(string, tag = "1")]
pub specialist_pool: ::prost::alloc::string::String,
/// The operation generic information.
#[prost(message, optional, tag = "2")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Generated client implementations.
pub mod specialist_pool_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for creating and managing Customer SpecialistPools.
/// When customers start Data Labeling jobs, they can reuse/create Specialist
/// Pools to bring their own Specialists to label the data.
/// Customers can add/remove Managers for the Specialist Pool on Cloud console,
/// then Managers will get email notifications to manage Specialists and tasks on
/// CrowdCompute console.
#[derive(Debug, Clone)]
pub struct SpecialistPoolServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> SpecialistPoolServiceClient<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,
) -> SpecialistPoolServiceClient<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,
{
SpecialistPoolServiceClient::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 SpecialistPool.
pub async fn create_specialist_pool(
&mut self,
request: impl tonic::IntoRequest<super::CreateSpecialistPoolRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.SpecialistPoolService/CreateSpecialistPool",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.SpecialistPoolService",
"CreateSpecialistPool",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a SpecialistPool.
pub async fn get_specialist_pool(
&mut self,
request: impl tonic::IntoRequest<super::GetSpecialistPoolRequest>,
) -> std::result::Result<tonic::Response<super::SpecialistPool>, 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.aiplatform.v1.SpecialistPoolService/GetSpecialistPool",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.SpecialistPoolService",
"GetSpecialistPool",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists SpecialistPools in a Location.
pub async fn list_specialist_pools(
&mut self,
request: impl tonic::IntoRequest<super::ListSpecialistPoolsRequest>,
) -> std::result::Result<
tonic::Response<super::ListSpecialistPoolsResponse>,
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.aiplatform.v1.SpecialistPoolService/ListSpecialistPools",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.SpecialistPoolService",
"ListSpecialistPools",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a SpecialistPool as well as all Specialists in the pool.
pub async fn delete_specialist_pool(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSpecialistPoolRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.SpecialistPoolService/DeleteSpecialistPool",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.SpecialistPoolService",
"DeleteSpecialistPool",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a SpecialistPool.
pub async fn update_specialist_pool(
&mut self,
request: impl tonic::IntoRequest<super::UpdateSpecialistPoolRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.SpecialistPoolService/UpdateSpecialistPool",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.SpecialistPoolService",
"UpdateSpecialistPool",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// All the data stored in a TensorboardTimeSeries.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TimeSeriesData {
/// Required. The ID of the TensorboardTimeSeries, which will become the final
/// component of the TensorboardTimeSeries' resource name
#[prost(string, tag = "1")]
pub tensorboard_time_series_id: ::prost::alloc::string::String,
/// Required. Immutable. The value type of this time series. All the values in
/// this time series data must match this value type.
#[prost(enumeration = "tensorboard_time_series::ValueType", tag = "2")]
pub value_type: i32,
/// Required. Data points in this time series.
#[prost(message, repeated, tag = "3")]
pub values: ::prost::alloc::vec::Vec<TimeSeriesDataPoint>,
}
/// A TensorboardTimeSeries data point.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TimeSeriesDataPoint {
/// Wall clock timestamp when this data point is generated by the end user.
#[prost(message, optional, tag = "1")]
pub wall_time: ::core::option::Option<::prost_types::Timestamp>,
/// Step index of this data point within the run.
#[prost(int64, tag = "2")]
pub step: i64,
/// Value of this time series data point.
#[prost(oneof = "time_series_data_point::Value", tags = "3, 4, 5")]
pub value: ::core::option::Option<time_series_data_point::Value>,
}
/// Nested message and enum types in `TimeSeriesDataPoint`.
pub mod time_series_data_point {
/// Value of this time series data point.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Value {
/// A scalar value.
#[prost(message, tag = "3")]
Scalar(super::Scalar),
/// A tensor value.
#[prost(message, tag = "4")]
Tensor(super::TensorboardTensor),
/// A blob sequence value.
#[prost(message, tag = "5")]
Blobs(super::TensorboardBlobSequence),
}
}
/// One point viewable on a scalar metric plot.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Scalar {
/// Value of the point at this step / timestamp.
#[prost(double, tag = "1")]
pub value: f64,
}
/// One point viewable on a tensor metric plot.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TensorboardTensor {
/// Required. Serialized form of
/// <https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto>
#[prost(bytes = "bytes", tag = "1")]
pub value: ::prost::bytes::Bytes,
/// Optional. Version number of TensorProto used to serialize
/// [value][google.cloud.aiplatform.v1.TensorboardTensor.value].
#[prost(int32, tag = "2")]
pub version_number: i32,
}
/// One point viewable on a blob metric plot, but mostly just a wrapper message
/// to work around repeated fields can't be used directly within `oneof` fields.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TensorboardBlobSequence {
/// List of blobs contained within the sequence.
#[prost(message, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<TensorboardBlob>,
}
/// One blob (e.g, image, graph) viewable on a blob metric plot.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TensorboardBlob {
/// Output only. A URI safe key uniquely identifying a blob. Can be used to
/// locate the blob stored in the Cloud Storage bucket of the consumer project.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Optional. The bytes of the blob is not present unless it's returned by the
/// ReadTensorboardBlobData endpoint.
#[prost(bytes = "bytes", tag = "2")]
pub data: ::prost::bytes::Bytes,
}
/// Tensorboard is a physical database that stores users' training metrics.
/// A default Tensorboard is provided in each region of a Google Cloud project.
/// If needed users can also create extra Tensorboards in their projects.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Tensorboard {
/// Output only. Name of the Tensorboard.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. User provided name of this Tensorboard.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Description of this Tensorboard.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Customer-managed encryption key spec for a Tensorboard. If set, this
/// Tensorboard and all sub-resources of this Tensorboard will be secured by
/// this key.
#[prost(message, optional, tag = "11")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Output only. Consumer project Cloud Storage path prefix used to store blob
/// data, which can either be a bucket or directory. Does not end with a '/'.
#[prost(string, tag = "10")]
pub blob_storage_path_prefix: ::prost::alloc::string::String,
/// Output only. The number of Runs stored in this Tensorboard.
#[prost(int32, tag = "5")]
pub run_count: i32,
/// Output only. Timestamp when this Tensorboard was created.
#[prost(message, optional, tag = "6")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this Tensorboard was last updated.
#[prost(message, optional, tag = "7")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The labels with user-defined metadata to organize your Tensorboards.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one Tensorboard
/// (System labels are excluded).
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "8")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Used to perform a consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "9")]
pub etag: ::prost::alloc::string::String,
/// Used to indicate if the TensorBoard instance is the default one.
/// Each project & region can have at most one default TensorBoard instance.
/// Creation of a default TensorBoard instance and updating an existing
/// TensorBoard instance to be default will mark all other TensorBoard
/// instances (if any) as non default.
#[prost(bool, tag = "12")]
pub is_default: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "13")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "14")]
pub satisfies_pzi: bool,
}
/// A subgraph of the overall lineage graph. Event edges connect Artifact and
/// Execution nodes.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LineageSubgraph {
/// The Artifact nodes in the subgraph.
#[prost(message, repeated, tag = "1")]
pub artifacts: ::prost::alloc::vec::Vec<Artifact>,
/// The Execution nodes in the subgraph.
#[prost(message, repeated, tag = "2")]
pub executions: ::prost::alloc::vec::Vec<Execution>,
/// The Event edges between Artifacts and Executions in the subgraph.
#[prost(message, repeated, tag = "3")]
pub events: ::prost::alloc::vec::Vec<Event>,
}
/// Request message for
/// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateMetadataStoreRequest {
/// Required. The resource name of the Location where the MetadataStore should
/// be created.
/// Format: `projects/{project}/locations/{location}/`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The MetadataStore to create.
#[prost(message, optional, tag = "2")]
pub metadata_store: ::core::option::Option<MetadataStore>,
/// The {metadatastore} portion of the resource name with the format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
/// If not provided, the MetadataStore's ID will be a UUID generated by the
/// service.
/// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
/// Must be unique across all MetadataStores in the parent Location.
/// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
/// if the caller can't view the preexisting MetadataStore.)
#[prost(string, tag = "3")]
pub metadata_store_id: ::prost::alloc::string::String,
}
/// Details of operations that perform
/// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateMetadataStoreOperationMetadata {
/// Operation metadata for creating a MetadataStore.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1.MetadataService.GetMetadataStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetMetadataStoreRequest {
/// Required. The resource name of the MetadataStore to retrieve.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListMetadataStoresRequest {
/// Required. The Location whose MetadataStores should be listed.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of Metadata Stores to return. The service may return
/// fewer.
/// Must be in range 1-1000, inclusive. Defaults to 100.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous
/// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other provided parameters must match the call that
/// provided the page token. (Otherwise the request will fail with
/// INVALID_ARGUMENT error.)
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListMetadataStoresResponse {
/// The MetadataStores found for the Location.
#[prost(message, repeated, tag = "1")]
pub metadata_stores: ::prost::alloc::vec::Vec<MetadataStore>,
/// A token, which can be sent as
/// [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1.ListMetadataStoresRequest.page_token]
/// to retrieve the next page. If this field is not populated, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteMetadataStoreRequest {
/// Required. The resource name of the MetadataStore to delete.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Deprecated: Field is no longer supported.
#[deprecated]
#[prost(bool, tag = "2")]
pub force: bool,
}
/// Details of operations that perform
/// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteMetadataStoreOperationMetadata {
/// Operation metadata for deleting a MetadataStore.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [MetadataService.CreateArtifact][google.cloud.aiplatform.v1.MetadataService.CreateArtifact].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateArtifactRequest {
/// Required. The resource name of the MetadataStore where the Artifact should
/// be created.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Artifact to create.
#[prost(message, optional, tag = "2")]
pub artifact: ::core::option::Option<Artifact>,
/// The {artifact} portion of the resource name with the format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
/// If not provided, the Artifact's ID will be a UUID generated by the service.
/// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
/// Must be unique across all Artifacts in the parent MetadataStore. (Otherwise
/// the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
/// caller can't view the preexisting Artifact.)
#[prost(string, tag = "3")]
pub artifact_id: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.GetArtifact][google.cloud.aiplatform.v1.MetadataService.GetArtifact].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetArtifactRequest {
/// Required. The resource name of the Artifact to retrieve.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListArtifactsRequest {
/// Required. The MetadataStore whose Artifacts should be listed.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of Artifacts to return. The service may return fewer.
/// Must be in range 1-1000, inclusive. Defaults to 100.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous
/// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other provided parameters must match the call that
/// provided the page token. (Otherwise the request will fail with
/// INVALID_ARGUMENT error.)
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Filter specifying the boolean condition for the Artifacts to satisfy in
/// order to be part of the result set.
/// The syntax to define filter query is based on <https://google.aip.dev/160.>
/// The supported set of filters include the following:
///
/// * **Attribute filtering**:
/// For example: `display_name = "test"`.
/// Supported fields include: `name`, `display_name`, `uri`, `state`,
/// `schema_title`, `create_time`, and `update_time`.
/// Time fields, such as `create_time` and `update_time`, require values
/// specified in RFC-3339 format.
/// For example: `create_time = "2020-11-19T11:30:00-04:00"`
/// * **Metadata field**:
/// To filter on metadata fields use traversal operation as follows:
/// `metadata.<field_name>.<type_value>`.
/// For example: `metadata.field_1.number_value = 10.0`
/// In case the field name contains special characters (such as colon), one
/// can embed it inside double quote.
/// For example: `metadata."field:1".number_value = 10.0`
/// * **Context based filtering**:
/// To filter Artifacts based on the contexts to which they belong, use the
/// function operator with the full resource name
/// `in_context(<context-name>)`.
/// For example:
/// `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`
///
/// Each of the above supported filter types can be combined together using
/// logical operators (`AND` & `OR`). Maximum nested expression depth allowed
/// is 5.
///
/// For example: `display_name = "test" AND metadata.field1.bool_value = true`.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
/// How the list of messages is ordered. Specify the values to order by and an
/// ordering operation. The default sorting order is ascending. To specify
/// descending order for a field, users append a " desc" suffix; for example:
/// "foo desc, bar".
/// Subfields are specified with a `.` character, such as foo.bar.
/// see <https://google.aip.dev/132#ordering> for more details.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListArtifactsResponse {
/// The Artifacts retrieved from the MetadataStore.
#[prost(message, repeated, tag = "1")]
pub artifacts: ::prost::alloc::vec::Vec<Artifact>,
/// A token, which can be sent as
/// [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1.ListArtifactsRequest.page_token]
/// to retrieve the next page.
/// If this field is not populated, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1.MetadataService.UpdateArtifact].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateArtifactRequest {
/// Required. The Artifact containing updates.
/// The Artifact's [Artifact.name][google.cloud.aiplatform.v1.Artifact.name]
/// field is used to identify the Artifact to be updated. Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
#[prost(message, optional, tag = "1")]
pub artifact: ::core::option::Option<Artifact>,
/// Optional. A FieldMask indicating which fields should be updated.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// If set to true, and the [Artifact][google.cloud.aiplatform.v1.Artifact] is
/// not found, a new [Artifact][google.cloud.aiplatform.v1.Artifact] is
/// created.
#[prost(bool, tag = "3")]
pub allow_missing: bool,
}
/// Request message for
/// [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1.MetadataService.DeleteArtifact].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteArtifactRequest {
/// Required. The resource name of the Artifact to delete.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The etag of the Artifact to delete.
/// If this is provided, it must match the server's etag. Otherwise, the
/// request will fail with a FAILED_PRECONDITION.
#[prost(string, tag = "2")]
pub etag: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeArtifactsRequest {
/// Required. The metadata store to purge Artifacts from.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. A required filter matching the Artifacts to be purged.
/// E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. Flag to indicate to actually perform the purge.
/// If `force` is set to false, the method will return a sample of
/// Artifact names that would be deleted.
#[prost(bool, tag = "3")]
pub force: bool,
}
/// Response message for
/// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeArtifactsResponse {
/// The number of Artifacts that this request deleted (or, if `force` is false,
/// the number of Artifacts that will be deleted). This can be an estimate.
#[prost(int64, tag = "1")]
pub purge_count: i64,
/// A sample of the Artifact names that will be deleted.
/// Only populated if `force` is set to false. The maximum number of samples is
/// 100 (it is possible to return fewer).
#[prost(string, repeated, tag = "2")]
pub purge_sample: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Details of operations that perform
/// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeArtifactsMetadata {
/// Operation metadata for purging Artifacts.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [MetadataService.CreateContext][google.cloud.aiplatform.v1.MetadataService.CreateContext].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateContextRequest {
/// Required. The resource name of the MetadataStore where the Context should
/// be created. Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Context to create.
#[prost(message, optional, tag = "2")]
pub context: ::core::option::Option<Context>,
/// The {context} portion of the resource name with the format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`.
/// If not provided, the Context's ID will be a UUID generated by the service.
/// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
/// Must be unique across all Contexts in the parent MetadataStore. (Otherwise
/// the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
/// caller can't view the preexisting Context.)
#[prost(string, tag = "3")]
pub context_id: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.GetContext][google.cloud.aiplatform.v1.MetadataService.GetContext].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetContextRequest {
/// Required. The resource name of the Context to retrieve.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListContextsRequest {
/// Required. The MetadataStore whose Contexts should be listed.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of Contexts to return. The service may return fewer.
/// Must be in range 1-1000, inclusive. Defaults to 100.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous
/// [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other provided parameters must match the call that
/// provided the page token. (Otherwise the request will fail with
/// INVALID_ARGUMENT error.)
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Filter specifying the boolean condition for the Contexts to satisfy in
/// order to be part of the result set.
/// The syntax to define filter query is based on <https://google.aip.dev/160.>
/// Following are the supported set of filters:
///
/// * **Attribute filtering**:
/// For example: `display_name = "test"`.
/// Supported fields include: `name`, `display_name`, `schema_title`,
/// `create_time`, and `update_time`.
/// Time fields, such as `create_time` and `update_time`, require values
/// specified in RFC-3339 format.
/// For example: `create_time = "2020-11-19T11:30:00-04:00"`.
/// * **Metadata field**:
/// To filter on metadata fields use traversal operation as follows:
/// `metadata.<field_name>.<type_value>`.
/// For example: `metadata.field_1.number_value = 10.0`.
/// In case the field name contains special characters (such as colon), one
/// can embed it inside double quote.
/// For example: `metadata."field:1".number_value = 10.0`
/// * **Parent Child filtering**:
/// To filter Contexts based on parent-child relationship use the HAS
/// operator as follows:
///
/// ```
/// parent_contexts:
/// "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
/// child_contexts:
/// "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
/// ```
///
/// Each of the above supported filters can be combined together using
/// logical operators (`AND` & `OR`). Maximum nested expression depth allowed
/// is 5.
///
/// For example: `display_name = "test" AND metadata.field1.bool_value = true`.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
/// How the list of messages is ordered. Specify the values to order by and an
/// ordering operation. The default sorting order is ascending. To specify
/// descending order for a field, users append a " desc" suffix; for example:
/// "foo desc, bar".
/// Subfields are specified with a `.` character, such as foo.bar.
/// see <https://google.aip.dev/132#ordering> for more details.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListContextsResponse {
/// The Contexts retrieved from the MetadataStore.
#[prost(message, repeated, tag = "1")]
pub contexts: ::prost::alloc::vec::Vec<Context>,
/// A token, which can be sent as
/// [ListContextsRequest.page_token][google.cloud.aiplatform.v1.ListContextsRequest.page_token]
/// to retrieve the next page.
/// If this field is not populated, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.UpdateContext][google.cloud.aiplatform.v1.MetadataService.UpdateContext].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateContextRequest {
/// Required. The Context containing updates.
/// The Context's [Context.name][google.cloud.aiplatform.v1.Context.name] field
/// is used to identify the Context to be updated. Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
#[prost(message, optional, tag = "1")]
pub context: ::core::option::Option<Context>,
/// Optional. A FieldMask indicating which fields should be updated.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// If set to true, and the [Context][google.cloud.aiplatform.v1.Context] is
/// not found, a new [Context][google.cloud.aiplatform.v1.Context] is created.
#[prost(bool, tag = "3")]
pub allow_missing: bool,
}
/// Request message for
/// [MetadataService.DeleteContext][google.cloud.aiplatform.v1.MetadataService.DeleteContext].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteContextRequest {
/// Required. The resource name of the Context to delete.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The force deletion semantics is still undefined.
/// Users should not use this field.
#[prost(bool, tag = "2")]
pub force: bool,
/// Optional. The etag of the Context to delete.
/// If this is provided, it must match the server's etag. Otherwise, the
/// request will fail with a FAILED_PRECONDITION.
#[prost(string, tag = "3")]
pub etag: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeContextsRequest {
/// Required. The metadata store to purge Contexts from.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. A required filter matching the Contexts to be purged.
/// E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. Flag to indicate to actually perform the purge.
/// If `force` is set to false, the method will return a sample of
/// Context names that would be deleted.
#[prost(bool, tag = "3")]
pub force: bool,
}
/// Response message for
/// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeContextsResponse {
/// The number of Contexts that this request deleted (or, if `force` is false,
/// the number of Contexts that will be deleted). This can be an estimate.
#[prost(int64, tag = "1")]
pub purge_count: i64,
/// A sample of the Context names that will be deleted.
/// Only populated if `force` is set to false. The maximum number of samples is
/// 100 (it is possible to return fewer).
#[prost(string, repeated, tag = "2")]
pub purge_sample: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Details of operations that perform
/// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeContextsMetadata {
/// Operation metadata for purging Contexts.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AddContextArtifactsAndExecutionsRequest {
/// Required. The resource name of the Context that the Artifacts and
/// Executions belong to. Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
#[prost(string, tag = "1")]
pub context: ::prost::alloc::string::String,
/// The resource names of the Artifacts to attribute to the Context.
///
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
#[prost(string, repeated, tag = "2")]
pub artifacts: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The resource names of the Executions to associate with the
/// Context.
///
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
#[prost(string, repeated, tag = "3")]
pub executions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for
/// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AddContextArtifactsAndExecutionsResponse {}
/// Request message for
/// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AddContextChildrenRequest {
/// Required. The resource name of the parent Context.
///
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
#[prost(string, tag = "1")]
pub context: ::prost::alloc::string::String,
/// The resource names of the child Contexts.
#[prost(string, repeated, tag = "2")]
pub child_contexts: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for
/// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AddContextChildrenResponse {}
/// Request message for
/// [MetadataService.DeleteContextChildrenRequest][].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RemoveContextChildrenRequest {
/// Required. The resource name of the parent Context.
///
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
#[prost(string, tag = "1")]
pub context: ::prost::alloc::string::String,
/// The resource names of the child Contexts.
#[prost(string, repeated, tag = "2")]
pub child_contexts: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for
/// [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RemoveContextChildrenResponse {}
/// Request message for
/// [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryContextLineageSubgraphRequest {
/// Required. The resource name of the Context whose Artifacts and Executions
/// should be retrieved as a LineageSubgraph.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
///
/// The request may error with FAILED_PRECONDITION if the number of Artifacts,
/// the number of Executions, or the number of Events that would be returned
/// for the Context exceeds 1000.
#[prost(string, tag = "1")]
pub context: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.CreateExecution][google.cloud.aiplatform.v1.MetadataService.CreateExecution].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateExecutionRequest {
/// Required. The resource name of the MetadataStore where the Execution should
/// be created.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Execution to create.
#[prost(message, optional, tag = "2")]
pub execution: ::core::option::Option<Execution>,
/// The {execution} portion of the resource name with the format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
/// If not provided, the Execution's ID will be a UUID generated by the
/// service.
/// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
/// Must be unique across all Executions in the parent MetadataStore.
/// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
/// if the caller can't view the preexisting Execution.)
#[prost(string, tag = "3")]
pub execution_id: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.GetExecution][google.cloud.aiplatform.v1.MetadataService.GetExecution].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetExecutionRequest {
/// Required. The resource name of the Execution to retrieve.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListExecutionsRequest {
/// Required. The MetadataStore whose Executions should be listed.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of Executions to return. The service may return fewer.
/// Must be in range 1-1000, inclusive. Defaults to 100.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous
/// [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other provided parameters must match the call that
/// provided the page token. (Otherwise the request will fail with an
/// INVALID_ARGUMENT error.)
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Filter specifying the boolean condition for the Executions to satisfy in
/// order to be part of the result set.
/// The syntax to define filter query is based on <https://google.aip.dev/160.>
/// Following are the supported set of filters:
///
/// * **Attribute filtering**:
/// For example: `display_name = "test"`.
/// Supported fields include: `name`, `display_name`, `state`,
/// `schema_title`, `create_time`, and `update_time`.
/// Time fields, such as `create_time` and `update_time`, require values
/// specified in RFC-3339 format.
/// For example: `create_time = "2020-11-19T11:30:00-04:00"`.
/// * **Metadata field**:
/// To filter on metadata fields use traversal operation as follows:
/// `metadata.<field_name>.<type_value>`
/// For example: `metadata.field_1.number_value = 10.0`
/// In case the field name contains special characters (such as colon), one
/// can embed it inside double quote.
/// For example: `metadata."field:1".number_value = 10.0`
/// * **Context based filtering**:
/// To filter Executions based on the contexts to which they belong use
/// the function operator with the full resource name:
/// `in_context(<context-name>)`.
/// For example:
/// `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`
///
/// Each of the above supported filters can be combined together using
/// logical operators (`AND` & `OR`). Maximum nested expression depth allowed
/// is 5.
///
/// For example: `display_name = "test" AND metadata.field1.bool_value = true`.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
/// How the list of messages is ordered. Specify the values to order by and an
/// ordering operation. The default sorting order is ascending. To specify
/// descending order for a field, users append a " desc" suffix; for example:
/// "foo desc, bar".
/// Subfields are specified with a `.` character, such as foo.bar.
/// see <https://google.aip.dev/132#ordering> for more details.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListExecutionsResponse {
/// The Executions retrieved from the MetadataStore.
#[prost(message, repeated, tag = "1")]
pub executions: ::prost::alloc::vec::Vec<Execution>,
/// A token, which can be sent as
/// [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1.ListExecutionsRequest.page_token]
/// to retrieve the next page.
/// If this field is not populated, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.UpdateExecution][google.cloud.aiplatform.v1.MetadataService.UpdateExecution].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateExecutionRequest {
/// Required. The Execution containing updates.
/// The Execution's [Execution.name][google.cloud.aiplatform.v1.Execution.name]
/// field is used to identify the Execution to be updated. Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
#[prost(message, optional, tag = "1")]
pub execution: ::core::option::Option<Execution>,
/// Optional. A FieldMask indicating which fields should be updated.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// If set to true, and the [Execution][google.cloud.aiplatform.v1.Execution]
/// is not found, a new [Execution][google.cloud.aiplatform.v1.Execution] is
/// created.
#[prost(bool, tag = "3")]
pub allow_missing: bool,
}
/// Request message for
/// [MetadataService.DeleteExecution][google.cloud.aiplatform.v1.MetadataService.DeleteExecution].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteExecutionRequest {
/// Required. The resource name of the Execution to delete.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The etag of the Execution to delete.
/// If this is provided, it must match the server's etag. Otherwise, the
/// request will fail with a FAILED_PRECONDITION.
#[prost(string, tag = "2")]
pub etag: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeExecutionsRequest {
/// Required. The metadata store to purge Executions from.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. A required filter matching the Executions to be purged.
/// E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. Flag to indicate to actually perform the purge.
/// If `force` is set to false, the method will return a sample of
/// Execution names that would be deleted.
#[prost(bool, tag = "3")]
pub force: bool,
}
/// Response message for
/// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeExecutionsResponse {
/// The number of Executions that this request deleted (or, if `force` is
/// false, the number of Executions that will be deleted). This can be an
/// estimate.
#[prost(int64, tag = "1")]
pub purge_count: i64,
/// A sample of the Execution names that will be deleted.
/// Only populated if `force` is set to false. The maximum number of samples is
/// 100 (it is possible to return fewer).
#[prost(string, repeated, tag = "2")]
pub purge_sample: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Details of operations that perform
/// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeExecutionsMetadata {
/// Operation metadata for purging Executions.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AddExecutionEventsRequest {
/// Required. The resource name of the Execution that the Events connect
/// Artifacts with.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
#[prost(string, tag = "1")]
pub execution: ::prost::alloc::string::String,
/// The Events to create and add.
#[prost(message, repeated, tag = "2")]
pub events: ::prost::alloc::vec::Vec<Event>,
}
/// Response message for
/// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AddExecutionEventsResponse {}
/// Request message for
/// [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryExecutionInputsAndOutputsRequest {
/// Required. The resource name of the Execution whose input and output
/// Artifacts should be retrieved as a LineageSubgraph. Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
#[prost(string, tag = "1")]
pub execution: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateMetadataSchemaRequest {
/// Required. The resource name of the MetadataStore where the MetadataSchema
/// should be created. Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The MetadataSchema to create.
#[prost(message, optional, tag = "2")]
pub metadata_schema: ::core::option::Option<MetadataSchema>,
/// The {metadata_schema} portion of the resource name with the format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
/// If not provided, the MetadataStore's ID will be a UUID generated by the
/// service.
/// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
/// Must be unique across all MetadataSchemas in the parent Location.
/// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
/// if the caller can't view the preexisting MetadataSchema.)
#[prost(string, tag = "3")]
pub metadata_schema_id: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetMetadataSchemaRequest {
/// Required. The resource name of the MetadataSchema to retrieve.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListMetadataSchemasRequest {
/// Required. The MetadataStore whose MetadataSchemas should be listed.
/// Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of MetadataSchemas to return. The service may return
/// fewer.
/// Must be in range 1-1000, inclusive. Defaults to 100.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token, received from a previous
/// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas]
/// call. Provide this to retrieve the next page.
///
/// When paginating, all other provided parameters must match the call that
/// provided the page token. (Otherwise the request will fail with
/// INVALID_ARGUMENT error.)
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// A query to filter available MetadataSchemas for matching results.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
}
/// Response message for
/// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListMetadataSchemasResponse {
/// The MetadataSchemas found for the MetadataStore.
#[prost(message, repeated, tag = "1")]
pub metadata_schemas: ::prost::alloc::vec::Vec<MetadataSchema>,
/// A token, which can be sent as
/// [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1.ListMetadataSchemasRequest.page_token]
/// to retrieve the next page. If this field is not populated, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryArtifactLineageSubgraphRequest {
/// Required. The resource name of the Artifact whose Lineage needs to be
/// retrieved as a LineageSubgraph. Format:
/// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
///
/// The request may error with FAILED_PRECONDITION if the number of Artifacts,
/// the number of Executions, or the number of Events that would be returned
/// for the Context exceeds 1000.
#[prost(string, tag = "1")]
pub artifact: ::prost::alloc::string::String,
/// Specifies the size of the lineage graph in terms of number of hops from the
/// specified artifact.
/// Negative Value: INVALID_ARGUMENT error is returned
/// 0: Only input artifact is returned.
/// No value: Transitive closure is performed to return the complete graph.
#[prost(int32, tag = "2")]
pub max_hops: i32,
/// Filter specifying the boolean condition for the Artifacts to satisfy in
/// order to be part of the Lineage Subgraph.
/// The syntax to define filter query is based on <https://google.aip.dev/160.>
/// The supported set of filters include the following:
///
/// * **Attribute filtering**:
/// For example: `display_name = "test"`
/// Supported fields include: `name`, `display_name`, `uri`, `state`,
/// `schema_title`, `create_time`, and `update_time`.
/// Time fields, such as `create_time` and `update_time`, require values
/// specified in RFC-3339 format.
/// For example: `create_time = "2020-11-19T11:30:00-04:00"`
/// * **Metadata field**:
/// To filter on metadata fields use traversal operation as follows:
/// `metadata.<field_name>.<type_value>`.
/// For example: `metadata.field_1.number_value = 10.0`
/// In case the field name contains special characters (such as colon), one
/// can embed it inside double quote.
/// For example: `metadata."field:1".number_value = 10.0`
///
/// Each of the above supported filter types can be combined together using
/// logical operators (`AND` & `OR`). Maximum nested expression depth allowed
/// is 5.
///
/// For example: `display_name = "test" AND metadata.field1.bool_value = true`.
#[prost(string, tag = "3")]
pub filter: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod metadata_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Service for reading and writing metadata entries.
#[derive(Debug, Clone)]
pub struct MetadataServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> MetadataServiceClient<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,
) -> MetadataServiceClient<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,
{
MetadataServiceClient::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
}
/// Initializes a MetadataStore, including allocation of resources.
pub async fn create_metadata_store(
&mut self,
request: impl tonic::IntoRequest<super::CreateMetadataStoreRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MetadataService/CreateMetadataStore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"CreateMetadataStore",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves a specific MetadataStore.
pub async fn get_metadata_store(
&mut self,
request: impl tonic::IntoRequest<super::GetMetadataStoreRequest>,
) -> std::result::Result<tonic::Response<super::MetadataStore>, 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.aiplatform.v1.MetadataService/GetMetadataStore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"GetMetadataStore",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists MetadataStores for a Location.
pub async fn list_metadata_stores(
&mut self,
request: impl tonic::IntoRequest<super::ListMetadataStoresRequest>,
) -> std::result::Result<
tonic::Response<super::ListMetadataStoresResponse>,
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.aiplatform.v1.MetadataService/ListMetadataStores",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"ListMetadataStores",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single MetadataStore and all its child resources (Artifacts,
/// Executions, and Contexts).
pub async fn delete_metadata_store(
&mut self,
request: impl tonic::IntoRequest<super::DeleteMetadataStoreRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MetadataService/DeleteMetadataStore",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"DeleteMetadataStore",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an Artifact associated with a MetadataStore.
pub async fn create_artifact(
&mut self,
request: impl tonic::IntoRequest<super::CreateArtifactRequest>,
) -> std::result::Result<tonic::Response<super::Artifact>, 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.aiplatform.v1.MetadataService/CreateArtifact",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"CreateArtifact",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves a specific Artifact.
pub async fn get_artifact(
&mut self,
request: impl tonic::IntoRequest<super::GetArtifactRequest>,
) -> std::result::Result<tonic::Response<super::Artifact>, 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.aiplatform.v1.MetadataService/GetArtifact",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"GetArtifact",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Artifacts in the MetadataStore.
pub async fn list_artifacts(
&mut self,
request: impl tonic::IntoRequest<super::ListArtifactsRequest>,
) -> std::result::Result<
tonic::Response<super::ListArtifactsResponse>,
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.aiplatform.v1.MetadataService/ListArtifacts",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"ListArtifacts",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a stored Artifact.
pub async fn update_artifact(
&mut self,
request: impl tonic::IntoRequest<super::UpdateArtifactRequest>,
) -> std::result::Result<tonic::Response<super::Artifact>, 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.aiplatform.v1.MetadataService/UpdateArtifact",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"UpdateArtifact",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an Artifact.
pub async fn delete_artifact(
&mut self,
request: impl tonic::IntoRequest<super::DeleteArtifactRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MetadataService/DeleteArtifact",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"DeleteArtifact",
),
);
self.inner.unary(req, path, codec).await
}
/// Purges Artifacts.
pub async fn purge_artifacts(
&mut self,
request: impl tonic::IntoRequest<super::PurgeArtifactsRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MetadataService/PurgeArtifacts",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"PurgeArtifacts",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a Context associated with a MetadataStore.
pub async fn create_context(
&mut self,
request: impl tonic::IntoRequest<super::CreateContextRequest>,
) -> std::result::Result<tonic::Response<super::Context>, 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.aiplatform.v1.MetadataService/CreateContext",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"CreateContext",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves a specific Context.
pub async fn get_context(
&mut self,
request: impl tonic::IntoRequest<super::GetContextRequest>,
) -> std::result::Result<tonic::Response<super::Context>, 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.aiplatform.v1.MetadataService/GetContext",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"GetContext",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Contexts on the MetadataStore.
pub async fn list_contexts(
&mut self,
request: impl tonic::IntoRequest<super::ListContextsRequest>,
) -> std::result::Result<
tonic::Response<super::ListContextsResponse>,
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.aiplatform.v1.MetadataService/ListContexts",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"ListContexts",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a stored Context.
pub async fn update_context(
&mut self,
request: impl tonic::IntoRequest<super::UpdateContextRequest>,
) -> std::result::Result<tonic::Response<super::Context>, 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.aiplatform.v1.MetadataService/UpdateContext",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"UpdateContext",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a stored Context.
pub async fn delete_context(
&mut self,
request: impl tonic::IntoRequest<super::DeleteContextRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MetadataService/DeleteContext",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"DeleteContext",
),
);
self.inner.unary(req, path, codec).await
}
/// Purges Contexts.
pub async fn purge_contexts(
&mut self,
request: impl tonic::IntoRequest<super::PurgeContextsRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MetadataService/PurgeContexts",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"PurgeContexts",
),
);
self.inner.unary(req, path, codec).await
}
/// Adds a set of Artifacts and Executions to a Context. If any of the
/// Artifacts or Executions have already been added to a Context, they are
/// simply skipped.
pub async fn add_context_artifacts_and_executions(
&mut self,
request: impl tonic::IntoRequest<
super::AddContextArtifactsAndExecutionsRequest,
>,
) -> std::result::Result<
tonic::Response<super::AddContextArtifactsAndExecutionsResponse>,
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.aiplatform.v1.MetadataService/AddContextArtifactsAndExecutions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"AddContextArtifactsAndExecutions",
),
);
self.inner.unary(req, path, codec).await
}
/// Adds a set of Contexts as children to a parent Context. If any of the
/// child Contexts have already been added to the parent Context, they are
/// simply skipped. If this call would create a cycle or cause any Context to
/// have more than 10 parents, the request will fail with an INVALID_ARGUMENT
/// error.
pub async fn add_context_children(
&mut self,
request: impl tonic::IntoRequest<super::AddContextChildrenRequest>,
) -> std::result::Result<
tonic::Response<super::AddContextChildrenResponse>,
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.aiplatform.v1.MetadataService/AddContextChildren",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"AddContextChildren",
),
);
self.inner.unary(req, path, codec).await
}
/// Remove a set of children contexts from a parent Context. If any of the
/// child Contexts were NOT added to the parent Context, they are
/// simply skipped.
pub async fn remove_context_children(
&mut self,
request: impl tonic::IntoRequest<super::RemoveContextChildrenRequest>,
) -> std::result::Result<
tonic::Response<super::RemoveContextChildrenResponse>,
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.aiplatform.v1.MetadataService/RemoveContextChildren",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"RemoveContextChildren",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves Artifacts and Executions within the specified Context, connected
/// by Event edges and returned as a LineageSubgraph.
pub async fn query_context_lineage_subgraph(
&mut self,
request: impl tonic::IntoRequest<super::QueryContextLineageSubgraphRequest>,
) -> std::result::Result<
tonic::Response<super::LineageSubgraph>,
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.aiplatform.v1.MetadataService/QueryContextLineageSubgraph",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"QueryContextLineageSubgraph",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an Execution associated with a MetadataStore.
pub async fn create_execution(
&mut self,
request: impl tonic::IntoRequest<super::CreateExecutionRequest>,
) -> std::result::Result<tonic::Response<super::Execution>, 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.aiplatform.v1.MetadataService/CreateExecution",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"CreateExecution",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves a specific Execution.
pub async fn get_execution(
&mut self,
request: impl tonic::IntoRequest<super::GetExecutionRequest>,
) -> std::result::Result<tonic::Response<super::Execution>, 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.aiplatform.v1.MetadataService/GetExecution",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"GetExecution",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Executions in the MetadataStore.
pub async fn list_executions(
&mut self,
request: impl tonic::IntoRequest<super::ListExecutionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListExecutionsResponse>,
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.aiplatform.v1.MetadataService/ListExecutions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"ListExecutions",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a stored Execution.
pub async fn update_execution(
&mut self,
request: impl tonic::IntoRequest<super::UpdateExecutionRequest>,
) -> std::result::Result<tonic::Response<super::Execution>, 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.aiplatform.v1.MetadataService/UpdateExecution",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"UpdateExecution",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an Execution.
pub async fn delete_execution(
&mut self,
request: impl tonic::IntoRequest<super::DeleteExecutionRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MetadataService/DeleteExecution",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"DeleteExecution",
),
);
self.inner.unary(req, path, codec).await
}
/// Purges Executions.
pub async fn purge_executions(
&mut self,
request: impl tonic::IntoRequest<super::PurgeExecutionsRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.MetadataService/PurgeExecutions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"PurgeExecutions",
),
);
self.inner.unary(req, path, codec).await
}
/// Adds Events to the specified Execution. An Event indicates whether an
/// Artifact was used as an input or output for an Execution. If an Event
/// already exists between the Execution and the Artifact, the Event is
/// skipped.
pub async fn add_execution_events(
&mut self,
request: impl tonic::IntoRequest<super::AddExecutionEventsRequest>,
) -> std::result::Result<
tonic::Response<super::AddExecutionEventsResponse>,
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.aiplatform.v1.MetadataService/AddExecutionEvents",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"AddExecutionEvents",
),
);
self.inner.unary(req, path, codec).await
}
/// Obtains the set of input and output Artifacts for this Execution, in the
/// form of LineageSubgraph that also contains the Execution and connecting
/// Events.
pub async fn query_execution_inputs_and_outputs(
&mut self,
request: impl tonic::IntoRequest<
super::QueryExecutionInputsAndOutputsRequest,
>,
) -> std::result::Result<
tonic::Response<super::LineageSubgraph>,
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.aiplatform.v1.MetadataService/QueryExecutionInputsAndOutputs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"QueryExecutionInputsAndOutputs",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a MetadataSchema.
pub async fn create_metadata_schema(
&mut self,
request: impl tonic::IntoRequest<super::CreateMetadataSchemaRequest>,
) -> std::result::Result<tonic::Response<super::MetadataSchema>, 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.aiplatform.v1.MetadataService/CreateMetadataSchema",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"CreateMetadataSchema",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves a specific MetadataSchema.
pub async fn get_metadata_schema(
&mut self,
request: impl tonic::IntoRequest<super::GetMetadataSchemaRequest>,
) -> std::result::Result<tonic::Response<super::MetadataSchema>, 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.aiplatform.v1.MetadataService/GetMetadataSchema",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"GetMetadataSchema",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists MetadataSchemas.
pub async fn list_metadata_schemas(
&mut self,
request: impl tonic::IntoRequest<super::ListMetadataSchemasRequest>,
) -> std::result::Result<
tonic::Response<super::ListMetadataSchemasResponse>,
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.aiplatform.v1.MetadataService/ListMetadataSchemas",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"ListMetadataSchemas",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves lineage of an Artifact represented through Artifacts and
/// Executions connected by Event edges and returned as a LineageSubgraph.
pub async fn query_artifact_lineage_subgraph(
&mut self,
request: impl tonic::IntoRequest<super::QueryArtifactLineageSubgraphRequest>,
) -> std::result::Result<
tonic::Response<super::LineageSubgraph>,
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.aiplatform.v1.MetadataService/QueryArtifactLineageSubgraph",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.MetadataService",
"QueryArtifactLineageSubgraph",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// DataLabelingJob is used to trigger a human labeling job on unlabeled data
/// from the following Dataset:
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataLabelingJob {
/// Output only. Resource name of the DataLabelingJob.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The user-defined name of the DataLabelingJob.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
/// Display name of a DataLabelingJob.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. Dataset resource names. Right now we only support labeling from a
/// single Dataset. Format:
/// `projects/{project}/locations/{location}/datasets/{dataset}`
#[prost(string, repeated, tag = "3")]
pub datasets: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Labels to assign to annotations generated by this DataLabelingJob.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable.
#[prost(btree_map = "string, string", tag = "12")]
pub annotation_labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Required. Number of labelers to work on each DataItem.
#[prost(int32, tag = "4")]
pub labeler_count: i32,
/// Required. The Google Cloud Storage location of the instruction pdf. This
/// pdf is shared with labelers, and provides detailed description on how to
/// label DataItems in Datasets.
#[prost(string, tag = "5")]
pub instruction_uri: ::prost::alloc::string::String,
/// Required. Points to a YAML file stored on Google Cloud Storage describing
/// the config for a specific type of DataLabelingJob. The schema files that
/// can be used here are found in the
/// <https://storage.googleapis.com/google-cloud-aiplatform> bucket in the
/// /schema/datalabelingjob/inputs/ folder.
#[prost(string, tag = "6")]
pub inputs_schema_uri: ::prost::alloc::string::String,
/// Required. Input config parameters for the DataLabelingJob.
#[prost(message, optional, tag = "7")]
pub inputs: ::core::option::Option<::prost_types::Value>,
/// Output only. The detailed state of the job.
#[prost(enumeration = "JobState", tag = "8")]
pub state: i32,
/// Output only. Current labeling job progress percentage scaled in interval
/// \[0, 100\], indicating the percentage of DataItems that has been finished.
#[prost(int32, tag = "13")]
pub labeling_progress: i32,
/// Output only. Estimated cost(in US dollars) that the DataLabelingJob has
/// incurred to date.
#[prost(message, optional, tag = "14")]
pub current_spend: ::core::option::Option<super::super::super::r#type::Money>,
/// Output only. Timestamp when this DataLabelingJob was created.
#[prost(message, optional, tag = "9")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this DataLabelingJob was updated most recently.
#[prost(message, optional, tag = "10")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. DataLabelingJob errors. It is only populated when job's state
/// is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
#[prost(message, optional, tag = "22")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// The labels with user-defined metadata to organize your DataLabelingJobs.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
/// and are immutable. Following system labels exist for each DataLabelingJob:
///
/// * "aiplatform.googleapis.com/schema": output only, its value is the
/// [inputs_schema][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
/// title.
#[prost(btree_map = "string, string", tag = "11")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// The SpecialistPools' resource names associated with this job.
#[prost(string, repeated, tag = "16")]
pub specialist_pools: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Customer-managed encryption key spec for a DataLabelingJob. If set, this
/// DataLabelingJob will be secured by this key.
///
/// Note: Annotations created in the DataLabelingJob are associated with
/// the EncryptionSpec of the Dataset they are exported to.
#[prost(message, optional, tag = "20")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Parameters that configure the active learning pipeline. Active learning
/// will label the data incrementally via several iterations. For every
/// iteration, it will select a batch of data based on the sampling strategy.
#[prost(message, optional, tag = "21")]
pub active_learning_config: ::core::option::Option<ActiveLearningConfig>,
}
/// Parameters that configure the active learning pipeline. Active learning will
/// label the data incrementally by several iterations. For every iteration, it
/// will select a batch of data based on the sampling strategy.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ActiveLearningConfig {
/// Active learning data sampling config. For every active learning labeling
/// iteration, it will select a batch of data based on the sampling strategy.
#[prost(message, optional, tag = "3")]
pub sample_config: ::core::option::Option<SampleConfig>,
/// CMLE training config. For every active learning labeling iteration, system
/// will train a machine learning model on CMLE. The trained model will be used
/// by data sampling algorithm to select DataItems.
#[prost(message, optional, tag = "4")]
pub training_config: ::core::option::Option<TrainingConfig>,
/// Required. Max human labeling DataItems. The rest part will be labeled by
/// machine.
#[prost(oneof = "active_learning_config::HumanLabelingBudget", tags = "1, 2")]
pub human_labeling_budget: ::core::option::Option<
active_learning_config::HumanLabelingBudget,
>,
}
/// Nested message and enum types in `ActiveLearningConfig`.
pub mod active_learning_config {
/// Required. Max human labeling DataItems. The rest part will be labeled by
/// machine.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum HumanLabelingBudget {
/// Max number of human labeled DataItems.
#[prost(int64, tag = "1")]
MaxDataItemCount(i64),
/// Max percent of total DataItems for human labeling.
#[prost(int32, tag = "2")]
MaxDataItemPercentage(i32),
}
}
/// Active learning data sampling config. For every active learning labeling
/// iteration, it will select a batch of data based on the sampling strategy.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SampleConfig {
/// Field to choose sampling strategy. Sampling strategy will decide which data
/// should be selected for human labeling in every batch.
#[prost(enumeration = "sample_config::SampleStrategy", tag = "5")]
pub sample_strategy: i32,
/// Decides sample size for the initial batch. initial_batch_sample_percentage
/// is used by default.
#[prost(oneof = "sample_config::InitialBatchSampleSize", tags = "1")]
pub initial_batch_sample_size: ::core::option::Option<
sample_config::InitialBatchSampleSize,
>,
/// Decides sample size for the following batches.
/// following_batch_sample_percentage is used by default.
#[prost(oneof = "sample_config::FollowingBatchSampleSize", tags = "3")]
pub following_batch_sample_size: ::core::option::Option<
sample_config::FollowingBatchSampleSize,
>,
}
/// Nested message and enum types in `SampleConfig`.
pub mod sample_config {
/// Sample strategy decides which subset of DataItems should be selected for
/// human labeling in every batch.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum SampleStrategy {
/// Default will be treated as UNCERTAINTY.
Unspecified = 0,
/// Sample the most uncertain data to label.
Uncertainty = 1,
}
impl SampleStrategy {
/// 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 {
SampleStrategy::Unspecified => "SAMPLE_STRATEGY_UNSPECIFIED",
SampleStrategy::Uncertainty => "UNCERTAINTY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SAMPLE_STRATEGY_UNSPECIFIED" => Some(Self::Unspecified),
"UNCERTAINTY" => Some(Self::Uncertainty),
_ => None,
}
}
}
/// Decides sample size for the initial batch. initial_batch_sample_percentage
/// is used by default.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum InitialBatchSampleSize {
/// The percentage of data needed to be labeled in the first batch.
#[prost(int32, tag = "1")]
InitialBatchSamplePercentage(i32),
}
/// Decides sample size for the following batches.
/// following_batch_sample_percentage is used by default.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum FollowingBatchSampleSize {
/// The percentage of data needed to be labeled in each following batch
/// (except the first batch).
#[prost(int32, tag = "3")]
FollowingBatchSamplePercentage(i32),
}
}
/// CMLE training config. For every active learning labeling iteration, system
/// will train a machine learning model on CMLE. The trained model will be used
/// by data sampling algorithm to select DataItems.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TrainingConfig {
/// The timeout hours for the CMLE training job, expressed in milli hours
/// i.e. 1,000 value in this field means 1 hour.
#[prost(int64, tag = "1")]
pub timeout_training_milli_hours: i64,
}
/// A TensorboardExperiment is a group of TensorboardRuns, that are typically the
/// results of a training job run, in a Tensorboard.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TensorboardExperiment {
/// Output only. Name of the TensorboardExperiment.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// User provided name of this TensorboardExperiment.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Description of this TensorboardExperiment.
#[prost(string, tag = "3")]
pub description: ::prost::alloc::string::String,
/// Output only. Timestamp when this TensorboardExperiment was created.
#[prost(message, optional, tag = "4")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when this TensorboardExperiment was last updated.
#[prost(message, optional, tag = "5")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The labels with user-defined metadata to organize your
/// TensorboardExperiment.
///
/// Label keys and values cannot be longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
/// No more than 64 user labels can be associated with one Dataset (System
/// labels are excluded).
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
/// System reserved label keys are prefixed with `aiplatform.googleapis.com/`
/// and are immutable. The following system labels exist for each Dataset:
///
/// * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
/// value is the
/// [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
/// title.
#[prost(btree_map = "string, string", tag = "6")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Used to perform consistent read-modify-write updates. If not set, a blind
/// "overwrite" update happens.
#[prost(string, tag = "7")]
pub etag: ::prost::alloc::string::String,
/// Immutable. Source of the TensorboardExperiment. Example: a custom training
/// job.
#[prost(string, tag = "8")]
pub source: ::prost::alloc::string::String,
}
/// Represents a Neural Architecture Search (NAS) job.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NasJob {
/// Output only. Resource name of the NasJob.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The display name of the NasJob.
/// The name can be up to 128 characters long and can consist of any UTF-8
/// characters.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. The specification of a NasJob.
#[prost(message, optional, tag = "4")]
pub nas_job_spec: ::core::option::Option<NasJobSpec>,
/// Output only. Output of the NasJob.
#[prost(message, optional, tag = "5")]
pub nas_job_output: ::core::option::Option<NasJobOutput>,
/// Output only. The detailed state of the job.
#[prost(enumeration = "JobState", tag = "6")]
pub state: i32,
/// Output only. Time when the NasJob was created.
#[prost(message, optional, tag = "7")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the NasJob for the first time entered the
/// `JOB_STATE_RUNNING` state.
#[prost(message, optional, tag = "8")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the NasJob entered any of the following states:
/// `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
#[prost(message, optional, tag = "9")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the NasJob was most recently updated.
#[prost(message, optional, tag = "10")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Only populated when job's state is JOB_STATE_FAILED or
/// JOB_STATE_CANCELLED.
#[prost(message, optional, tag = "11")]
pub error: ::core::option::Option<super::super::super::rpc::Status>,
/// The labels with user-defined metadata to organize NasJobs.
///
/// Label keys and values can be no longer than 64 characters
/// (Unicode codepoints), can only contain lowercase letters, numeric
/// characters, underscores and dashes. International characters are allowed.
///
/// See <https://goo.gl/xmQnxf> for more information and examples of labels.
#[prost(btree_map = "string, string", tag = "12")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Customer-managed encryption key options for a NasJob.
/// If this is set, then all resources created by the NasJob
/// will be encrypted with the provided encryption key.
#[prost(message, optional, tag = "13")]
pub encryption_spec: ::core::option::Option<EncryptionSpec>,
/// Optional. Enable a separation of Custom model training
/// and restricted image training for tenant project.
#[deprecated]
#[prost(bool, tag = "14")]
pub enable_restricted_image_training: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "15")]
pub satisfies_pzs: bool,
/// Output only. Reserved for future use.
#[prost(bool, tag = "16")]
pub satisfies_pzi: bool,
}
/// Represents a NasTrial details along with its parameters. If there is a
/// corresponding train NasTrial, the train NasTrial is also returned.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NasTrialDetail {
/// Output only. Resource name of the NasTrialDetail.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The parameters for the NasJob NasTrial.
#[prost(string, tag = "2")]
pub parameters: ::prost::alloc::string::String,
/// The requested search NasTrial.
#[prost(message, optional, tag = "3")]
pub search_trial: ::core::option::Option<NasTrial>,
/// The train NasTrial corresponding to
/// [search_trial][google.cloud.aiplatform.v1.NasTrialDetail.search_trial].
/// Only populated if
/// [search_trial][google.cloud.aiplatform.v1.NasTrialDetail.search_trial] is
/// used for training.
#[prost(message, optional, tag = "4")]
pub train_trial: ::core::option::Option<NasTrial>,
}
/// Represents the spec of a NasJob.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NasJobSpec {
/// The ID of the existing NasJob in the same Project and Location
/// which will be used to resume search. search_space_spec and
/// nas_algorithm_spec are obtained from previous NasJob hence should not
/// provide them again for this NasJob.
#[prost(string, tag = "3")]
pub resume_nas_job_id: ::prost::alloc::string::String,
/// It defines the search space for Neural Architecture Search (NAS).
#[prost(string, tag = "1")]
pub search_space_spec: ::prost::alloc::string::String,
/// The Neural Architecture Search (NAS) algorithm specification.
#[prost(oneof = "nas_job_spec::NasAlgorithmSpec", tags = "2")]
pub nas_algorithm_spec: ::core::option::Option<nas_job_spec::NasAlgorithmSpec>,
}
/// Nested message and enum types in `NasJobSpec`.
pub mod nas_job_spec {
/// The spec of multi-trial Neural Architecture Search (NAS).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MultiTrialAlgorithmSpec {
/// The multi-trial Neural Architecture Search (NAS) algorithm
/// type. Defaults to `REINFORCEMENT_LEARNING`.
#[prost(
enumeration = "multi_trial_algorithm_spec::MultiTrialAlgorithm",
tag = "1"
)]
pub multi_trial_algorithm: i32,
/// Metric specs for the NAS job.
/// Validation for this field is done at `multi_trial_algorithm_spec` field.
#[prost(message, optional, tag = "2")]
pub metric: ::core::option::Option<multi_trial_algorithm_spec::MetricSpec>,
/// Required. Spec for search trials.
#[prost(message, optional, tag = "3")]
pub search_trial_spec: ::core::option::Option<
multi_trial_algorithm_spec::SearchTrialSpec,
>,
/// Spec for train trials. Top N \[TrainTrialSpec.max_parallel_trial_count\]
/// search trials will be trained for every M
/// \[TrainTrialSpec.frequency\] trials searched.
#[prost(message, optional, tag = "4")]
pub train_trial_spec: ::core::option::Option<
multi_trial_algorithm_spec::TrainTrialSpec,
>,
}
/// Nested message and enum types in `MultiTrialAlgorithmSpec`.
pub mod multi_trial_algorithm_spec {
/// Represents a metric to optimize.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetricSpec {
/// Required. The ID of the metric. Must not contain whitespaces.
#[prost(string, tag = "1")]
pub metric_id: ::prost::alloc::string::String,
/// Required. The optimization goal of the metric.
#[prost(enumeration = "metric_spec::GoalType", tag = "2")]
pub goal: i32,
}
/// Nested message and enum types in `MetricSpec`.
pub mod metric_spec {
/// The available types of optimization goals.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum GoalType {
/// Goal Type will default to maximize.
Unspecified = 0,
/// Maximize the goal metric.
Maximize = 1,
/// Minimize the goal metric.
Minimize = 2,
}
impl GoalType {
/// 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 {
GoalType::Unspecified => "GOAL_TYPE_UNSPECIFIED",
GoalType::Maximize => "MAXIMIZE",
GoalType::Minimize => "MINIMIZE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"GOAL_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"MAXIMIZE" => Some(Self::Maximize),
"MINIMIZE" => Some(Self::Minimize),
_ => None,
}
}
}
}
/// Represent spec for search trials.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchTrialSpec {
/// Required. The spec of a search trial job. The same spec applies to
/// all search trials.
#[prost(message, optional, tag = "1")]
pub search_trial_job_spec: ::core::option::Option<
super::super::CustomJobSpec,
>,
/// Required. The maximum number of Neural Architecture Search (NAS) trials
/// to run.
#[prost(int32, tag = "2")]
pub max_trial_count: i32,
/// Required. The maximum number of trials to run in parallel.
#[prost(int32, tag = "3")]
pub max_parallel_trial_count: i32,
/// The number of failed trials that need to be seen before failing
/// the NasJob.
///
/// If set to 0, Vertex AI decides how many trials must fail
/// before the whole job fails.
#[prost(int32, tag = "4")]
pub max_failed_trial_count: i32,
}
/// Represent spec for train trials.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TrainTrialSpec {
/// Required. The spec of a train trial job. The same spec applies to
/// all train trials.
#[prost(message, optional, tag = "1")]
pub train_trial_job_spec: ::core::option::Option<
super::super::CustomJobSpec,
>,
/// Required. The maximum number of trials to run in parallel.
#[prost(int32, tag = "2")]
pub max_parallel_trial_count: i32,
/// Required. Frequency of search trials to start train stage. Top N
/// \[TrainTrialSpec.max_parallel_trial_count\]
/// search trials will be trained for every M
/// \[TrainTrialSpec.frequency\] trials searched.
#[prost(int32, tag = "3")]
pub frequency: i32,
}
/// The available types of multi-trial algorithms.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum MultiTrialAlgorithm {
/// Defaults to `REINFORCEMENT_LEARNING`.
Unspecified = 0,
/// The Reinforcement Learning Algorithm for Multi-trial Neural
/// Architecture Search (NAS).
ReinforcementLearning = 1,
/// The Grid Search Algorithm for Multi-trial Neural
/// Architecture Search (NAS).
GridSearch = 2,
}
impl MultiTrialAlgorithm {
/// 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 {
MultiTrialAlgorithm::Unspecified => {
"MULTI_TRIAL_ALGORITHM_UNSPECIFIED"
}
MultiTrialAlgorithm::ReinforcementLearning => {
"REINFORCEMENT_LEARNING"
}
MultiTrialAlgorithm::GridSearch => "GRID_SEARCH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MULTI_TRIAL_ALGORITHM_UNSPECIFIED" => Some(Self::Unspecified),
"REINFORCEMENT_LEARNING" => Some(Self::ReinforcementLearning),
"GRID_SEARCH" => Some(Self::GridSearch),
_ => None,
}
}
}
}
/// The Neural Architecture Search (NAS) algorithm specification.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum NasAlgorithmSpec {
/// The spec of multi-trial algorithms.
#[prost(message, tag = "2")]
MultiTrialAlgorithmSpec(MultiTrialAlgorithmSpec),
}
}
/// Represents a uCAIP NasJob output.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NasJobOutput {
/// The output of this Neural Architecture Search (NAS) job.
#[prost(oneof = "nas_job_output::Output", tags = "1")]
pub output: ::core::option::Option<nas_job_output::Output>,
}
/// Nested message and enum types in `NasJobOutput`.
pub mod nas_job_output {
/// The output of a multi-trial Neural Architecture Search (NAS) jobs.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MultiTrialJobOutput {
/// Output only. List of NasTrials that were started as part of search stage.
#[prost(message, repeated, tag = "1")]
pub search_trials: ::prost::alloc::vec::Vec<super::NasTrial>,
/// Output only. List of NasTrials that were started as part of train stage.
#[prost(message, repeated, tag = "2")]
pub train_trials: ::prost::alloc::vec::Vec<super::NasTrial>,
}
/// The output of this Neural Architecture Search (NAS) job.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Output {
/// Output only. The output of this multi-trial Neural Architecture Search
/// (NAS) job.
#[prost(message, tag = "1")]
MultiTrialJobOutput(MultiTrialJobOutput),
}
}
/// Represents a uCAIP NasJob trial.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NasTrial {
/// Output only. The identifier of the NasTrial assigned by the service.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Output only. The detailed state of the NasTrial.
#[prost(enumeration = "nas_trial::State", tag = "2")]
pub state: i32,
/// Output only. The final measurement containing the objective value.
#[prost(message, optional, tag = "3")]
pub final_measurement: ::core::option::Option<Measurement>,
/// Output only. Time when the NasTrial was started.
#[prost(message, optional, tag = "4")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Time when the NasTrial's status changed to `SUCCEEDED` or
/// `INFEASIBLE`.
#[prost(message, optional, tag = "5")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Nested message and enum types in `NasTrial`.
pub mod nas_trial {
/// Describes a NasTrial state.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// The NasTrial state is unspecified.
Unspecified = 0,
/// Indicates that a specific NasTrial has been requested, but it has not yet
/// been suggested by the service.
Requested = 1,
/// Indicates that the NasTrial has been suggested.
Active = 2,
/// Indicates that the NasTrial should stop according to the service.
Stopping = 3,
/// Indicates that the NasTrial is completed successfully.
Succeeded = 4,
/// Indicates that the NasTrial should not be attempted again.
/// The service will set a NasTrial to INFEASIBLE when it's done but missing
/// the final_measurement.
Infeasible = 5,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Requested => "REQUESTED",
State::Active => "ACTIVE",
State::Stopping => "STOPPING",
State::Succeeded => "SUCCEEDED",
State::Infeasible => "INFEASIBLE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"REQUESTED" => Some(Self::Requested),
"ACTIVE" => Some(Self::Active),
"STOPPING" => Some(Self::Stopping),
"SUCCEEDED" => Some(Self::Succeeded),
"INFEASIBLE" => Some(Self::Infeasible),
_ => None,
}
}
}
}
/// Request message for
/// [GenAiTuningService.CreateTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.CreateTuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTuningJobRequest {
/// Required. The resource name of the Location to create the TuningJob in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The TuningJob to create.
#[prost(message, optional, tag = "2")]
pub tuning_job: ::core::option::Option<TuningJob>,
}
/// Request message for
/// [GenAiTuningService.GetTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.GetTuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTuningJobRequest {
/// Required. The name of the TuningJob resource. Format:
/// `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [GenAiTuningService.ListTuningJobs][google.cloud.aiplatform.v1.GenAiTuningService.ListTuningJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTuningJobsRequest {
/// Required. The resource name of the Location to list the TuningJobs from.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The standard list filter.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. The standard list page token.
/// Typically obtained via [ListTuningJob.next_page_token][] of the
/// previous GenAiTuningService.ListTuningJob][] call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [GenAiTuningService.ListTuningJobs][google.cloud.aiplatform.v1.GenAiTuningService.ListTuningJobs]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTuningJobsResponse {
/// List of TuningJobs in the requested page.
#[prost(message, repeated, tag = "1")]
pub tuning_jobs: ::prost::alloc::vec::Vec<TuningJob>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListTuningJobsRequest.page_token][google.cloud.aiplatform.v1.ListTuningJobsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [GenAiTuningService.CancelTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.CancelTuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelTuningJobRequest {
/// Required. The name of the TuningJob to cancel. Format:
/// `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod gen_ai_tuning_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for creating and managing GenAI Tuning Jobs.
#[derive(Debug, Clone)]
pub struct GenAiTuningServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> GenAiTuningServiceClient<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,
) -> GenAiTuningServiceClient<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,
{
GenAiTuningServiceClient::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 TuningJob. A created TuningJob right away will be attempted to
/// be run.
pub async fn create_tuning_job(
&mut self,
request: impl tonic::IntoRequest<super::CreateTuningJobRequest>,
) -> std::result::Result<tonic::Response<super::TuningJob>, 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.aiplatform.v1.GenAiTuningService/CreateTuningJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.GenAiTuningService",
"CreateTuningJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a TuningJob.
pub async fn get_tuning_job(
&mut self,
request: impl tonic::IntoRequest<super::GetTuningJobRequest>,
) -> std::result::Result<tonic::Response<super::TuningJob>, 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.aiplatform.v1.GenAiTuningService/GetTuningJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.GenAiTuningService",
"GetTuningJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists TuningJobs in a Location.
pub async fn list_tuning_jobs(
&mut self,
request: impl tonic::IntoRequest<super::ListTuningJobsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTuningJobsResponse>,
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.aiplatform.v1.GenAiTuningService/ListTuningJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.GenAiTuningService",
"ListTuningJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels a TuningJob.
/// Starts asynchronous cancellation on the TuningJob. The server makes a best
/// effort to cancel the job, but success is not guaranteed. Clients can use
/// [GenAiTuningService.GetTuningJob][google.cloud.aiplatform.v1.GenAiTuningService.GetTuningJob]
/// or other methods to check whether the cancellation succeeded or whether the
/// job completed despite cancellation. On successful cancellation, the
/// TuningJob is not deleted; instead it becomes a job with a
/// [TuningJob.error][google.cloud.aiplatform.v1.TuningJob.error] value with a
/// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
/// `Code.CANCELLED`, and
/// [TuningJob.state][google.cloud.aiplatform.v1.TuningJob.state] is set to
/// `CANCELLED`.
pub async fn cancel_tuning_job(
&mut self,
request: impl tonic::IntoRequest<super::CancelTuningJobRequest>,
) -> 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.aiplatform.v1.GenAiTuningService/CancelTuningJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.GenAiTuningService",
"CancelTuningJob",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for
/// [ScheduleService.CreateSchedule][google.cloud.aiplatform.v1.ScheduleService.CreateSchedule].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateScheduleRequest {
/// Required. The resource name of the Location to create the Schedule in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Schedule to create.
#[prost(message, optional, tag = "2")]
pub schedule: ::core::option::Option<Schedule>,
}
/// Request message for
/// [ScheduleService.GetSchedule][google.cloud.aiplatform.v1.ScheduleService.GetSchedule].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetScheduleRequest {
/// Required. The name of the Schedule resource.
/// Format:
/// `projects/{project}/locations/{location}/schedules/{schedule}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchedulesRequest {
/// Required. The resource name of the Location to list the Schedules from.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the Schedules that match the filter expression. The following
/// fields are supported:
///
/// * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
/// * `state`: Supports `=` and `!=` comparisons.
/// * `request`: Supports existence of the <request_type> check.
/// (e.g. `create_pipeline_job_request:*` --> Schedule has
/// create_pipeline_job_request).
/// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be in RFC 3339 format.
/// * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
/// Values must be in RFC 3339 format.
/// * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*`
/// existence check. Values must be in RFC 3339 format.
/// * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=`
/// comparisons. Values must be in RFC 3339 format.
///
///
/// Filter expressions can be combined together using logical operators
/// (`NOT`, `AND` & `OR`).
/// The syntax to define filter expression is based on
/// <https://google.aip.dev/160.>
///
/// Examples:
///
/// * `state="ACTIVE" AND display_name:"my_schedule_*"`
/// * `NOT display_name="my_schedule"`
/// * `create_time>"2021-05-18T00:00:00Z"`
/// * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*`
/// * `create_pipeline_job_request:*`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
/// Default to 100 if not specified.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token]
/// of the previous
/// [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// A comma-separated list of fields to order by. The default sort order is in
/// ascending order. Use "desc" after a field name for descending. You can have
/// multiple order_by fields provided.
///
/// For example, using "create_time desc, end_time" will order results by
/// create time in descending order, and if there are multiple schedules having
/// the same create time, order them by the end time in ascending order.
///
/// If order_by is not specified, it will order by default with create_time in
/// descending order.
///
/// Supported fields:
///
/// * `create_time`
/// * `start_time`
/// * `end_time`
/// * `next_run_time`
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchedulesResponse {
/// List of Schedules in the requested page.
#[prost(message, repeated, tag = "1")]
pub schedules: ::prost::alloc::vec::Vec<Schedule>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListSchedulesRequest.page_token][google.cloud.aiplatform.v1.ListSchedulesRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [ScheduleService.DeleteSchedule][google.cloud.aiplatform.v1.ScheduleService.DeleteSchedule].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteScheduleRequest {
/// Required. The name of the Schedule resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/schedules/{schedule}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ScheduleService.PauseSchedule][google.cloud.aiplatform.v1.ScheduleService.PauseSchedule].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PauseScheduleRequest {
/// Required. The name of the Schedule resource to be paused.
/// Format:
/// `projects/{project}/locations/{location}/schedules/{schedule}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ScheduleService.ResumeSchedule][google.cloud.aiplatform.v1.ScheduleService.ResumeSchedule].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResumeScheduleRequest {
/// Required. The name of the Schedule resource to be resumed.
/// Format:
/// `projects/{project}/locations/{location}/schedules/{schedule}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. Whether to backfill missed runs when the schedule is resumed from
/// PAUSED state. If set to true, all missed runs will be scheduled. New runs
/// will be scheduled after the backfill is complete. This will also update
/// [Schedule.catch_up][google.cloud.aiplatform.v1.Schedule.catch_up] field.
/// Default to false.
#[prost(bool, tag = "2")]
pub catch_up: bool,
}
/// Request message for
/// [ScheduleService.UpdateSchedule][google.cloud.aiplatform.v1.ScheduleService.UpdateSchedule].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateScheduleRequest {
/// Required. The Schedule which replaces the resource on the server.
/// The following restrictions will be applied:
///
/// * The scheduled request type cannot be changed.
/// * The non-empty fields cannot be unset.
/// * The output_only fields will be ignored if specified.
#[prost(message, optional, tag = "1")]
pub schedule: ::core::option::Option<Schedule>,
/// Required. The update mask applies to the resource. See
/// [google.protobuf.FieldMask][google.protobuf.FieldMask].
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Generated client implementations.
pub mod schedule_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for creating and managing Vertex AI's Schedule resources to
/// periodically launch shceudled runs to make API calls.
#[derive(Debug, Clone)]
pub struct ScheduleServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> ScheduleServiceClient<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,
) -> ScheduleServiceClient<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,
{
ScheduleServiceClient::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 Schedule.
pub async fn create_schedule(
&mut self,
request: impl tonic::IntoRequest<super::CreateScheduleRequest>,
) -> std::result::Result<tonic::Response<super::Schedule>, 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.aiplatform.v1.ScheduleService/CreateSchedule",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ScheduleService",
"CreateSchedule",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a Schedule.
pub async fn delete_schedule(
&mut self,
request: impl tonic::IntoRequest<super::DeleteScheduleRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.ScheduleService/DeleteSchedule",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ScheduleService",
"DeleteSchedule",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a Schedule.
pub async fn get_schedule(
&mut self,
request: impl tonic::IntoRequest<super::GetScheduleRequest>,
) -> std::result::Result<tonic::Response<super::Schedule>, 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.aiplatform.v1.ScheduleService/GetSchedule",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ScheduleService",
"GetSchedule",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Schedules in a Location.
pub async fn list_schedules(
&mut self,
request: impl tonic::IntoRequest<super::ListSchedulesRequest>,
) -> std::result::Result<
tonic::Response<super::ListSchedulesResponse>,
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.aiplatform.v1.ScheduleService/ListSchedules",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ScheduleService",
"ListSchedules",
),
);
self.inner.unary(req, path, codec).await
}
/// Pauses a Schedule. Will mark
/// [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'PAUSED'. If
/// the schedule is paused, no new runs will be created. Already created runs
/// will NOT be paused or canceled.
pub async fn pause_schedule(
&mut self,
request: impl tonic::IntoRequest<super::PauseScheduleRequest>,
) -> 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.aiplatform.v1.ScheduleService/PauseSchedule",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ScheduleService",
"PauseSchedule",
),
);
self.inner.unary(req, path, codec).await
}
/// Resumes a paused Schedule to start scheduling new runs. Will mark
/// [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'ACTIVE'.
/// Only paused Schedule can be resumed.
///
/// When the Schedule is resumed, new runs will be scheduled starting from the
/// next execution time after the current time based on the time_specification
/// in the Schedule. If [Schedule.catchUp][] is set up true, all
/// missed runs will be scheduled for backfill first.
pub async fn resume_schedule(
&mut self,
request: impl tonic::IntoRequest<super::ResumeScheduleRequest>,
) -> 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.aiplatform.v1.ScheduleService/ResumeSchedule",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ScheduleService",
"ResumeSchedule",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an active or paused Schedule.
///
/// When the Schedule is updated, new runs will be scheduled starting from the
/// updated next execution time after the update time based on the
/// time_specification in the updated Schedule. All unstarted runs before the
/// update time will be skipped while already created runs will NOT be paused
/// or canceled.
pub async fn update_schedule(
&mut self,
request: impl tonic::IntoRequest<super::UpdateScheduleRequest>,
) -> std::result::Result<tonic::Response<super::Schedule>, 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.aiplatform.v1.ScheduleService/UpdateSchedule",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.ScheduleService",
"UpdateSchedule",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for
/// [VizierService.GetStudy][google.cloud.aiplatform.v1.VizierService.GetStudy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetStudyRequest {
/// Required. The name of the Study resource.
/// Format: `projects/{project}/locations/{location}/studies/{study}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.CreateStudy][google.cloud.aiplatform.v1.VizierService.CreateStudy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateStudyRequest {
/// Required. The resource name of the Location to create the CustomJob in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Study configuration used to create the Study.
#[prost(message, optional, tag = "2")]
pub study: ::core::option::Option<Study>,
}
/// Request message for
/// [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListStudiesRequest {
/// Required. The resource name of the Location to list the Study from.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. A page token to request the next page of results.
/// If unspecified, there are no subsequent pages.
#[prost(string, tag = "2")]
pub page_token: ::prost::alloc::string::String,
/// Optional. The maximum number of studies to return per "page" of results.
/// If unspecified, service will pick an appropriate default.
#[prost(int32, tag = "3")]
pub page_size: i32,
}
/// Response message for
/// [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListStudiesResponse {
/// The studies associated with the project.
#[prost(message, repeated, tag = "1")]
pub studies: ::prost::alloc::vec::Vec<Study>,
/// Passes this token as the `page_token` field of the request for a
/// subsequent call.
/// If this field is omitted, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.DeleteStudy][google.cloud.aiplatform.v1.VizierService.DeleteStudy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteStudyRequest {
/// Required. The name of the Study resource to be deleted.
/// Format: `projects/{project}/locations/{location}/studies/{study}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.LookupStudy][google.cloud.aiplatform.v1.VizierService.LookupStudy].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LookupStudyRequest {
/// Required. The resource name of the Location to get the Study from.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The user-defined display name of the Study
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SuggestTrialsRequest {
/// Required. The project and location that the Study belongs to.
/// Format: `projects/{project}/locations/{location}/studies/{study}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The number of suggestions requested. It must be positive.
#[prost(int32, tag = "2")]
pub suggestion_count: i32,
/// Required. The identifier of the client that is requesting the suggestion.
///
/// If multiple SuggestTrialsRequests have the same `client_id`,
/// the service will return the identical suggested Trial if the Trial is
/// pending, and provide a new Trial if the last suggested Trial was completed.
#[prost(string, tag = "3")]
pub client_id: ::prost::alloc::string::String,
/// Optional. This allows you to specify the "context" for a Trial; a context
/// is a slice (a subspace) of the search space.
///
/// Typical uses for contexts:
/// 1) You are using Vizier to tune a server for best performance, but there's
/// a strong weekly cycle. The context specifies the day-of-week.
/// This allows Tuesday to generalize from Wednesday without assuming that
/// everything is identical.
/// 2) Imagine you're optimizing some medical treatment for people.
/// As they walk in the door, you know certain facts about them
/// (e.g. sex, weight, height, blood-pressure). Put that information in the
/// context, and Vizier will adapt its suggestions to the patient.
/// 3) You want to do a fair A/B test efficiently. Specify the "A" and "B"
/// conditions as contexts, and Vizier will generalize between "A" and "B"
/// conditions. If they are similar, this will allow Vizier to converge
/// to the optimum faster than if "A" and "B" were separate Studies.
/// NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the
/// CreateTrial() RPC; that's the asynchronous option where you don't need a
/// close association between contexts and suggestions.
///
/// NOTE: All the Parameters you set in a context MUST be defined in the
/// Study.
/// NOTE: You must supply 0 or $suggestion_count contexts.
/// If you don't supply any contexts, Vizier will make suggestions
/// from the full search space specified in the StudySpec; if you supply
/// a full set of context, each suggestion will match the corresponding
/// context.
/// NOTE: A Context with no features set matches anything, and allows
/// suggestions from the full search space.
/// NOTE: Contexts MUST lie within the search space specified in the
/// StudySpec. It's an error if they don't.
/// NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before
/// new suggestions are generated.
/// NOTE: Generation of suggestions involves a match between a Context and
/// (optionally) a REQUESTED trial; if that match is not fully specified, a
/// suggestion will be geneated in the merged subspace.
#[prost(message, repeated, tag = "4")]
pub contexts: ::prost::alloc::vec::Vec<TrialContext>,
}
/// Response message for
/// [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SuggestTrialsResponse {
/// A list of Trials.
#[prost(message, repeated, tag = "1")]
pub trials: ::prost::alloc::vec::Vec<Trial>,
/// The state of the Study.
#[prost(enumeration = "study::State", tag = "2")]
pub study_state: i32,
/// The time at which the operation was started.
#[prost(message, optional, tag = "3")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which operation processing completed.
#[prost(message, optional, tag = "4")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Details of operations that perform Trials suggestion.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SuggestTrialsMetadata {
/// Operation metadata for suggesting Trials.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// The identifier of the client that is requesting the suggestion.
///
/// If multiple SuggestTrialsRequests have the same `client_id`,
/// the service will return the identical suggested Trial if the Trial is
/// pending, and provide a new Trial if the last suggested Trial was completed.
#[prost(string, tag = "2")]
pub client_id: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.CreateTrial][google.cloud.aiplatform.v1.VizierService.CreateTrial].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTrialRequest {
/// Required. The resource name of the Study to create the Trial in.
/// Format: `projects/{project}/locations/{location}/studies/{study}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Trial to create.
#[prost(message, optional, tag = "2")]
pub trial: ::core::option::Option<Trial>,
}
/// Request message for
/// [VizierService.GetTrial][google.cloud.aiplatform.v1.VizierService.GetTrial].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTrialRequest {
/// Required. The name of the Trial resource.
/// Format:
/// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTrialsRequest {
/// Required. The resource name of the Study to list the Trial from.
/// Format: `projects/{project}/locations/{location}/studies/{study}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. A page token to request the next page of results.
/// If unspecified, there are no subsequent pages.
#[prost(string, tag = "2")]
pub page_token: ::prost::alloc::string::String,
/// Optional. The number of Trials to retrieve per "page" of results.
/// If unspecified, the service will pick an appropriate default.
#[prost(int32, tag = "3")]
pub page_size: i32,
}
/// Response message for
/// [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTrialsResponse {
/// The Trials associated with the Study.
#[prost(message, repeated, tag = "1")]
pub trials: ::prost::alloc::vec::Vec<Trial>,
/// Pass this token as the `page_token` field of the request for a
/// subsequent call.
/// If this field is omitted, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AddTrialMeasurementRequest {
/// Required. The name of the trial to add measurement.
/// Format:
/// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
#[prost(string, tag = "1")]
pub trial_name: ::prost::alloc::string::String,
/// Required. The measurement to be added to a Trial.
#[prost(message, optional, tag = "3")]
pub measurement: ::core::option::Option<Measurement>,
}
/// Request message for
/// [VizierService.CompleteTrial][google.cloud.aiplatform.v1.VizierService.CompleteTrial].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CompleteTrialRequest {
/// Required. The Trial's name.
/// Format:
/// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. If provided, it will be used as the completed Trial's
/// final_measurement; Otherwise, the service will auto-select a
/// previously reported measurement as the final-measurement
#[prost(message, optional, tag = "2")]
pub final_measurement: ::core::option::Option<Measurement>,
/// Optional. True if the Trial cannot be run with the given Parameter, and
/// final_measurement will be ignored.
#[prost(bool, tag = "3")]
pub trial_infeasible: bool,
/// Optional. A human readable reason why the trial was infeasible. This should
/// only be provided if `trial_infeasible` is true.
#[prost(string, tag = "4")]
pub infeasible_reason: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.DeleteTrial][google.cloud.aiplatform.v1.VizierService.DeleteTrial].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTrialRequest {
/// Required. The Trial's name.
/// Format:
/// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckTrialEarlyStoppingStateRequest {
/// Required. The Trial's name.
/// Format:
/// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
#[prost(string, tag = "1")]
pub trial_name: ::prost::alloc::string::String,
}
/// Response message for
/// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CheckTrialEarlyStoppingStateResponse {
/// True if the Trial should stop.
#[prost(bool, tag = "1")]
pub should_stop: bool,
}
/// This message will be placed in the metadata field of a
/// google.longrunning.Operation associated with a CheckTrialEarlyStoppingState
/// request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckTrialEarlyStoppingStateMetatdata {
/// Operation metadata for suggesting Trials.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// The name of the Study that the Trial belongs to.
#[prost(string, tag = "2")]
pub study: ::prost::alloc::string::String,
/// The Trial name.
#[prost(string, tag = "3")]
pub trial: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.StopTrial][google.cloud.aiplatform.v1.VizierService.StopTrial].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StopTrialRequest {
/// Required. The Trial's name.
/// Format:
/// `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListOptimalTrialsRequest {
/// Required. The name of the Study that the optimal Trial belongs to.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
}
/// Response message for
/// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListOptimalTrialsResponse {
/// The pareto-optimal Trials for multiple objective Study or the
/// optimal trial for single objective Study. The definition of
/// pareto-optimal can be checked in wiki page.
/// <https://en.wikipedia.org/wiki/Pareto_efficiency>
#[prost(message, repeated, tag = "1")]
pub optimal_trials: ::prost::alloc::vec::Vec<Trial>,
}
/// Generated client implementations.
pub mod vizier_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Vertex AI Vizier API.
///
/// Vertex AI Vizier is a service to solve blackbox optimization problems,
/// such as tuning machine learning hyperparameters and searching over deep
/// learning architectures.
#[derive(Debug, Clone)]
pub struct VizierServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> VizierServiceClient<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,
) -> VizierServiceClient<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,
{
VizierServiceClient::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 Study. A resource name will be generated after creation of the
/// Study.
pub async fn create_study(
&mut self,
request: impl tonic::IntoRequest<super::CreateStudyRequest>,
) -> std::result::Result<tonic::Response<super::Study>, 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.aiplatform.v1.VizierService/CreateStudy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"CreateStudy",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a Study by name.
pub async fn get_study(
&mut self,
request: impl tonic::IntoRequest<super::GetStudyRequest>,
) -> std::result::Result<tonic::Response<super::Study>, 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.aiplatform.v1.VizierService/GetStudy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"GetStudy",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all the studies in a region for an associated project.
pub async fn list_studies(
&mut self,
request: impl tonic::IntoRequest<super::ListStudiesRequest>,
) -> std::result::Result<
tonic::Response<super::ListStudiesResponse>,
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.aiplatform.v1.VizierService/ListStudies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"ListStudies",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a Study.
pub async fn delete_study(
&mut self,
request: impl tonic::IntoRequest<super::DeleteStudyRequest>,
) -> 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.aiplatform.v1.VizierService/DeleteStudy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"DeleteStudy",
),
);
self.inner.unary(req, path, codec).await
}
/// Looks a study up using the user-defined display_name field instead of the
/// fully qualified resource name.
pub async fn lookup_study(
&mut self,
request: impl tonic::IntoRequest<super::LookupStudyRequest>,
) -> std::result::Result<tonic::Response<super::Study>, 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.aiplatform.v1.VizierService/LookupStudy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"LookupStudy",
),
);
self.inner.unary(req, path, codec).await
}
/// Adds one or more Trials to a Study, with parameter values
/// suggested by Vertex AI Vizier. Returns a long-running
/// operation associated with the generation of Trial suggestions.
/// When this long-running operation succeeds, it will contain
/// a
/// [SuggestTrialsResponse][google.cloud.aiplatform.v1.SuggestTrialsResponse].
pub async fn suggest_trials(
&mut self,
request: impl tonic::IntoRequest<super::SuggestTrialsRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.VizierService/SuggestTrials",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"SuggestTrials",
),
);
self.inner.unary(req, path, codec).await
}
/// Adds a user provided Trial to a Study.
pub async fn create_trial(
&mut self,
request: impl tonic::IntoRequest<super::CreateTrialRequest>,
) -> std::result::Result<tonic::Response<super::Trial>, 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.aiplatform.v1.VizierService/CreateTrial",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"CreateTrial",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a Trial.
pub async fn get_trial(
&mut self,
request: impl tonic::IntoRequest<super::GetTrialRequest>,
) -> std::result::Result<tonic::Response<super::Trial>, 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.aiplatform.v1.VizierService/GetTrial",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"GetTrial",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists the Trials associated with a Study.
pub async fn list_trials(
&mut self,
request: impl tonic::IntoRequest<super::ListTrialsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTrialsResponse>,
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.aiplatform.v1.VizierService/ListTrials",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"ListTrials",
),
);
self.inner.unary(req, path, codec).await
}
/// Adds a measurement of the objective metrics to a Trial. This measurement
/// is assumed to have been taken before the Trial is complete.
pub async fn add_trial_measurement(
&mut self,
request: impl tonic::IntoRequest<super::AddTrialMeasurementRequest>,
) -> std::result::Result<tonic::Response<super::Trial>, 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.aiplatform.v1.VizierService/AddTrialMeasurement",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"AddTrialMeasurement",
),
);
self.inner.unary(req, path, codec).await
}
/// Marks a Trial as complete.
pub async fn complete_trial(
&mut self,
request: impl tonic::IntoRequest<super::CompleteTrialRequest>,
) -> std::result::Result<tonic::Response<super::Trial>, 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.aiplatform.v1.VizierService/CompleteTrial",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"CompleteTrial",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a Trial.
pub async fn delete_trial(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTrialRequest>,
) -> 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.aiplatform.v1.VizierService/DeleteTrial",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"DeleteTrial",
),
);
self.inner.unary(req, path, codec).await
}
/// Checks whether a Trial should stop or not. Returns a
/// long-running operation. When the operation is successful,
/// it will contain a
/// [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse].
pub async fn check_trial_early_stopping_state(
&mut self,
request: impl tonic::IntoRequest<super::CheckTrialEarlyStoppingStateRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.VizierService/CheckTrialEarlyStoppingState",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"CheckTrialEarlyStoppingState",
),
);
self.inner.unary(req, path, codec).await
}
/// Stops a Trial.
pub async fn stop_trial(
&mut self,
request: impl tonic::IntoRequest<super::StopTrialRequest>,
) -> std::result::Result<tonic::Response<super::Trial>, 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.aiplatform.v1.VizierService/StopTrial",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"StopTrial",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists the pareto-optimal Trials for multi-objective Study or the
/// optimal Trials for single-objective Study. The definition of
/// pareto-optimal can be checked in wiki page.
/// https://en.wikipedia.org/wiki/Pareto_efficiency
pub async fn list_optimal_trials(
&mut self,
request: impl tonic::IntoRequest<super::ListOptimalTrialsRequest>,
) -> std::result::Result<
tonic::Response<super::ListOptimalTrialsResponse>,
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.aiplatform.v1.VizierService/ListOptimalTrials",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.VizierService",
"ListOptimalTrials",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for
/// [JobService.CreateCustomJob][google.cloud.aiplatform.v1.JobService.CreateCustomJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateCustomJobRequest {
/// Required. The resource name of the Location to create the CustomJob in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The CustomJob to create.
#[prost(message, optional, tag = "2")]
pub custom_job: ::core::option::Option<CustomJob>,
}
/// Request message for
/// [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetCustomJobRequest {
/// Required. The name of the CustomJob resource.
/// Format:
/// `projects/{project}/locations/{location}/customJobs/{custom_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListCustomJobsRequest {
/// Required. The resource name of the Location to list the CustomJobs from.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
///
/// Supported fields:
///
/// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
/// * `state` supports `=`, `!=` comparisons.
/// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
/// `create_time` must be in RFC 3339 format.
/// * `labels` supports general map functions that is:
/// `labels.key=value` - key:value equality
/// `labels.key:* - key existence
///
/// Some examples of using the filter are:
///
/// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
/// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
/// * `NOT display_name="my_job"`
/// * `create_time>"2021-05-18T00:00:00Z"`
/// * `labels.keyA=valueA`
/// * `labels.keyB:*`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token]
/// of the previous
/// [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListCustomJobsResponse {
/// List of CustomJobs in the requested page.
#[prost(message, repeated, tag = "1")]
pub custom_jobs: ::prost::alloc::vec::Vec<CustomJob>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1.ListCustomJobsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.DeleteCustomJob][google.cloud.aiplatform.v1.JobService.DeleteCustomJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteCustomJobRequest {
/// Required. The name of the CustomJob resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/customJobs/{custom_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CancelCustomJob][google.cloud.aiplatform.v1.JobService.CancelCustomJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelCustomJobRequest {
/// Required. The name of the CustomJob to cancel.
/// Format:
/// `projects/{project}/locations/{location}/customJobs/{custom_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDataLabelingJobRequest {
/// Required. The parent of the DataLabelingJob.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The DataLabelingJob to create.
#[prost(message, optional, tag = "2")]
pub data_labeling_job: ::core::option::Option<DataLabelingJob>,
}
/// Request message for
/// [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1.JobService.GetDataLabelingJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetDataLabelingJobRequest {
/// Required. The name of the DataLabelingJob.
/// Format:
/// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDataLabelingJobsRequest {
/// Required. The parent of the DataLabelingJob.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
///
/// Supported fields:
///
/// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
/// * `state` supports `=`, `!=` comparisons.
/// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
/// `create_time` must be in RFC 3339 format.
/// * `labels` supports general map functions that is:
/// `labels.key=value` - key:value equality
/// `labels.key:* - key existence
///
/// Some examples of using the filter are:
///
/// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
/// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
/// * `NOT display_name="my_job"`
/// * `create_time>"2021-05-18T00:00:00Z"`
/// * `labels.keyA=valueA`
/// * `labels.keyB:*`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read. FieldMask represents a set of
/// symbolic field paths. For example, the mask can be `paths: "name"`. The
/// "name" here is a field in DataLabelingJob.
/// If this field is not set, all fields of the DataLabelingJob are returned.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
/// A comma-separated list of fields to order by, sorted in ascending order by
/// default.
/// Use `desc` after a field name for descending.
#[prost(string, tag = "6")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDataLabelingJobsResponse {
/// A list of DataLabelingJobs that matches the specified filter in the
/// request.
#[prost(message, repeated, tag = "1")]
pub data_labeling_jobs: ::prost::alloc::vec::Vec<DataLabelingJob>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDataLabelingJobRequest {
/// Required. The name of the DataLabelingJob to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelDataLabelingJobRequest {
/// Required. The name of the DataLabelingJob.
/// Format:
/// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateHyperparameterTuningJobRequest {
/// Required. The resource name of the Location to create the
/// HyperparameterTuningJob in. Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The HyperparameterTuningJob to create.
#[prost(message, optional, tag = "2")]
pub hyperparameter_tuning_job: ::core::option::Option<HyperparameterTuningJob>,
}
/// Request message for
/// [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetHyperparameterTuningJobRequest {
/// Required. The name of the HyperparameterTuningJob resource.
/// Format:
/// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListHyperparameterTuningJobsRequest {
/// Required. The resource name of the Location to list the
/// HyperparameterTuningJobs from. Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
///
/// Supported fields:
///
/// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
/// * `state` supports `=`, `!=` comparisons.
/// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
/// `create_time` must be in RFC 3339 format.
/// * `labels` supports general map functions that is:
/// `labels.key=value` - key:value equality
/// `labels.key:* - key existence
///
/// Some examples of using the filter are:
///
/// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
/// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
/// * `NOT display_name="my_job"`
/// * `create_time>"2021-05-18T00:00:00Z"`
/// * `labels.keyA=valueA`
/// * `labels.keyB:*`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
/// of the previous
/// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListHyperparameterTuningJobsResponse {
/// List of HyperparameterTuningJobs in the requested page.
/// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]
/// of the jobs will be not be returned.
#[prost(message, repeated, tag = "1")]
pub hyperparameter_tuning_jobs: ::prost::alloc::vec::Vec<HyperparameterTuningJob>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteHyperparameterTuningJobRequest {
/// Required. The name of the HyperparameterTuningJob resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelHyperparameterTuningJobRequest {
/// Required. The name of the HyperparameterTuningJob to cancel.
/// Format:
/// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CreateNasJob][google.cloud.aiplatform.v1.JobService.CreateNasJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateNasJobRequest {
/// Required. The resource name of the Location to create the NasJob in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The NasJob to create.
#[prost(message, optional, tag = "2")]
pub nas_job: ::core::option::Option<NasJob>,
}
/// Request message for
/// [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetNasJobRequest {
/// Required. The name of the NasJob resource.
/// Format:
/// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNasJobsRequest {
/// Required. The resource name of the Location to list the NasJobs
/// from. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
///
/// Supported fields:
///
/// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
/// * `state` supports `=`, `!=` comparisons.
/// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
/// `create_time` must be in RFC 3339 format.
/// * `labels` supports general map functions that is:
/// `labels.key=value` - key:value equality
/// `labels.key:* - key existence
///
/// Some examples of using the filter are:
///
/// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
/// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
/// * `NOT display_name="my_job"`
/// * `create_time>"2021-05-18T00:00:00Z"`
/// * `labels.keyA=valueA`
/// * `labels.keyB:*`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListNasJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token]
/// of the previous
/// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNasJobsResponse {
/// List of NasJobs in the requested page.
/// [NasJob.nas_job_output][google.cloud.aiplatform.v1.NasJob.nas_job_output]
/// of the jobs will not be returned.
#[prost(message, repeated, tag = "1")]
pub nas_jobs: ::prost::alloc::vec::Vec<NasJob>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListNasJobsRequest.page_token][google.cloud.aiplatform.v1.ListNasJobsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.DeleteNasJob][google.cloud.aiplatform.v1.JobService.DeleteNasJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteNasJobRequest {
/// Required. The name of the NasJob resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CancelNasJob][google.cloud.aiplatform.v1.JobService.CancelNasJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelNasJobRequest {
/// Required. The name of the NasJob to cancel.
/// Format:
/// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.GetNasTrialDetail][google.cloud.aiplatform.v1.JobService.GetNasTrialDetail].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetNasTrialDetailRequest {
/// Required. The name of the NasTrialDetail resource.
/// Format:
/// `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNasTrialDetailsRequest {
/// Required. The name of the NasJob resource.
/// Format:
/// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListNasTrialDetailsResponse.next_page_token][google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token]
/// of the previous
/// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails]
/// call.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListNasTrialDetailsResponse {
/// List of top NasTrials in the requested page.
#[prost(message, repeated, tag = "1")]
pub nas_trial_details: ::prost::alloc::vec::Vec<NasTrialDetail>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListNasTrialDetailsRequest.page_token][google.cloud.aiplatform.v1.ListNasTrialDetailsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateBatchPredictionJobRequest {
/// Required. The resource name of the Location to create the
/// BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The BatchPredictionJob to create.
#[prost(message, optional, tag = "2")]
pub batch_prediction_job: ::core::option::Option<BatchPredictionJob>,
}
/// Request message for
/// [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetBatchPredictionJobRequest {
/// Required. The name of the BatchPredictionJob resource.
/// Format:
/// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListBatchPredictionJobsRequest {
/// Required. The resource name of the Location to list the BatchPredictionJobs
/// from. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
///
/// Supported fields:
///
/// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
/// * `model_display_name` supports `=`, `!=` comparisons.
/// * `state` supports `=`, `!=` comparisons.
/// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
/// `create_time` must be in RFC 3339 format.
/// * `labels` supports general map functions that is:
/// `labels.key=value` - key:value equality
/// `labels.key:* - key existence
///
/// Some examples of using the filter are:
///
/// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
/// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
/// * `NOT display_name="my_job"`
/// * `create_time>"2021-05-18T00:00:00Z"`
/// * `labels.keyA=valueA`
/// * `labels.keyB:*`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
/// Typically obtained via
/// [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token]
/// of the previous
/// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListBatchPredictionJobsResponse {
/// List of BatchPredictionJobs in the requested page.
#[prost(message, repeated, tag = "1")]
pub batch_prediction_jobs: ::prost::alloc::vec::Vec<BatchPredictionJob>,
/// A token to retrieve the next page of results.
/// Pass to
/// [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteBatchPredictionJobRequest {
/// Required. The name of the BatchPredictionJob resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CancelBatchPredictionJobRequest {
/// Required. The name of the BatchPredictionJob to cancel.
/// Format:
/// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.CreateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateModelDeploymentMonitoringJobRequest {
/// Required. The parent of the ModelDeploymentMonitoringJob.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ModelDeploymentMonitoringJob to create
#[prost(message, optional, tag = "2")]
pub model_deployment_monitoring_job: ::core::option::Option<
ModelDeploymentMonitoringJob,
>,
}
/// Request message for
/// [JobService.SearchModelDeploymentMonitoringStatsAnomalies][google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchModelDeploymentMonitoringStatsAnomaliesRequest {
/// Required. ModelDeploymentMonitoring Job resource name.
/// Format:
/// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
#[prost(string, tag = "1")]
pub model_deployment_monitoring_job: ::prost::alloc::string::String,
/// Required. The DeployedModel ID of the
/// \[ModelDeploymentMonitoringObjectiveConfig.deployed_model_id\].
#[prost(string, tag = "2")]
pub deployed_model_id: ::prost::alloc::string::String,
/// The feature display name. If specified, only return the stats belonging to
/// this feature. Format:
/// [ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name][google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name],
/// example: "user_destination".
#[prost(string, tag = "3")]
pub feature_display_name: ::prost::alloc::string::String,
/// Required. Objectives of the stats to retrieve.
#[prost(message, repeated, tag = "4")]
pub objectives: ::prost::alloc::vec::Vec<
search_model_deployment_monitoring_stats_anomalies_request::StatsAnomaliesObjective,
>,
/// The standard list page size.
#[prost(int32, tag = "5")]
pub page_size: i32,
/// A page token received from a previous
/// [JobService.SearchModelDeploymentMonitoringStatsAnomalies][google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies]
/// call.
#[prost(string, tag = "6")]
pub page_token: ::prost::alloc::string::String,
/// The earliest timestamp of stats being generated.
/// If not set, indicates fetching stats till the earliest possible one.
#[prost(message, optional, tag = "7")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The latest timestamp of stats being generated.
/// If not set, indicates feching stats till the latest possible one.
#[prost(message, optional, tag = "8")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Nested message and enum types in `SearchModelDeploymentMonitoringStatsAnomaliesRequest`.
pub mod search_model_deployment_monitoring_stats_anomalies_request {
/// Stats requested for specific objective.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct StatsAnomaliesObjective {
#[prost(
enumeration = "super::ModelDeploymentMonitoringObjectiveType",
tag = "1"
)]
pub r#type: i32,
/// If set, all attribution scores between
/// [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time]
/// and
/// [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time]
/// are fetched, and page token doesn't take effect in this case. Only used
/// to retrieve attribution score for the top Features which has the highest
/// attribution score in the latest monitoring run.
#[prost(int32, tag = "4")]
pub top_feature_count: i32,
}
}
/// Response message for
/// [JobService.SearchModelDeploymentMonitoringStatsAnomalies][google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchModelDeploymentMonitoringStatsAnomaliesResponse {
/// Stats retrieved for requested objectives.
/// There are at most 1000
/// [ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats][google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats]
/// in the response.
#[prost(message, repeated, tag = "1")]
pub monitoring_stats: ::prost::alloc::vec::Vec<ModelMonitoringStatsAnomalies>,
/// The page token that can be used by the next
/// [JobService.SearchModelDeploymentMonitoringStatsAnomalies][google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies]
/// call.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.GetModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.GetModelDeploymentMonitoringJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetModelDeploymentMonitoringJobRequest {
/// Required. The resource name of the ModelDeploymentMonitoringJob.
/// Format:
/// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.ListModelDeploymentMonitoringJobs][google.cloud.aiplatform.v1.JobService.ListModelDeploymentMonitoringJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelDeploymentMonitoringJobsRequest {
/// Required. The parent of the ModelDeploymentMonitoringJob.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The standard list filter.
///
/// Supported fields:
///
/// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
/// * `state` supports `=`, `!=` comparisons.
/// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
/// `create_time` must be in RFC 3339 format.
/// * `labels` supports general map functions that is:
/// `labels.key=value` - key:value equality
/// `labels.key:* - key existence
///
/// Some examples of using the filter are:
///
/// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
/// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
/// * `NOT display_name="my_job"`
/// * `create_time>"2021-05-18T00:00:00Z"`
/// * `labels.keyA=valueA`
/// * `labels.keyB:*`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The standard list page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Mask specifying which fields to read
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [JobService.ListModelDeploymentMonitoringJobs][google.cloud.aiplatform.v1.JobService.ListModelDeploymentMonitoringJobs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListModelDeploymentMonitoringJobsResponse {
/// A list of ModelDeploymentMonitoringJobs that matches the specified filter
/// in the request.
#[prost(message, repeated, tag = "1")]
pub model_deployment_monitoring_jobs: ::prost::alloc::vec::Vec<
ModelDeploymentMonitoringJob,
>,
/// The standard List next-page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.UpdateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateModelDeploymentMonitoringJobRequest {
/// Required. The model monitoring configuration which replaces the resource on
/// the server.
#[prost(message, optional, tag = "1")]
pub model_deployment_monitoring_job: ::core::option::Option<
ModelDeploymentMonitoringJob,
>,
/// Required. The update mask is used to specify the fields to be overwritten
/// in the ModelDeploymentMonitoringJob resource by the update. The fields
/// specified in the update_mask are relative to the resource, not the full
/// request. A field will be overwritten if it is in the mask. If the user does
/// not provide a mask then only the non-empty fields present in the request
/// will be overwritten. Set the update_mask to `*` to override all fields. For
/// the objective config, the user can either provide the update mask for
/// model_deployment_monitoring_objective_configs or any combination of its
/// nested fields, such as:
/// model_deployment_monitoring_objective_configs.objective_config.training_dataset.
///
/// Updatable fields:
///
/// * `display_name`
/// * `model_deployment_monitoring_schedule_config`
/// * `model_monitoring_alert_config`
/// * `logging_sampling_strategy`
/// * `labels`
/// * `log_ttl`
/// * `enable_monitoring_pipeline_logs`
/// . and
/// * `model_deployment_monitoring_objective_configs`
/// . or
/// * `model_deployment_monitoring_objective_configs.objective_config.training_dataset`
/// * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config`
/// * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [JobService.DeleteModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.DeleteModelDeploymentMonitoringJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteModelDeploymentMonitoringJobRequest {
/// Required. The resource name of the model monitoring job to delete.
/// Format:
/// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.PauseModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.PauseModelDeploymentMonitoringJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PauseModelDeploymentMonitoringJobRequest {
/// Required. The resource name of the ModelDeploymentMonitoringJob to pause.
/// Format:
/// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [JobService.ResumeModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.ResumeModelDeploymentMonitoringJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResumeModelDeploymentMonitoringJobRequest {
/// Required. The resource name of the ModelDeploymentMonitoringJob to resume.
/// Format:
/// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Runtime operation information for
/// [JobService.UpdateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateModelDeploymentMonitoringJobOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Generated client implementations.
pub mod job_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for creating and managing Vertex AI's jobs.
#[derive(Debug, Clone)]
pub struct JobServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> JobServiceClient<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,
) -> JobServiceClient<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,
{
JobServiceClient::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 CustomJob. A created CustomJob right away
/// will be attempted to be run.
pub async fn create_custom_job(
&mut self,
request: impl tonic::IntoRequest<super::CreateCustomJobRequest>,
) -> std::result::Result<tonic::Response<super::CustomJob>, 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.aiplatform.v1.JobService/CreateCustomJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CreateCustomJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a CustomJob.
pub async fn get_custom_job(
&mut self,
request: impl tonic::IntoRequest<super::GetCustomJobRequest>,
) -> std::result::Result<tonic::Response<super::CustomJob>, 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.aiplatform.v1.JobService/GetCustomJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"GetCustomJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists CustomJobs in a Location.
pub async fn list_custom_jobs(
&mut self,
request: impl tonic::IntoRequest<super::ListCustomJobsRequest>,
) -> std::result::Result<
tonic::Response<super::ListCustomJobsResponse>,
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.aiplatform.v1.JobService/ListCustomJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"ListCustomJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a CustomJob.
pub async fn delete_custom_job(
&mut self,
request: impl tonic::IntoRequest<super::DeleteCustomJobRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.JobService/DeleteCustomJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"DeleteCustomJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels a CustomJob.
/// Starts asynchronous cancellation on the CustomJob. The server
/// makes a best effort to cancel the job, but success is not
/// guaranteed. Clients can use
/// [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob]
/// or other methods to check whether the cancellation succeeded or whether the
/// job completed despite cancellation. On successful cancellation,
/// the CustomJob is not deleted; instead it becomes a job with
/// a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with
/// a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
/// `Code.CANCELLED`, and
/// [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to
/// `CANCELLED`.
pub async fn cancel_custom_job(
&mut self,
request: impl tonic::IntoRequest<super::CancelCustomJobRequest>,
) -> 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.aiplatform.v1.JobService/CancelCustomJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CancelCustomJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a DataLabelingJob.
pub async fn create_data_labeling_job(
&mut self,
request: impl tonic::IntoRequest<super::CreateDataLabelingJobRequest>,
) -> std::result::Result<
tonic::Response<super::DataLabelingJob>,
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.aiplatform.v1.JobService/CreateDataLabelingJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CreateDataLabelingJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a DataLabelingJob.
pub async fn get_data_labeling_job(
&mut self,
request: impl tonic::IntoRequest<super::GetDataLabelingJobRequest>,
) -> std::result::Result<
tonic::Response<super::DataLabelingJob>,
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.aiplatform.v1.JobService/GetDataLabelingJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"GetDataLabelingJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists DataLabelingJobs in a Location.
pub async fn list_data_labeling_jobs(
&mut self,
request: impl tonic::IntoRequest<super::ListDataLabelingJobsRequest>,
) -> std::result::Result<
tonic::Response<super::ListDataLabelingJobsResponse>,
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.aiplatform.v1.JobService/ListDataLabelingJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"ListDataLabelingJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a DataLabelingJob.
pub async fn delete_data_labeling_job(
&mut self,
request: impl tonic::IntoRequest<super::DeleteDataLabelingJobRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.JobService/DeleteDataLabelingJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"DeleteDataLabelingJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
pub async fn cancel_data_labeling_job(
&mut self,
request: impl tonic::IntoRequest<super::CancelDataLabelingJobRequest>,
) -> 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.aiplatform.v1.JobService/CancelDataLabelingJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CancelDataLabelingJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a HyperparameterTuningJob
pub async fn create_hyperparameter_tuning_job(
&mut self,
request: impl tonic::IntoRequest<super::CreateHyperparameterTuningJobRequest>,
) -> std::result::Result<
tonic::Response<super::HyperparameterTuningJob>,
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.aiplatform.v1.JobService/CreateHyperparameterTuningJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CreateHyperparameterTuningJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a HyperparameterTuningJob
pub async fn get_hyperparameter_tuning_job(
&mut self,
request: impl tonic::IntoRequest<super::GetHyperparameterTuningJobRequest>,
) -> std::result::Result<
tonic::Response<super::HyperparameterTuningJob>,
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.aiplatform.v1.JobService/GetHyperparameterTuningJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"GetHyperparameterTuningJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists HyperparameterTuningJobs in a Location.
pub async fn list_hyperparameter_tuning_jobs(
&mut self,
request: impl tonic::IntoRequest<super::ListHyperparameterTuningJobsRequest>,
) -> std::result::Result<
tonic::Response<super::ListHyperparameterTuningJobsResponse>,
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.aiplatform.v1.JobService/ListHyperparameterTuningJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"ListHyperparameterTuningJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a HyperparameterTuningJob.
pub async fn delete_hyperparameter_tuning_job(
&mut self,
request: impl tonic::IntoRequest<super::DeleteHyperparameterTuningJobRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.JobService/DeleteHyperparameterTuningJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"DeleteHyperparameterTuningJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels a HyperparameterTuningJob.
/// Starts asynchronous cancellation on the HyperparameterTuningJob. The server
/// makes a best effort to cancel the job, but success is not
/// guaranteed. Clients can use
/// [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob]
/// or other methods to check whether the cancellation succeeded or whether the
/// job completed despite cancellation. On successful cancellation,
/// the HyperparameterTuningJob is not deleted; instead it becomes a job with
/// a
/// [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error]
/// value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
/// corresponding to `Code.CANCELLED`, and
/// [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state]
/// is set to `CANCELLED`.
pub async fn cancel_hyperparameter_tuning_job(
&mut self,
request: impl tonic::IntoRequest<super::CancelHyperparameterTuningJobRequest>,
) -> 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.aiplatform.v1.JobService/CancelHyperparameterTuningJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CancelHyperparameterTuningJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a NasJob
pub async fn create_nas_job(
&mut self,
request: impl tonic::IntoRequest<super::CreateNasJobRequest>,
) -> std::result::Result<tonic::Response<super::NasJob>, 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.aiplatform.v1.JobService/CreateNasJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CreateNasJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a NasJob
pub async fn get_nas_job(
&mut self,
request: impl tonic::IntoRequest<super::GetNasJobRequest>,
) -> std::result::Result<tonic::Response<super::NasJob>, 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.aiplatform.v1.JobService/GetNasJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.aiplatform.v1.JobService", "GetNasJob"),
);
self.inner.unary(req, path, codec).await
}
/// Lists NasJobs in a Location.
pub async fn list_nas_jobs(
&mut self,
request: impl tonic::IntoRequest<super::ListNasJobsRequest>,
) -> std::result::Result<
tonic::Response<super::ListNasJobsResponse>,
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.aiplatform.v1.JobService/ListNasJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"ListNasJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a NasJob.
pub async fn delete_nas_job(
&mut self,
request: impl tonic::IntoRequest<super::DeleteNasJobRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.JobService/DeleteNasJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"DeleteNasJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels a NasJob.
/// Starts asynchronous cancellation on the NasJob. The server
/// makes a best effort to cancel the job, but success is not
/// guaranteed. Clients can use
/// [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or
/// other methods to check whether the cancellation succeeded or whether the
/// job completed despite cancellation. On successful cancellation,
/// the NasJob is not deleted; instead it becomes a job with
/// a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a
/// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
/// `Code.CANCELLED`, and
/// [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to
/// `CANCELLED`.
pub async fn cancel_nas_job(
&mut self,
request: impl tonic::IntoRequest<super::CancelNasJobRequest>,
) -> 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.aiplatform.v1.JobService/CancelNasJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CancelNasJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a NasTrialDetail.
pub async fn get_nas_trial_detail(
&mut self,
request: impl tonic::IntoRequest<super::GetNasTrialDetailRequest>,
) -> std::result::Result<tonic::Response<super::NasTrialDetail>, 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.aiplatform.v1.JobService/GetNasTrialDetail",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"GetNasTrialDetail",
),
);
self.inner.unary(req, path, codec).await
}
/// List top NasTrialDetails of a NasJob.
pub async fn list_nas_trial_details(
&mut self,
request: impl tonic::IntoRequest<super::ListNasTrialDetailsRequest>,
) -> std::result::Result<
tonic::Response<super::ListNasTrialDetailsResponse>,
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.aiplatform.v1.JobService/ListNasTrialDetails",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"ListNasTrialDetails",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a BatchPredictionJob. A BatchPredictionJob once created will
/// right away be attempted to start.
pub async fn create_batch_prediction_job(
&mut self,
request: impl tonic::IntoRequest<super::CreateBatchPredictionJobRequest>,
) -> std::result::Result<
tonic::Response<super::BatchPredictionJob>,
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.aiplatform.v1.JobService/CreateBatchPredictionJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CreateBatchPredictionJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a BatchPredictionJob
pub async fn get_batch_prediction_job(
&mut self,
request: impl tonic::IntoRequest<super::GetBatchPredictionJobRequest>,
) -> std::result::Result<
tonic::Response<super::BatchPredictionJob>,
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.aiplatform.v1.JobService/GetBatchPredictionJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"GetBatchPredictionJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists BatchPredictionJobs in a Location.
pub async fn list_batch_prediction_jobs(
&mut self,
request: impl tonic::IntoRequest<super::ListBatchPredictionJobsRequest>,
) -> std::result::Result<
tonic::Response<super::ListBatchPredictionJobsResponse>,
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.aiplatform.v1.JobService/ListBatchPredictionJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"ListBatchPredictionJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a BatchPredictionJob. Can only be called on jobs that already
/// finished.
pub async fn delete_batch_prediction_job(
&mut self,
request: impl tonic::IntoRequest<super::DeleteBatchPredictionJobRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.JobService/DeleteBatchPredictionJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"DeleteBatchPredictionJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels a BatchPredictionJob.
///
/// Starts asynchronous cancellation on the BatchPredictionJob. The server
/// makes the best effort to cancel the job, but success is not
/// guaranteed. Clients can use
/// [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob]
/// or other methods to check whether the cancellation succeeded or whether the
/// job completed despite cancellation. On a successful cancellation,
/// the BatchPredictionJob is not deleted;instead its
/// [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state]
/// is set to `CANCELLED`. Any files already outputted by the job are not
/// deleted.
pub async fn cancel_batch_prediction_job(
&mut self,
request: impl tonic::IntoRequest<super::CancelBatchPredictionJobRequest>,
) -> 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.aiplatform.v1.JobService/CancelBatchPredictionJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CancelBatchPredictionJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a ModelDeploymentMonitoringJob. It will run periodically on a
/// configured interval.
pub async fn create_model_deployment_monitoring_job(
&mut self,
request: impl tonic::IntoRequest<
super::CreateModelDeploymentMonitoringJobRequest,
>,
) -> std::result::Result<
tonic::Response<super::ModelDeploymentMonitoringJob>,
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.aiplatform.v1.JobService/CreateModelDeploymentMonitoringJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"CreateModelDeploymentMonitoringJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Searches Model Monitoring Statistics generated within a given time window.
pub async fn search_model_deployment_monitoring_stats_anomalies(
&mut self,
request: impl tonic::IntoRequest<
super::SearchModelDeploymentMonitoringStatsAnomaliesRequest,
>,
) -> std::result::Result<
tonic::Response<
super::SearchModelDeploymentMonitoringStatsAnomaliesResponse,
>,
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.aiplatform.v1.JobService/SearchModelDeploymentMonitoringStatsAnomalies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"SearchModelDeploymentMonitoringStatsAnomalies",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a ModelDeploymentMonitoringJob.
pub async fn get_model_deployment_monitoring_job(
&mut self,
request: impl tonic::IntoRequest<
super::GetModelDeploymentMonitoringJobRequest,
>,
) -> std::result::Result<
tonic::Response<super::ModelDeploymentMonitoringJob>,
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.aiplatform.v1.JobService/GetModelDeploymentMonitoringJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"GetModelDeploymentMonitoringJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists ModelDeploymentMonitoringJobs in a Location.
pub async fn list_model_deployment_monitoring_jobs(
&mut self,
request: impl tonic::IntoRequest<
super::ListModelDeploymentMonitoringJobsRequest,
>,
) -> std::result::Result<
tonic::Response<super::ListModelDeploymentMonitoringJobsResponse>,
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.aiplatform.v1.JobService/ListModelDeploymentMonitoringJobs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"ListModelDeploymentMonitoringJobs",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a ModelDeploymentMonitoringJob.
pub async fn update_model_deployment_monitoring_job(
&mut self,
request: impl tonic::IntoRequest<
super::UpdateModelDeploymentMonitoringJobRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.JobService/UpdateModelDeploymentMonitoringJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"UpdateModelDeploymentMonitoringJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a ModelDeploymentMonitoringJob.
pub async fn delete_model_deployment_monitoring_job(
&mut self,
request: impl tonic::IntoRequest<
super::DeleteModelDeploymentMonitoringJobRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.JobService/DeleteModelDeploymentMonitoringJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"DeleteModelDeploymentMonitoringJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Pauses a ModelDeploymentMonitoringJob. If the job is running, the server
/// makes a best effort to cancel the job. Will mark
/// [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state]
/// to 'PAUSED'.
pub async fn pause_model_deployment_monitoring_job(
&mut self,
request: impl tonic::IntoRequest<
super::PauseModelDeploymentMonitoringJobRequest,
>,
) -> 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.aiplatform.v1.JobService/PauseModelDeploymentMonitoringJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"PauseModelDeploymentMonitoringJob",
),
);
self.inner.unary(req, path, codec).await
}
/// Resumes a paused ModelDeploymentMonitoringJob. It will start to run from
/// next scheduled time. A deleted ModelDeploymentMonitoringJob can't be
/// resumed.
pub async fn resume_model_deployment_monitoring_job(
&mut self,
request: impl tonic::IntoRequest<
super::ResumeModelDeploymentMonitoringJobRequest,
>,
) -> 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.aiplatform.v1.JobService/ResumeModelDeploymentMonitoringJob",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.JobService",
"ResumeModelDeploymentMonitoringJob",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for
/// [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTensorboardRequest {
/// Required. The resource name of the Location to create the Tensorboard in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Tensorboard to create.
#[prost(message, optional, tag = "2")]
pub tensorboard: ::core::option::Option<Tensorboard>,
}
/// Request message for
/// [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1.TensorboardService.GetTensorboard].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTensorboardRequest {
/// Required. The name of the Tensorboard resource.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTensorboardsRequest {
/// Required. The resource name of the Location to list Tensorboards.
/// Format:
/// `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the Tensorboards that match the filter expression.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of Tensorboards to return. The service may return
/// fewer than this value. If unspecified, at most 100 Tensorboards are
/// returned. The maximum value is 100; values above 100 are coerced to
/// 100.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Field to use to sort the list.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "6")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTensorboardsResponse {
/// The Tensorboards mathching the request.
#[prost(message, repeated, tag = "1")]
pub tensorboards: ::prost::alloc::vec::Vec<Tensorboard>,
/// A token, which can be sent as
/// [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardsRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTensorboardRequest {
/// Required. Field mask is used to specify the fields to be overwritten in the
/// Tensorboard resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field is overwritten if it's in the mask. If the
/// user does not provide a mask then all fields are overwritten if new
/// values are specified.
#[prost(message, optional, tag = "1")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Required. The Tensorboard's `name` field is used to identify the
/// Tensorboard to be updated. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(message, optional, tag = "2")]
pub tensorboard: ::core::option::Option<Tensorboard>,
}
/// Request message for
/// [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTensorboardRequest {
/// Required. The name of the Tensorboard to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadTensorboardUsageRequest {
/// Required. The name of the Tensorboard resource.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(string, tag = "1")]
pub tensorboard: ::prost::alloc::string::String,
}
/// Response message for
/// [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadTensorboardUsageResponse {
/// Maps year-month (YYYYMM) string to per month usage data.
#[prost(btree_map = "string, message", tag = "1")]
pub monthly_usage_data: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
read_tensorboard_usage_response::PerMonthUsageData,
>,
}
/// Nested message and enum types in `ReadTensorboardUsageResponse`.
pub mod read_tensorboard_usage_response {
/// Per user usage data.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PerUserUsageData {
/// User's username
#[prost(string, tag = "1")]
pub username: ::prost::alloc::string::String,
/// Number of times the user has read data within the Tensorboard.
#[prost(int64, tag = "2")]
pub view_count: i64,
}
/// Per month usage data
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PerMonthUsageData {
/// Usage data for each user in the given month.
#[prost(message, repeated, tag = "1")]
pub user_usage_data: ::prost::alloc::vec::Vec<PerUserUsageData>,
}
}
/// Request message for
/// [TensorboardService.ReadTensorboardSize][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardSize].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadTensorboardSizeRequest {
/// Required. The name of the Tensorboard resource.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(string, tag = "1")]
pub tensorboard: ::prost::alloc::string::String,
}
/// Response message for
/// [TensorboardService.ReadTensorboardSize][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardSize].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ReadTensorboardSizeResponse {
/// Payload storage size for the TensorBoard
#[prost(int64, tag = "1")]
pub storage_size_byte: i64,
}
/// Request message for
/// [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTensorboardExperimentRequest {
/// Required. The resource name of the Tensorboard to create the
/// TensorboardExperiment in. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The TensorboardExperiment to create.
#[prost(message, optional, tag = "2")]
pub tensorboard_experiment: ::core::option::Option<TensorboardExperiment>,
/// Required. The ID to use for the Tensorboard experiment, which becomes the
/// final component of the Tensorboard experiment's resource name.
///
/// This value should be 1-128 characters, and valid characters
/// are `/[a-z][0-9]-/`.
#[prost(string, tag = "3")]
pub tensorboard_experiment_id: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTensorboardExperimentRequest {
/// Required. The name of the TensorboardExperiment resource.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTensorboardExperimentsRequest {
/// Required. The resource name of the Tensorboard to list
/// TensorboardExperiments. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the TensorboardExperiments that match the filter expression.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of TensorboardExperiments to return. The service may
/// return fewer than this value. If unspecified, at most 50
/// TensorboardExperiments are returned. The maximum value is 1000; values
/// above 1000 are coerced to 1000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Field to use to sort the list.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "6")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTensorboardExperimentsResponse {
/// The TensorboardExperiments mathching the request.
#[prost(message, repeated, tag = "1")]
pub tensorboard_experiments: ::prost::alloc::vec::Vec<TensorboardExperiment>,
/// A token, which can be sent as
/// [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTensorboardExperimentRequest {
/// Required. Field mask is used to specify the fields to be overwritten in the
/// TensorboardExperiment resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field is overwritten if it's in the mask. If the
/// user does not provide a mask then all fields are overwritten if new
/// values are specified.
#[prost(message, optional, tag = "1")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Required. The TensorboardExperiment's `name` field is used to identify the
/// TensorboardExperiment to be updated. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
#[prost(message, optional, tag = "2")]
pub tensorboard_experiment: ::core::option::Option<TensorboardExperiment>,
}
/// Request message for
/// [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTensorboardExperimentRequest {
/// Required. The name of the TensorboardExperiment to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateTensorboardRunsRequest {
/// Required. The resource name of the TensorboardExperiment to create the
/// TensorboardRuns in. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
/// The parent field in the CreateTensorboardRunRequest messages must match
/// this field.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The request message specifying the TensorboardRuns to create.
/// A maximum of 1000 TensorboardRuns can be created in a batch.
#[prost(message, repeated, tag = "2")]
pub requests: ::prost::alloc::vec::Vec<CreateTensorboardRunRequest>,
}
/// Response message for
/// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateTensorboardRunsResponse {
/// The created TensorboardRuns.
#[prost(message, repeated, tag = "1")]
pub tensorboard_runs: ::prost::alloc::vec::Vec<TensorboardRun>,
}
/// Request message for
/// [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTensorboardRunRequest {
/// Required. The resource name of the TensorboardExperiment to create the
/// TensorboardRun in. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The TensorboardRun to create.
#[prost(message, optional, tag = "2")]
pub tensorboard_run: ::core::option::Option<TensorboardRun>,
/// Required. The ID to use for the Tensorboard run, which becomes the final
/// component of the Tensorboard run's resource name.
///
/// This value should be 1-128 characters, and valid characters
/// are `/[a-z][0-9]-/`.
#[prost(string, tag = "3")]
pub tensorboard_run_id: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTensorboardRunRequest {
/// Required. The name of the TensorboardRun resource.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadTensorboardBlobDataRequest {
/// Required. The resource name of the TensorboardTimeSeries to list Blobs.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
#[prost(string, tag = "1")]
pub time_series: ::prost::alloc::string::String,
/// IDs of the blobs to read.
#[prost(string, repeated, tag = "2")]
pub blob_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for
/// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadTensorboardBlobDataResponse {
/// Blob messages containing blob bytes.
#[prost(message, repeated, tag = "1")]
pub blobs: ::prost::alloc::vec::Vec<TensorboardBlob>,
}
/// Request message for
/// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTensorboardRunsRequest {
/// Required. The resource name of the TensorboardExperiment to list
/// TensorboardRuns. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the TensorboardRuns that match the filter expression.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of TensorboardRuns to return. The service may return
/// fewer than this value. If unspecified, at most 50 TensorboardRuns are
/// returned. The maximum value is 1000; values above 1000 are coerced to
/// 1000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Field to use to sort the list.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "6")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTensorboardRunsResponse {
/// The TensorboardRuns mathching the request.
#[prost(message, repeated, tag = "1")]
pub tensorboard_runs: ::prost::alloc::vec::Vec<TensorboardRun>,
/// A token, which can be sent as
/// [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardRunsRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTensorboardRunRequest {
/// Required. Field mask is used to specify the fields to be overwritten in the
/// TensorboardRun resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field is overwritten if it's in the mask. If the
/// user does not provide a mask then all fields are overwritten if new
/// values are specified.
#[prost(message, optional, tag = "1")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Required. The TensorboardRun's `name` field is used to identify the
/// TensorboardRun to be updated. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
#[prost(message, optional, tag = "2")]
pub tensorboard_run: ::core::option::Option<TensorboardRun>,
}
/// Request message for
/// [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTensorboardRunRequest {
/// Required. The name of the TensorboardRun to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateTensorboardTimeSeriesRequest {
/// Required. The resource name of the TensorboardExperiment to create the
/// TensorboardTimeSeries in.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
/// The TensorboardRuns referenced by the parent fields in the
/// CreateTensorboardTimeSeriesRequest messages must be sub resources of this
/// TensorboardExperiment.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The request message specifying the TensorboardTimeSeries to
/// create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.
#[prost(message, repeated, tag = "2")]
pub requests: ::prost::alloc::vec::Vec<CreateTensorboardTimeSeriesRequest>,
}
/// Response message for
/// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateTensorboardTimeSeriesResponse {
/// The created TensorboardTimeSeries.
#[prost(message, repeated, tag = "1")]
pub tensorboard_time_series: ::prost::alloc::vec::Vec<TensorboardTimeSeries>,
}
/// Request message for
/// [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTensorboardTimeSeriesRequest {
/// Required. The resource name of the TensorboardRun to create the
/// TensorboardTimeSeries in.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The user specified unique ID to use for the
/// TensorboardTimeSeries, which becomes the final component of the
/// TensorboardTimeSeries's resource name. This value should match
/// "[a-z0-9][a-z0-9-]{0, 127}"
#[prost(string, tag = "3")]
pub tensorboard_time_series_id: ::prost::alloc::string::String,
/// Required. The TensorboardTimeSeries to create.
#[prost(message, optional, tag = "2")]
pub tensorboard_time_series: ::core::option::Option<TensorboardTimeSeries>,
}
/// Request message for
/// [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTensorboardTimeSeriesRequest {
/// Required. The name of the TensorboardTimeSeries resource.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTensorboardTimeSeriesRequest {
/// Required. The resource name of the TensorboardRun to list
/// TensorboardTimeSeries. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Lists the TensorboardTimeSeries that match the filter expression.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of TensorboardTimeSeries to return. The service may
/// return fewer than this value. If unspecified, at most 50
/// TensorboardTimeSeries are returned. The maximum value is 1000; values
/// above 1000 are coerced to 1000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Field to use to sort the list.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
/// Mask specifying which fields to read.
#[prost(message, optional, tag = "6")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTensorboardTimeSeriesResponse {
/// The TensorboardTimeSeries mathching the request.
#[prost(message, repeated, tag = "1")]
pub tensorboard_time_series: ::prost::alloc::vec::Vec<TensorboardTimeSeries>,
/// A token, which can be sent as
/// [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardTimeSeriesRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTensorboardTimeSeriesRequest {
/// Required. Field mask is used to specify the fields to be overwritten in the
/// TensorboardTimeSeries resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field is overwritten if it's in the mask. If the
/// user does not provide a mask then all fields are overwritten if new
/// values are specified.
#[prost(message, optional, tag = "1")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Required. The TensorboardTimeSeries' `name` field is used to identify the
/// TensorboardTimeSeries to be updated.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
#[prost(message, optional, tag = "2")]
pub tensorboard_time_series: ::core::option::Option<TensorboardTimeSeries>,
}
/// Request message for
/// [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTensorboardTimeSeriesRequest {
/// Required. The name of the TensorboardTimeSeries to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchReadTensorboardTimeSeriesDataRequest {
/// Required. The resource name of the Tensorboard containing
/// TensorboardTimeSeries to read data from. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
/// The TensorboardTimeSeries referenced by
/// [time_series][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series]
/// must be sub resources of this Tensorboard.
#[prost(string, tag = "1")]
pub tensorboard: ::prost::alloc::string::String,
/// Required. The resource names of the TensorboardTimeSeries to read data
/// from. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
#[prost(string, repeated, tag = "2")]
pub time_series: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for
/// [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchReadTensorboardTimeSeriesDataResponse {
/// The returned time series data.
#[prost(message, repeated, tag = "1")]
pub time_series_data: ::prost::alloc::vec::Vec<TimeSeriesData>,
}
/// Request message for
/// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadTensorboardTimeSeriesDataRequest {
/// Required. The resource name of the TensorboardTimeSeries to read data from.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
#[prost(string, tag = "1")]
pub tensorboard_time_series: ::prost::alloc::string::String,
/// The maximum number of TensorboardTimeSeries' data to return.
///
/// This value should be a positive integer.
/// This value can be set to -1 to return all data.
#[prost(int32, tag = "2")]
pub max_data_points: i32,
/// Reads the TensorboardTimeSeries' data that match the filter expression.
#[prost(string, tag = "3")]
pub filter: ::prost::alloc::string::String,
}
/// Response message for
/// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadTensorboardTimeSeriesDataResponse {
/// The returned time series data.
#[prost(message, optional, tag = "1")]
pub time_series_data: ::core::option::Option<TimeSeriesData>,
}
/// Request message for
/// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WriteTensorboardExperimentDataRequest {
/// Required. The resource name of the TensorboardExperiment to write data to.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
#[prost(string, tag = "1")]
pub tensorboard_experiment: ::prost::alloc::string::String,
/// Required. Requests containing per-run TensorboardTimeSeries data to write.
#[prost(message, repeated, tag = "2")]
pub write_run_data_requests: ::prost::alloc::vec::Vec<
WriteTensorboardRunDataRequest,
>,
}
/// Response message for
/// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct WriteTensorboardExperimentDataResponse {}
/// Request message for
/// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WriteTensorboardRunDataRequest {
/// Required. The resource name of the TensorboardRun to write data to.
/// Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
#[prost(string, tag = "1")]
pub tensorboard_run: ::prost::alloc::string::String,
/// Required. The TensorboardTimeSeries data to write.
/// Values with in a time series are indexed by their step value.
/// Repeated writes to the same step will overwrite the existing value for that
/// step.
/// The upper limit of data points per write request is 5000.
#[prost(message, repeated, tag = "2")]
pub time_series_data: ::prost::alloc::vec::Vec<TimeSeriesData>,
}
/// Response message for
/// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct WriteTensorboardRunDataResponse {}
/// Request message for
/// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportTensorboardTimeSeriesDataRequest {
/// Required. The resource name of the TensorboardTimeSeries to export data
/// from. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
#[prost(string, tag = "1")]
pub tensorboard_time_series: ::prost::alloc::string::String,
/// Exports the TensorboardTimeSeries' data that match the filter expression.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The maximum number of data points to return per page.
/// The default page_size is 1000. Values must be between 1 and 10000.
/// Values above 10000 are coerced to 10000.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, received from a previous
/// [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
/// call. Provide this to retrieve the subsequent page.
///
/// When paginating, all other parameters provided to
/// [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
/// must match the call that provided the page token.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Field to use to sort the TensorboardTimeSeries' data.
/// By default, TensorboardTimeSeries' data is returned in a pseudo random
/// order.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for
/// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportTensorboardTimeSeriesDataResponse {
/// The returned time series data points.
#[prost(message, repeated, tag = "1")]
pub time_series_data_points: ::prost::alloc::vec::Vec<TimeSeriesDataPoint>,
/// A token, which can be sent as
/// [page_token][google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataRequest.page_token]
/// to retrieve the next page. If this field is omitted, there are no
/// subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Details of operations that perform create Tensorboard.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTensorboardOperationMetadata {
/// Operation metadata for Tensorboard.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Details of operations that perform update Tensorboard.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTensorboardOperationMetadata {
/// Operation metadata for Tensorboard.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Generated client implementations.
pub mod tensorboard_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// TensorboardService
#[derive(Debug, Clone)]
pub struct TensorboardServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> TensorboardServiceClient<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,
) -> TensorboardServiceClient<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,
{
TensorboardServiceClient::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 Tensorboard.
pub async fn create_tensorboard(
&mut self,
request: impl tonic::IntoRequest<super::CreateTensorboardRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.TensorboardService/CreateTensorboard",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"CreateTensorboard",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a Tensorboard.
pub async fn get_tensorboard(
&mut self,
request: impl tonic::IntoRequest<super::GetTensorboardRequest>,
) -> std::result::Result<tonic::Response<super::Tensorboard>, 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.aiplatform.v1.TensorboardService/GetTensorboard",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"GetTensorboard",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a Tensorboard.
pub async fn update_tensorboard(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTensorboardRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.TensorboardService/UpdateTensorboard",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"UpdateTensorboard",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Tensorboards in a Location.
pub async fn list_tensorboards(
&mut self,
request: impl tonic::IntoRequest<super::ListTensorboardsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTensorboardsResponse>,
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.aiplatform.v1.TensorboardService/ListTensorboards",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ListTensorboards",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a Tensorboard.
pub async fn delete_tensorboard(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTensorboardRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.TensorboardService/DeleteTensorboard",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"DeleteTensorboard",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns a list of monthly active users for a given TensorBoard instance.
pub async fn read_tensorboard_usage(
&mut self,
request: impl tonic::IntoRequest<super::ReadTensorboardUsageRequest>,
) -> std::result::Result<
tonic::Response<super::ReadTensorboardUsageResponse>,
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.aiplatform.v1.TensorboardService/ReadTensorboardUsage",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ReadTensorboardUsage",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns the storage size for a given TensorBoard instance.
pub async fn read_tensorboard_size(
&mut self,
request: impl tonic::IntoRequest<super::ReadTensorboardSizeRequest>,
) -> std::result::Result<
tonic::Response<super::ReadTensorboardSizeResponse>,
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.aiplatform.v1.TensorboardService/ReadTensorboardSize",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ReadTensorboardSize",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a TensorboardExperiment.
pub async fn create_tensorboard_experiment(
&mut self,
request: impl tonic::IntoRequest<super::CreateTensorboardExperimentRequest>,
) -> std::result::Result<
tonic::Response<super::TensorboardExperiment>,
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.aiplatform.v1.TensorboardService/CreateTensorboardExperiment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"CreateTensorboardExperiment",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a TensorboardExperiment.
pub async fn get_tensorboard_experiment(
&mut self,
request: impl tonic::IntoRequest<super::GetTensorboardExperimentRequest>,
) -> std::result::Result<
tonic::Response<super::TensorboardExperiment>,
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.aiplatform.v1.TensorboardService/GetTensorboardExperiment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"GetTensorboardExperiment",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a TensorboardExperiment.
pub async fn update_tensorboard_experiment(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTensorboardExperimentRequest>,
) -> std::result::Result<
tonic::Response<super::TensorboardExperiment>,
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.aiplatform.v1.TensorboardService/UpdateTensorboardExperiment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"UpdateTensorboardExperiment",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists TensorboardExperiments in a Location.
pub async fn list_tensorboard_experiments(
&mut self,
request: impl tonic::IntoRequest<super::ListTensorboardExperimentsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTensorboardExperimentsResponse>,
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.aiplatform.v1.TensorboardService/ListTensorboardExperiments",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ListTensorboardExperiments",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a TensorboardExperiment.
pub async fn delete_tensorboard_experiment(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTensorboardExperimentRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.TensorboardService/DeleteTensorboardExperiment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"DeleteTensorboardExperiment",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a TensorboardRun.
pub async fn create_tensorboard_run(
&mut self,
request: impl tonic::IntoRequest<super::CreateTensorboardRunRequest>,
) -> std::result::Result<tonic::Response<super::TensorboardRun>, 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.aiplatform.v1.TensorboardService/CreateTensorboardRun",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"CreateTensorboardRun",
),
);
self.inner.unary(req, path, codec).await
}
/// Batch create TensorboardRuns.
pub async fn batch_create_tensorboard_runs(
&mut self,
request: impl tonic::IntoRequest<super::BatchCreateTensorboardRunsRequest>,
) -> std::result::Result<
tonic::Response<super::BatchCreateTensorboardRunsResponse>,
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.aiplatform.v1.TensorboardService/BatchCreateTensorboardRuns",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"BatchCreateTensorboardRuns",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a TensorboardRun.
pub async fn get_tensorboard_run(
&mut self,
request: impl tonic::IntoRequest<super::GetTensorboardRunRequest>,
) -> std::result::Result<tonic::Response<super::TensorboardRun>, 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.aiplatform.v1.TensorboardService/GetTensorboardRun",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"GetTensorboardRun",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a TensorboardRun.
pub async fn update_tensorboard_run(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTensorboardRunRequest>,
) -> std::result::Result<tonic::Response<super::TensorboardRun>, 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.aiplatform.v1.TensorboardService/UpdateTensorboardRun",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"UpdateTensorboardRun",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists TensorboardRuns in a Location.
pub async fn list_tensorboard_runs(
&mut self,
request: impl tonic::IntoRequest<super::ListTensorboardRunsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTensorboardRunsResponse>,
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.aiplatform.v1.TensorboardService/ListTensorboardRuns",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ListTensorboardRuns",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a TensorboardRun.
pub async fn delete_tensorboard_run(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTensorboardRunRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.TensorboardService/DeleteTensorboardRun",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"DeleteTensorboardRun",
),
);
self.inner.unary(req, path, codec).await
}
/// Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
pub async fn batch_create_tensorboard_time_series(
&mut self,
request: impl tonic::IntoRequest<
super::BatchCreateTensorboardTimeSeriesRequest,
>,
) -> std::result::Result<
tonic::Response<super::BatchCreateTensorboardTimeSeriesResponse>,
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.aiplatform.v1.TensorboardService/BatchCreateTensorboardTimeSeries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"BatchCreateTensorboardTimeSeries",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a TensorboardTimeSeries.
pub async fn create_tensorboard_time_series(
&mut self,
request: impl tonic::IntoRequest<super::CreateTensorboardTimeSeriesRequest>,
) -> std::result::Result<
tonic::Response<super::TensorboardTimeSeries>,
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.aiplatform.v1.TensorboardService/CreateTensorboardTimeSeries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"CreateTensorboardTimeSeries",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a TensorboardTimeSeries.
pub async fn get_tensorboard_time_series(
&mut self,
request: impl tonic::IntoRequest<super::GetTensorboardTimeSeriesRequest>,
) -> std::result::Result<
tonic::Response<super::TensorboardTimeSeries>,
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.aiplatform.v1.TensorboardService/GetTensorboardTimeSeries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"GetTensorboardTimeSeries",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a TensorboardTimeSeries.
pub async fn update_tensorboard_time_series(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTensorboardTimeSeriesRequest>,
) -> std::result::Result<
tonic::Response<super::TensorboardTimeSeries>,
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.aiplatform.v1.TensorboardService/UpdateTensorboardTimeSeries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"UpdateTensorboardTimeSeries",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists TensorboardTimeSeries in a Location.
pub async fn list_tensorboard_time_series(
&mut self,
request: impl tonic::IntoRequest<super::ListTensorboardTimeSeriesRequest>,
) -> std::result::Result<
tonic::Response<super::ListTensorboardTimeSeriesResponse>,
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.aiplatform.v1.TensorboardService/ListTensorboardTimeSeries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ListTensorboardTimeSeries",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a TensorboardTimeSeries.
pub async fn delete_tensorboard_time_series(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTensorboardTimeSeriesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.TensorboardService/DeleteTensorboardTimeSeries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"DeleteTensorboardTimeSeries",
),
);
self.inner.unary(req, path, codec).await
}
/// Reads multiple TensorboardTimeSeries' data. The data point number limit is
/// 1000 for scalars, 100 for tensors and blob references. If the number of
/// data points stored is less than the limit, all data is returned.
/// Otherwise, the number limit of data points is randomly selected from
/// this time series and returned.
pub async fn batch_read_tensorboard_time_series_data(
&mut self,
request: impl tonic::IntoRequest<
super::BatchReadTensorboardTimeSeriesDataRequest,
>,
) -> std::result::Result<
tonic::Response<super::BatchReadTensorboardTimeSeriesDataResponse>,
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.aiplatform.v1.TensorboardService/BatchReadTensorboardTimeSeriesData",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"BatchReadTensorboardTimeSeriesData",
),
);
self.inner.unary(req, path, codec).await
}
/// Reads a TensorboardTimeSeries' data. By default, if the number of data
/// points stored is less than 1000, all data is returned. Otherwise, 1000
/// data points is randomly selected from this time series and returned.
/// This value can be changed by changing max_data_points, which can't be
/// greater than 10k.
pub async fn read_tensorboard_time_series_data(
&mut self,
request: impl tonic::IntoRequest<super::ReadTensorboardTimeSeriesDataRequest>,
) -> std::result::Result<
tonic::Response<super::ReadTensorboardTimeSeriesDataResponse>,
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.aiplatform.v1.TensorboardService/ReadTensorboardTimeSeriesData",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ReadTensorboardTimeSeriesData",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets bytes of TensorboardBlobs.
/// This is to allow reading blob data stored in consumer project's Cloud
/// Storage bucket without users having to obtain Cloud Storage access
/// permission.
pub async fn read_tensorboard_blob_data(
&mut self,
request: impl tonic::IntoRequest<super::ReadTensorboardBlobDataRequest>,
) -> std::result::Result<
tonic::Response<
tonic::codec::Streaming<super::ReadTensorboardBlobDataResponse>,
>,
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.aiplatform.v1.TensorboardService/ReadTensorboardBlobData",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ReadTensorboardBlobData",
),
);
self.inner.server_streaming(req, path, codec).await
}
/// Write time series data points of multiple TensorboardTimeSeries in multiple
/// TensorboardRun's. If any data fail to be ingested, an error is returned.
pub async fn write_tensorboard_experiment_data(
&mut self,
request: impl tonic::IntoRequest<
super::WriteTensorboardExperimentDataRequest,
>,
) -> std::result::Result<
tonic::Response<super::WriteTensorboardExperimentDataResponse>,
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.aiplatform.v1.TensorboardService/WriteTensorboardExperimentData",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"WriteTensorboardExperimentData",
),
);
self.inner.unary(req, path, codec).await
}
/// Write time series data points into multiple TensorboardTimeSeries under
/// a TensorboardRun. If any data fail to be ingested, an error is returned.
pub async fn write_tensorboard_run_data(
&mut self,
request: impl tonic::IntoRequest<super::WriteTensorboardRunDataRequest>,
) -> std::result::Result<
tonic::Response<super::WriteTensorboardRunDataResponse>,
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.aiplatform.v1.TensorboardService/WriteTensorboardRunData",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"WriteTensorboardRunData",
),
);
self.inner.unary(req, path, codec).await
}
/// Exports a TensorboardTimeSeries' data. Data is returned in paginated
/// responses.
pub async fn export_tensorboard_time_series_data(
&mut self,
request: impl tonic::IntoRequest<
super::ExportTensorboardTimeSeriesDataRequest,
>,
) -> std::result::Result<
tonic::Response<super::ExportTensorboardTimeSeriesDataResponse>,
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.aiplatform.v1.TensorboardService/ExportTensorboardTimeSeriesData",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.TensorboardService",
"ExportTensorboardTimeSeriesData",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Request message for
/// [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateIndexEndpointRequest {
/// Required. The resource name of the Location to create the IndexEndpoint in.
/// Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The IndexEndpoint to create.
#[prost(message, optional, tag = "2")]
pub index_endpoint: ::core::option::Option<IndexEndpoint>,
}
/// Runtime operation information for
/// [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateIndexEndpointOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetIndexEndpointRequest {
/// Required. The name of the IndexEndpoint resource.
/// Format:
/// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListIndexEndpointsRequest {
/// Required. The resource name of the Location from which to list the
/// IndexEndpoints. Format: `projects/{project}/locations/{location}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. An expression for filtering the results of the request. For field
/// names both snake_case and camelCase are supported.
///
/// * `index_endpoint` supports = and !=. `index_endpoint` represents the
/// IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
/// [resourcename][google.cloud.aiplatform.v1.IndexEndpoint.name].
/// * `display_name` supports =, != and regex()
/// (uses [re2](<https://github.com/google/re2/wiki/Syntax>) syntax)
/// * `labels` supports general map functions that is:
/// `labels.key=value` - key:value equality
/// `labels.key:* or labels:key - key existence
/// A key including a space must be quoted. `labels."a key"`.
///
/// Some examples:
/// * `index_endpoint="1"`
/// * `display_name="myDisplayName"`
/// * `regex(display_name, "^A") -> The display name starts with an A.
/// * `labels.myKey="myValue"`
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. The standard list page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. The standard list page token.
/// Typically obtained via
/// [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token]
/// of the previous
/// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]
/// call.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Optional. Mask specifying which fields to read.
#[prost(message, optional, tag = "5")]
pub read_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Response message for
/// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListIndexEndpointsResponse {
/// List of IndexEndpoints in the requested page.
#[prost(message, repeated, tag = "1")]
pub index_endpoints: ::prost::alloc::vec::Vec<IndexEndpoint>,
/// A token to retrieve next page of results.
/// Pass to
/// [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListIndexEndpointsRequest.page_token]
/// to obtain that page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for
/// [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateIndexEndpointRequest {
/// Required. The IndexEndpoint which replaces the resource on the server.
#[prost(message, optional, tag = "1")]
pub index_endpoint: ::core::option::Option<IndexEndpoint>,
/// Required. The update mask applies to the resource. See
/// [google.protobuf.FieldMask][google.protobuf.FieldMask].
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteIndexEndpointRequest {
/// Required. The name of the IndexEndpoint resource to be deleted.
/// Format:
/// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployIndexRequest {
/// Required. The name of the IndexEndpoint resource into which to deploy an
/// Index. Format:
/// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
#[prost(string, tag = "1")]
pub index_endpoint: ::prost::alloc::string::String,
/// Required. The DeployedIndex to be created within the IndexEndpoint.
#[prost(message, optional, tag = "2")]
pub deployed_index: ::core::option::Option<DeployedIndex>,
}
/// Response message for
/// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployIndexResponse {
/// The DeployedIndex that had been deployed in the IndexEndpoint.
#[prost(message, optional, tag = "1")]
pub deployed_index: ::core::option::Option<DeployedIndex>,
}
/// Runtime operation information for
/// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeployIndexOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// The unique index id specified by user
#[prost(string, tag = "2")]
pub deployed_index_id: ::prost::alloc::string::String,
}
/// Request message for
/// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UndeployIndexRequest {
/// Required. The name of the IndexEndpoint resource from which to undeploy an
/// Index. Format:
/// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
#[prost(string, tag = "1")]
pub index_endpoint: ::prost::alloc::string::String,
/// Required. The ID of the DeployedIndex to be undeployed from the
/// IndexEndpoint.
#[prost(string, tag = "2")]
pub deployed_index_id: ::prost::alloc::string::String,
}
/// Response message for
/// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UndeployIndexResponse {}
/// Runtime operation information for
/// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UndeployIndexOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
}
/// Request message for
/// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateDeployedIndexRequest {
/// Required. The name of the IndexEndpoint resource into which to deploy an
/// Index. Format:
/// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
#[prost(string, tag = "1")]
pub index_endpoint: ::prost::alloc::string::String,
/// Required. The DeployedIndex to be updated within the IndexEndpoint.
/// Currently, the updatable fields are [DeployedIndex][automatic_resources]
/// and [DeployedIndex][dedicated_resources]
#[prost(message, optional, tag = "2")]
pub deployed_index: ::core::option::Option<DeployedIndex>,
}
/// Response message for
/// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateDeployedIndexResponse {
/// The DeployedIndex that had been updated in the IndexEndpoint.
#[prost(message, optional, tag = "1")]
pub deployed_index: ::core::option::Option<DeployedIndex>,
}
/// Runtime operation information for
/// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateDeployedIndexOperationMetadata {
/// The operation generic information.
#[prost(message, optional, tag = "1")]
pub generic_metadata: ::core::option::Option<GenericOperationMetadata>,
/// The unique index id specified by user
#[prost(string, tag = "2")]
pub deployed_index_id: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod index_endpoint_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// A service for managing Vertex AI's IndexEndpoints.
#[derive(Debug, Clone)]
pub struct IndexEndpointServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> IndexEndpointServiceClient<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,
) -> IndexEndpointServiceClient<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,
{
IndexEndpointServiceClient::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 an IndexEndpoint.
pub async fn create_index_endpoint(
&mut self,
request: impl tonic::IntoRequest<super::CreateIndexEndpointRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.IndexEndpointService/CreateIndexEndpoint",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexEndpointService",
"CreateIndexEndpoint",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets an IndexEndpoint.
pub async fn get_index_endpoint(
&mut self,
request: impl tonic::IntoRequest<super::GetIndexEndpointRequest>,
) -> std::result::Result<tonic::Response<super::IndexEndpoint>, 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.aiplatform.v1.IndexEndpointService/GetIndexEndpoint",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexEndpointService",
"GetIndexEndpoint",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists IndexEndpoints in a Location.
pub async fn list_index_endpoints(
&mut self,
request: impl tonic::IntoRequest<super::ListIndexEndpointsRequest>,
) -> std::result::Result<
tonic::Response<super::ListIndexEndpointsResponse>,
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.aiplatform.v1.IndexEndpointService/ListIndexEndpoints",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexEndpointService",
"ListIndexEndpoints",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an IndexEndpoint.
pub async fn update_index_endpoint(
&mut self,
request: impl tonic::IntoRequest<super::UpdateIndexEndpointRequest>,
) -> std::result::Result<tonic::Response<super::IndexEndpoint>, 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.aiplatform.v1.IndexEndpointService/UpdateIndexEndpoint",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexEndpointService",
"UpdateIndexEndpoint",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an IndexEndpoint.
pub async fn delete_index_endpoint(
&mut self,
request: impl tonic::IntoRequest<super::DeleteIndexEndpointRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.IndexEndpointService/DeleteIndexEndpoint",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexEndpointService",
"DeleteIndexEndpoint",
),
);
self.inner.unary(req, path, codec).await
}
/// Deploys an Index into this IndexEndpoint, creating a DeployedIndex within
/// it.
/// Only non-empty Indexes can be deployed.
pub async fn deploy_index(
&mut self,
request: impl tonic::IntoRequest<super::DeployIndexRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.IndexEndpointService/DeployIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexEndpointService",
"DeployIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it,
/// and freeing all resources it's using.
pub async fn undeploy_index(
&mut self,
request: impl tonic::IntoRequest<super::UndeployIndexRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.IndexEndpointService/UndeployIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexEndpointService",
"UndeployIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Update an existing DeployedIndex under an IndexEndpoint.
pub async fn mutate_deployed_index(
&mut self,
request: impl tonic::IntoRequest<super::MutateDeployedIndexRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.aiplatform.v1.IndexEndpointService/MutateDeployedIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.aiplatform.v1.IndexEndpointService",
"MutateDeployedIndex",
),
);
self.inner.unary(req, path, codec).await
}
}
}