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
// This file is @generated by prost-build.
/// A schema resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Schema {
/// Required. Name of the schema.
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The type of the schema definition.
#[prost(enumeration = "schema::Type", tag = "2")]
pub r#type: i32,
/// The definition of the schema. This should contain a string representing
/// the full definition of the schema that is a valid schema definition of
/// the type specified in `type`.
#[prost(string, tag = "3")]
pub definition: ::prost::alloc::string::String,
/// Output only. Immutable. The revision ID of the schema.
#[prost(string, tag = "4")]
pub revision_id: ::prost::alloc::string::String,
/// Output only. The timestamp that the revision was created.
#[prost(message, optional, tag = "6")]
pub revision_create_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Nested message and enum types in `Schema`.
pub mod schema {
/// Possible schema definition types.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// Default value. This value is unused.
Unspecified = 0,
/// A Protocol Buffer schema definition.
ProtocolBuffer = 1,
/// An Avro schema definition.
Avro = 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::ProtocolBuffer => "PROTOCOL_BUFFER",
Type::Avro => "AVRO",
}
}
/// 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),
"PROTOCOL_BUFFER" => Some(Self::ProtocolBuffer),
"AVRO" => Some(Self::Avro),
_ => None,
}
}
}
}
/// Request for the CreateSchema method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSchemaRequest {
/// Required. The name of the project in which to create the schema.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The schema object to create.
///
/// This schema's `name` parameter is ignored. The schema object returned
/// by CreateSchema will have a `name` made using the given `parent` and
/// `schema_id`.
#[prost(message, optional, tag = "2")]
pub schema: ::core::option::Option<Schema>,
/// The ID to use for the schema, which will become the final component of
/// the schema's resource name.
///
/// See <https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names> for
/// resource name constraints.
#[prost(string, tag = "3")]
pub schema_id: ::prost::alloc::string::String,
}
/// Request for the GetSchema method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSchemaRequest {
/// Required. The name of the schema to get.
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The set of fields to return in the response. If not set, returns a Schema
/// with all fields filled out. Set to `BASIC` to omit the `definition`.
#[prost(enumeration = "SchemaView", tag = "2")]
pub view: i32,
}
/// Request for the `ListSchemas` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchemasRequest {
/// Required. The name of the project in which to list schemas.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The set of Schema fields to return in the response. If not set, returns
/// Schemas with `name` and `type`, but not `definition`. Set to `FULL` to
/// retrieve all fields.
#[prost(enumeration = "SchemaView", tag = "2")]
pub view: i32,
/// Maximum number of schemas to return.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The value returned by the last `ListSchemasResponse`; indicates that
/// this is a continuation of a prior `ListSchemas` call, and that the
/// system should return the next page of data.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListSchemas` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchemasResponse {
/// The resulting schemas.
#[prost(message, repeated, tag = "1")]
pub schemas: ::prost::alloc::vec::Vec<Schema>,
/// If not empty, indicates that there may be more schemas that match the
/// request; this value should be passed in a new `ListSchemasRequest`.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `ListSchemaRevisions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchemaRevisionsRequest {
/// Required. The name of the schema to list revisions for.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The set of Schema fields to return in the response. If not set, returns
/// Schemas with `name` and `type`, but not `definition`. Set to `FULL` to
/// retrieve all fields.
#[prost(enumeration = "SchemaView", tag = "2")]
pub view: i32,
/// The maximum number of revisions to return per page.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The page token, received from a previous ListSchemaRevisions call.
/// Provide this to retrieve the subsequent page.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListSchemaRevisions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchemaRevisionsResponse {
/// The revisions of the schema.
#[prost(message, repeated, tag = "1")]
pub schemas: ::prost::alloc::vec::Vec<Schema>,
/// A token that can be sent as `page_token` to retrieve the next page.
/// If this field is empty, there are no subsequent pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for CommitSchema method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommitSchemaRequest {
/// Required. The name of the schema we are revising.
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The schema revision to commit.
#[prost(message, optional, tag = "2")]
pub schema: ::core::option::Option<Schema>,
}
/// Request for the `RollbackSchema` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RollbackSchemaRequest {
/// Required. The schema being rolled back with revision id.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The revision ID to roll back to.
/// It must be a revision of the same schema.
///
/// Example: c7cfa2a8
#[prost(string, tag = "2")]
pub revision_id: ::prost::alloc::string::String,
}
/// Request for the `DeleteSchemaRevision` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSchemaRevisionRequest {
/// Required. The name of the schema revision to be deleted, with a revision ID
/// explicitly included.
///
/// Example: `projects/123/schemas/my-schema@c7cfa2a8`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. This field is deprecated and should not be used for specifying
/// the revision ID. The revision ID should be specified via the `name`
/// parameter.
#[deprecated]
#[prost(string, tag = "2")]
pub revision_id: ::prost::alloc::string::String,
}
/// Request for the `DeleteSchema` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSchemaRequest {
/// Required. Name of the schema to delete.
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request for the `ValidateSchema` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ValidateSchemaRequest {
/// Required. The name of the project in which to validate schemas.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The schema object to validate.
#[prost(message, optional, tag = "2")]
pub schema: ::core::option::Option<Schema>,
}
/// Response for the `ValidateSchema` method.
/// Empty for now.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ValidateSchemaResponse {}
/// Request for the `ValidateMessage` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ValidateMessageRequest {
/// Required. The name of the project in which to validate schemas.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Message to validate against the provided `schema_spec`.
#[prost(bytes = "bytes", tag = "4")]
pub message: ::prost::bytes::Bytes,
/// The encoding expected for messages
#[prost(enumeration = "Encoding", tag = "5")]
pub encoding: i32,
#[prost(oneof = "validate_message_request::SchemaSpec", tags = "2, 3")]
pub schema_spec: ::core::option::Option<validate_message_request::SchemaSpec>,
}
/// Nested message and enum types in `ValidateMessageRequest`.
pub mod validate_message_request {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SchemaSpec {
/// Name of the schema against which to validate.
///
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "2")]
Name(::prost::alloc::string::String),
/// Ad-hoc schema against which to validate
#[prost(message, tag = "3")]
Schema(super::Schema),
}
}
/// Response for the `ValidateMessage` method.
/// Empty for now.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ValidateMessageResponse {}
/// View of Schema object fields to be returned by GetSchema and ListSchemas.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum SchemaView {
/// The default / unset value.
/// The API will default to the BASIC view.
Unspecified = 0,
/// Include the name and type of the schema, but not the definition.
Basic = 1,
/// Include all Schema object fields.
Full = 2,
}
impl SchemaView {
/// 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 {
SchemaView::Unspecified => "SCHEMA_VIEW_UNSPECIFIED",
SchemaView::Basic => "BASIC",
SchemaView::Full => "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 {
"SCHEMA_VIEW_UNSPECIFIED" => Some(Self::Unspecified),
"BASIC" => Some(Self::Basic),
"FULL" => Some(Self::Full),
_ => None,
}
}
}
/// Possible encoding types for messages.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Encoding {
/// Unspecified
Unspecified = 0,
/// JSON encoding
Json = 1,
/// Binary encoding, as defined by the schema type. For some schema types,
/// binary encoding may not be available.
Binary = 2,
}
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::Json => "JSON",
Encoding::Binary => "BINARY",
}
}
/// 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),
"JSON" => Some(Self::Json),
"BINARY" => Some(Self::Binary),
_ => None,
}
}
}
/// Generated client implementations.
pub mod schema_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Service for doing schema-related operations.
#[derive(Debug, Clone)]
pub struct SchemaServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> SchemaServiceClient<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,
) -> SchemaServiceClient<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,
{
SchemaServiceClient::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 schema.
pub async fn create_schema(
&mut self,
request: impl tonic::IntoRequest<super::CreateSchemaRequest>,
) -> std::result::Result<tonic::Response<super::Schema>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/CreateSchema",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.SchemaService", "CreateSchema"),
);
self.inner.unary(req, path, codec).await
}
/// Gets a schema.
pub async fn get_schema(
&mut self,
request: impl tonic::IntoRequest<super::GetSchemaRequest>,
) -> std::result::Result<tonic::Response<super::Schema>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/GetSchema",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.SchemaService", "GetSchema"));
self.inner.unary(req, path, codec).await
}
/// Lists schemas in a project.
pub async fn list_schemas(
&mut self,
request: impl tonic::IntoRequest<super::ListSchemasRequest>,
) -> std::result::Result<
tonic::Response<super::ListSchemasResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/ListSchemas",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.SchemaService", "ListSchemas"),
);
self.inner.unary(req, path, codec).await
}
/// Lists all schema revisions for the named schema.
pub async fn list_schema_revisions(
&mut self,
request: impl tonic::IntoRequest<super::ListSchemaRevisionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListSchemaRevisionsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/ListSchemaRevisions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.pubsub.v1.SchemaService",
"ListSchemaRevisions",
),
);
self.inner.unary(req, path, codec).await
}
/// Commits a new schema revision to an existing schema.
pub async fn commit_schema(
&mut self,
request: impl tonic::IntoRequest<super::CommitSchemaRequest>,
) -> std::result::Result<tonic::Response<super::Schema>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/CommitSchema",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.SchemaService", "CommitSchema"),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new schema revision that is a copy of the provided revision_id.
pub async fn rollback_schema(
&mut self,
request: impl tonic::IntoRequest<super::RollbackSchemaRequest>,
) -> std::result::Result<tonic::Response<super::Schema>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/RollbackSchema",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.SchemaService", "RollbackSchema"),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a specific schema revision.
pub async fn delete_schema_revision(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSchemaRevisionRequest>,
) -> std::result::Result<tonic::Response<super::Schema>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/DeleteSchemaRevision",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.pubsub.v1.SchemaService",
"DeleteSchemaRevision",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a schema.
pub async fn delete_schema(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSchemaRequest>,
) -> 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.pubsub.v1.SchemaService/DeleteSchema",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.SchemaService", "DeleteSchema"),
);
self.inner.unary(req, path, codec).await
}
/// Validates a schema.
pub async fn validate_schema(
&mut self,
request: impl tonic::IntoRequest<super::ValidateSchemaRequest>,
) -> std::result::Result<
tonic::Response<super::ValidateSchemaResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/ValidateSchema",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.SchemaService", "ValidateSchema"),
);
self.inner.unary(req, path, codec).await
}
/// Validates a message against a schema.
pub async fn validate_message(
&mut self,
request: impl tonic::IntoRequest<super::ValidateMessageRequest>,
) -> std::result::Result<
tonic::Response<super::ValidateMessageResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/ValidateMessage",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.SchemaService", "ValidateMessage"),
);
self.inner.unary(req, path, codec).await
}
}
}
/// A policy constraining the storage of messages published to the topic.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MessageStoragePolicy {
/// Optional. A list of IDs of Google Cloud regions where messages that are
/// published to the topic may be persisted in storage. Messages published by
/// publishers running in non-allowed Google Cloud regions (or running outside
/// of Google Cloud altogether) are routed for storage in one of the allowed
/// regions. An empty list means that no regions are allowed, and is not a
/// valid configuration.
#[prost(string, repeated, tag = "1")]
pub allowed_persistence_regions: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// Optional. If true, `allowed_persistence_regions` is also used to enforce
/// in-transit guarantees for messages. That is, Pub/Sub will fail
/// Publish operations on this topic and subscribe operations
/// on any subscription attached to this topic in any region that is
/// not in `allowed_persistence_regions`.
#[prost(bool, tag = "2")]
pub enforce_in_transit: bool,
}
/// Settings for validating messages published against a schema.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SchemaSettings {
/// Required. The name of the schema that messages published should be
/// validated against. Format is `projects/{project}/schemas/{schema}`. The
/// value of this field will be `_deleted-schema_` if the schema has been
/// deleted.
#[prost(string, tag = "1")]
pub schema: ::prost::alloc::string::String,
/// Optional. The encoding of messages validated against `schema`.
#[prost(enumeration = "Encoding", tag = "2")]
pub encoding: i32,
/// Optional. The minimum (inclusive) revision allowed for validating messages.
/// If empty or not present, allow any revision to be validated against
/// last_revision or any revision created before.
#[prost(string, tag = "3")]
pub first_revision_id: ::prost::alloc::string::String,
/// Optional. The maximum (inclusive) revision allowed for validating messages.
/// If empty or not present, allow any revision to be validated against
/// first_revision or any revision created after.
#[prost(string, tag = "4")]
pub last_revision_id: ::prost::alloc::string::String,
}
/// Settings for an ingestion data source on a topic.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IngestionDataSourceSettings {
/// Only one source type can have settings set.
#[prost(oneof = "ingestion_data_source_settings::Source", tags = "1")]
pub source: ::core::option::Option<ingestion_data_source_settings::Source>,
}
/// Nested message and enum types in `IngestionDataSourceSettings`.
pub mod ingestion_data_source_settings {
/// Ingestion settings for Amazon Kinesis Data Streams.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AwsKinesis {
/// Output only. An output-only field that indicates the state of the Kinesis
/// ingestion source.
#[prost(enumeration = "aws_kinesis::State", tag = "1")]
pub state: i32,
/// Required. The Kinesis stream ARN to ingest data from.
#[prost(string, tag = "2")]
pub stream_arn: ::prost::alloc::string::String,
/// Required. The Kinesis consumer ARN to used for ingestion in Enhanced
/// Fan-Out mode. The consumer must be already created and ready to be used.
#[prost(string, tag = "3")]
pub consumer_arn: ::prost::alloc::string::String,
/// Required. AWS role ARN to be used for Federated Identity authentication
/// with Kinesis. Check the Pub/Sub docs for how to set up this role and the
/// required permissions that need to be attached to it.
#[prost(string, tag = "4")]
pub aws_role_arn: ::prost::alloc::string::String,
/// Required. The GCP service account to be used for Federated Identity
/// authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
/// the provided role). The `aws_role_arn` must be set up with
/// `accounts.google.com:sub` equals to this service account number.
#[prost(string, tag = "5")]
pub gcp_service_account: ::prost::alloc::string::String,
}
/// Nested message and enum types in `AwsKinesis`.
pub mod aws_kinesis {
/// Possible states for ingestion from Amazon Kinesis Data Streams.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Default value. This value is unused.
Unspecified = 0,
/// Ingestion is active.
Active = 1,
/// Permission denied encountered while consuming data from Kinesis.
/// This can happen if:
/// - The provided `aws_role_arn` does not exist or does not have the
/// appropriate permissions attached.
/// - The provided `aws_role_arn` is not set up properly for Identity
/// Federation using `gcp_service_account`.
/// - The Pub/Sub SA is not granted the
/// `iam.serviceAccounts.getOpenIdToken` permission on
/// `gcp_service_account`.
KinesisPermissionDenied = 2,
/// Permission denied encountered while publishing to the topic. This can
/// happen if the Pub/Sub SA has not been granted the [appropriate publish
/// permissions](<https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher>)
PublishPermissionDenied = 3,
/// The Kinesis stream does not exist.
StreamNotFound = 4,
/// The Kinesis consumer does not exist.
ConsumerNotFound = 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::Active => "ACTIVE",
State::KinesisPermissionDenied => "KINESIS_PERMISSION_DENIED",
State::PublishPermissionDenied => "PUBLISH_PERMISSION_DENIED",
State::StreamNotFound => "STREAM_NOT_FOUND",
State::ConsumerNotFound => "CONSUMER_NOT_FOUND",
}
}
/// 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),
"KINESIS_PERMISSION_DENIED" => Some(Self::KinesisPermissionDenied),
"PUBLISH_PERMISSION_DENIED" => Some(Self::PublishPermissionDenied),
"STREAM_NOT_FOUND" => Some(Self::StreamNotFound),
"CONSUMER_NOT_FOUND" => Some(Self::ConsumerNotFound),
_ => None,
}
}
}
}
/// Only one source type can have settings set.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// Optional. Amazon Kinesis Data Streams.
#[prost(message, tag = "1")]
AwsKinesis(AwsKinesis),
}
}
/// A topic resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Topic {
/// Required. The name of the topic. It must have the format
/// `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
/// and contain only letters (`\[A-Za-z\]`), numbers (`\[0-9\]`), dashes (`-`),
/// underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
/// signs (`%`). It must be between 3 and 255 characters in length, and it
/// must not start with `"goog"`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. See \[Creating and managing labels\]
/// (<https://cloud.google.com/pubsub/docs/labels>).
#[prost(btree_map = "string, string", tag = "2")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. Policy constraining the set of Google Cloud Platform regions
/// where messages published to the topic may be stored. If not present, then
/// no constraints are in effect.
#[prost(message, optional, tag = "3")]
pub message_storage_policy: ::core::option::Option<MessageStoragePolicy>,
/// Optional. The resource name of the Cloud KMS CryptoKey to be used to
/// protect access to messages published on this topic.
///
/// The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
#[prost(string, tag = "5")]
pub kms_key_name: ::prost::alloc::string::String,
/// Optional. Settings for validating messages published against a schema.
#[prost(message, optional, tag = "6")]
pub schema_settings: ::core::option::Option<SchemaSettings>,
/// Optional. Reserved for future use. This field is set only in responses from
/// the server; it is ignored if it is set in any requests.
#[prost(bool, tag = "7")]
pub satisfies_pzs: bool,
/// Optional. Indicates the minimum duration to retain a message after it is
/// published to the topic. If this field is set, messages published to the
/// topic in the last `message_retention_duration` are always available to
/// subscribers. For instance, it allows any attached subscription to [seek to
/// a
/// timestamp](<https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time>)
/// that is up to `message_retention_duration` in the past. If this field is
/// not set, message retention is controlled by settings on individual
/// subscriptions. Cannot be more than 31 days or less than 10 minutes.
#[prost(message, optional, tag = "8")]
pub message_retention_duration: ::core::option::Option<::prost_types::Duration>,
/// Output only. An output-only field indicating the state of the topic.
#[prost(enumeration = "topic::State", tag = "9")]
pub state: i32,
/// Optional. Settings for ingestion from a data source into this topic.
#[prost(message, optional, tag = "10")]
pub ingestion_data_source_settings: ::core::option::Option<
IngestionDataSourceSettings,
>,
}
/// Nested message and enum types in `Topic`.
pub mod topic {
/// The state of the topic.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Default value. This value is unused.
Unspecified = 0,
/// The topic does not have any persistent errors.
Active = 1,
/// Ingestion from the data source has encountered a permanent error.
/// See the more detailed error state in the corresponding ingestion
/// source configuration.
IngestionResourceError = 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::Active => "ACTIVE",
State::IngestionResourceError => "INGESTION_RESOURCE_ERROR",
}
}
/// 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),
"INGESTION_RESOURCE_ERROR" => Some(Self::IngestionResourceError),
_ => None,
}
}
}
}
/// A message that is published by publishers and consumed by subscribers. The
/// message must contain either a non-empty data field or at least one attribute.
/// Note that client libraries represent this object differently
/// depending on the language. See the corresponding [client library
/// documentation](<https://cloud.google.com/pubsub/docs/reference/libraries>) for
/// more information. See \[quotas and limits\]
/// (<https://cloud.google.com/pubsub/quotas>) for more information about message
/// limits.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PubsubMessage {
/// Optional. The message data field. If this field is empty, the message must
/// contain at least one attribute.
#[prost(bytes = "bytes", tag = "1")]
pub data: ::prost::bytes::Bytes,
/// Optional. Attributes for this message. If this field is empty, the message
/// must contain non-empty data. This can be used to filter messages on the
/// subscription.
#[prost(btree_map = "string, string", tag = "2")]
pub attributes: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// ID of this message, assigned by the server when the message is published.
/// Guaranteed to be unique within the topic. This value may be read by a
/// subscriber that receives a `PubsubMessage` via a `Pull` call or a push
/// delivery. It must not be populated by the publisher in a `Publish` call.
#[prost(string, tag = "3")]
pub message_id: ::prost::alloc::string::String,
/// The time at which the message was published, populated by the server when
/// it receives the `Publish` call. It must not be populated by the
/// publisher in a `Publish` call.
#[prost(message, optional, tag = "4")]
pub publish_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. If non-empty, identifies related messages for which publish order
/// should be respected. If a `Subscription` has `enable_message_ordering` set
/// to `true`, messages published with the same non-empty `ordering_key` value
/// will be delivered to subscribers in the order in which they are received by
/// the Pub/Sub system. All `PubsubMessage`s published in a given
/// `PublishRequest` must specify the same `ordering_key` value. For more
/// information, see [ordering
/// messages](<https://cloud.google.com/pubsub/docs/ordering>).
#[prost(string, tag = "5")]
pub ordering_key: ::prost::alloc::string::String,
}
/// Request for the GetTopic method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTopicRequest {
/// Required. The name of the topic to get.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
}
/// Request for the UpdateTopic method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTopicRequest {
/// Required. The updated topic object.
#[prost(message, optional, tag = "1")]
pub topic: ::core::option::Option<Topic>,
/// Required. Indicates which fields in the provided topic to update. Must be
/// specified and non-empty. Note that if `update_mask` contains
/// "message_storage_policy" but the `message_storage_policy` is not set in
/// the `topic` provided above, then the updated value is determined by the
/// policy configured at the project or organization level.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request for the Publish method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PublishRequest {
/// Required. The messages in the request will be published on this topic.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
/// Required. The messages to publish.
#[prost(message, repeated, tag = "2")]
pub messages: ::prost::alloc::vec::Vec<PubsubMessage>,
}
/// Response for the `Publish` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PublishResponse {
/// Optional. The server-assigned ID of each published message, in the same
/// order as the messages in the request. IDs are guaranteed to be unique
/// within the topic.
#[prost(string, repeated, tag = "1")]
pub message_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request for the `ListTopics` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicsRequest {
/// Required. The name of the project in which to list topics.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub project: ::prost::alloc::string::String,
/// Optional. Maximum number of topics to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. The value returned by the last `ListTopicsResponse`; indicates
/// that this is a continuation of a prior `ListTopics` call, and that the
/// system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListTopics` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicsResponse {
/// Optional. The resulting topics.
#[prost(message, repeated, tag = "1")]
pub topics: ::prost::alloc::vec::Vec<Topic>,
/// Optional. If not empty, indicates that there may be more topics that match
/// the request; this value should be passed in a new `ListTopicsRequest`.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `ListTopicSubscriptions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicSubscriptionsRequest {
/// Required. The name of the topic that subscriptions are attached to.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
/// Optional. Maximum number of subscription names to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. The value returned by the last `ListTopicSubscriptionsResponse`;
/// indicates that this is a continuation of a prior `ListTopicSubscriptions`
/// call, and that the system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListTopicSubscriptions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicSubscriptionsResponse {
/// Optional. The names of subscriptions attached to the topic specified in the
/// request.
#[prost(string, repeated, tag = "1")]
pub subscriptions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. If not empty, indicates that there may be more subscriptions that
/// match the request; this value should be passed in a new
/// `ListTopicSubscriptionsRequest` to get more subscriptions.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `ListTopicSnapshots` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicSnapshotsRequest {
/// Required. The name of the topic that snapshots are attached to.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
/// Optional. Maximum number of snapshot names to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. The value returned by the last `ListTopicSnapshotsResponse`;
/// indicates that this is a continuation of a prior `ListTopicSnapshots` call,
/// and that the system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListTopicSnapshots` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicSnapshotsResponse {
/// Optional. The names of the snapshots that match the request.
#[prost(string, repeated, tag = "1")]
pub snapshots: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. If not empty, indicates that there may be more snapshots that
/// match the request; this value should be passed in a new
/// `ListTopicSnapshotsRequest` to get more snapshots.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `DeleteTopic` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTopicRequest {
/// Required. Name of the topic to delete.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
}
/// Request for the DetachSubscription method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DetachSubscriptionRequest {
/// Required. The subscription to detach.
/// Format is `projects/{project}/subscriptions/{subscription}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
}
/// Response for the DetachSubscription method.
/// Reserved for future use.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DetachSubscriptionResponse {}
/// A subscription resource. If none of `push_config`, `bigquery_config`, or
/// `cloud_storage_config` is set, then the subscriber will pull and ack messages
/// using API methods. At most one of these fields may be set.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Subscription {
/// Required. The name of the subscription. It must have the format
/// `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
/// start with a letter, and contain only letters (`\[A-Za-z\]`), numbers
/// (`\[0-9\]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
/// plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
/// in length, and it must not start with `"goog"`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The name of the topic from which this subscription is receiving
/// messages. Format is `projects/{project}/topics/{topic}`. The value of this
/// field will be `_deleted-topic_` if the topic has been deleted.
#[prost(string, tag = "2")]
pub topic: ::prost::alloc::string::String,
/// Optional. If push delivery is used with this subscription, this field is
/// used to configure it.
#[prost(message, optional, tag = "4")]
pub push_config: ::core::option::Option<PushConfig>,
/// Optional. If delivery to BigQuery is used with this subscription, this
/// field is used to configure it.
#[prost(message, optional, tag = "18")]
pub bigquery_config: ::core::option::Option<BigQueryConfig>,
/// Optional. If delivery to Google Cloud Storage is used with this
/// subscription, this field is used to configure it.
#[prost(message, optional, tag = "22")]
pub cloud_storage_config: ::core::option::Option<CloudStorageConfig>,
/// Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
/// waits for the subscriber to acknowledge receipt before resending the
/// message. In the interval after the message is delivered and before it is
/// acknowledged, it is considered to be _outstanding_. During that time
/// period, the message will not be redelivered (on a best-effort basis).
///
/// For pull subscriptions, this value is used as the initial value for the ack
/// deadline. To override this value for a given message, call
/// `ModifyAckDeadline` with the corresponding `ack_id` if using
/// non-streaming pull or send the `ack_id` in a
/// `StreamingModifyAckDeadlineRequest` if using streaming pull.
/// The minimum custom deadline you can specify is 10 seconds.
/// The maximum custom deadline you can specify is 600 seconds (10 minutes).
/// If this parameter is 0, a default value of 10 seconds is used.
///
/// For push delivery, this value is also used to set the request timeout for
/// the call to the push endpoint.
///
/// If the subscriber never acknowledges the message, the Pub/Sub
/// system will eventually redeliver the message.
#[prost(int32, tag = "5")]
pub ack_deadline_seconds: i32,
/// Optional. Indicates whether to retain acknowledged messages. If true, then
/// messages are not expunged from the subscription's backlog, even if they are
/// acknowledged, until they fall out of the `message_retention_duration`
/// window. This must be true if you would like to \[`Seek` to a timestamp\]
/// (<https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time>) in
/// the past to replay previously-acknowledged messages.
#[prost(bool, tag = "7")]
pub retain_acked_messages: bool,
/// Optional. How long to retain unacknowledged messages in the subscription's
/// backlog, from the moment a message is published. If `retain_acked_messages`
/// is true, then this also configures the retention of acknowledged messages,
/// and thus configures how far back in time a `Seek` can be done. Defaults to
/// 7 days. Cannot be more than 7 days or less than 10 minutes.
#[prost(message, optional, tag = "8")]
pub message_retention_duration: ::core::option::Option<::prost_types::Duration>,
/// Optional. See [Creating and managing
/// labels](<https://cloud.google.com/pubsub/docs/labels>).
#[prost(btree_map = "string, string", tag = "9")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. If true, messages published with the same `ordering_key` in
/// `PubsubMessage` will be delivered to the subscribers in the order in which
/// they are received by the Pub/Sub system. Otherwise, they may be delivered
/// in any order.
#[prost(bool, tag = "10")]
pub enable_message_ordering: bool,
/// Optional. A policy that specifies the conditions for this subscription's
/// expiration. A subscription is considered active as long as any connected
/// subscriber is successfully consuming messages from the subscription or is
/// issuing operations on the subscription. If `expiration_policy` is not set,
/// a *default policy* with `ttl` of 31 days will be used. The minimum allowed
/// value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
/// but `expiration_policy.ttl` is not set, the subscription never expires.
#[prost(message, optional, tag = "11")]
pub expiration_policy: ::core::option::Option<ExpirationPolicy>,
/// Optional. An expression written in the Pub/Sub [filter
/// language](<https://cloud.google.com/pubsub/docs/filtering>). If non-empty,
/// then only `PubsubMessage`s whose `attributes` field matches the filter are
/// delivered on this subscription. If empty, then no messages are filtered
/// out.
#[prost(string, tag = "12")]
pub filter: ::prost::alloc::string::String,
/// Optional. A policy that specifies the conditions for dead lettering
/// messages in this subscription. If dead_letter_policy is not set, dead
/// lettering is disabled.
///
/// The Pub/Sub service account associated with this subscriptions's
/// parent project (i.e.,
/// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
/// permission to Acknowledge() messages on this subscription.
#[prost(message, optional, tag = "13")]
pub dead_letter_policy: ::core::option::Option<DeadLetterPolicy>,
/// Optional. A policy that specifies how Pub/Sub retries message delivery for
/// this subscription.
///
/// If not set, the default retry policy is applied. This generally implies
/// that messages will be retried as soon as possible for healthy subscribers.
/// RetryPolicy will be triggered on NACKs or acknowledgement deadline
/// exceeded events for a given message.
#[prost(message, optional, tag = "14")]
pub retry_policy: ::core::option::Option<RetryPolicy>,
/// Optional. Indicates whether the subscription is detached from its topic.
/// Detached subscriptions don't receive messages from their topic and don't
/// retain any backlog. `Pull` and `StreamingPull` requests will return
/// FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
/// the endpoint will not be made.
#[prost(bool, tag = "15")]
pub detached: bool,
/// Optional. If true, Pub/Sub provides the following guarantees for the
/// delivery of a message with a given value of `message_id` on this
/// subscription:
///
/// * The message sent to a subscriber is guaranteed not to be resent
/// before the message's acknowledgement deadline expires.
/// * An acknowledged message will not be resent to a subscriber.
///
/// Note that subscribers may still receive multiple copies of a message
/// when `enable_exactly_once_delivery` is true if the message was published
/// multiple times by a publisher client. These copies are considered distinct
/// by Pub/Sub and have distinct `message_id` values.
#[prost(bool, tag = "16")]
pub enable_exactly_once_delivery: bool,
/// Output only. Indicates the minimum duration for which a message is retained
/// after it is published to the subscription's topic. If this field is set,
/// messages published to the subscription's topic in the last
/// `topic_message_retention_duration` are always available to subscribers. See
/// the `message_retention_duration` field in `Topic`. This field is set only
/// in responses from the server; it is ignored if it is set in any requests.
#[prost(message, optional, tag = "17")]
pub topic_message_retention_duration: ::core::option::Option<
::prost_types::Duration,
>,
/// Output only. An output-only field indicating whether or not the
/// subscription can receive messages.
#[prost(enumeration = "subscription::State", tag = "19")]
pub state: i32,
}
/// Nested message and enum types in `Subscription`.
pub mod subscription {
/// Possible states for a subscription.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Default value. This value is unused.
Unspecified = 0,
/// The subscription can actively receive messages
Active = 1,
/// The subscription cannot receive messages because of an error with the
/// resource to which it pushes messages. See the more detailed error state
/// in the corresponding configuration.
ResourceError = 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::Active => "ACTIVE",
State::ResourceError => "RESOURCE_ERROR",
}
}
/// 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),
"RESOURCE_ERROR" => Some(Self::ResourceError),
_ => None,
}
}
}
}
/// A policy that specifies how Pub/Sub retries message delivery.
///
/// Retry delay will be exponential based on provided minimum and maximum
/// backoffs. <https://en.wikipedia.org/wiki/Exponential_backoff.>
///
/// RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded
/// events for a given message.
///
/// Retry Policy is implemented on a best effort basis. At times, the delay
/// between consecutive deliveries may not match the configuration. That is,
/// delay can be more or less than configured backoff.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RetryPolicy {
/// Optional. The minimum delay between consecutive deliveries of a given
/// message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
#[prost(message, optional, tag = "1")]
pub minimum_backoff: ::core::option::Option<::prost_types::Duration>,
/// Optional. The maximum delay between consecutive deliveries of a given
/// message. Value should be between 0 and 600 seconds. Defaults to 600
/// seconds.
#[prost(message, optional, tag = "2")]
pub maximum_backoff: ::core::option::Option<::prost_types::Duration>,
}
/// Dead lettering is done on a best effort basis. The same message might be
/// dead lettered multiple times.
///
/// If validation on any of the fields fails at subscription creation/updation,
/// the create/update subscription request will fail.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeadLetterPolicy {
/// Optional. The name of the topic to which dead letter messages should be
/// published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub
/// service account associated with the enclosing subscription's parent project
/// (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must
/// have permission to Publish() to this topic.
///
/// The operation will fail if the topic does not exist.
/// Users should ensure that there is a subscription attached to this topic
/// since messages published to a topic with no subscriptions are lost.
#[prost(string, tag = "1")]
pub dead_letter_topic: ::prost::alloc::string::String,
/// Optional. The maximum number of delivery attempts for any message. The
/// value must be between 5 and 100.
///
/// The number of delivery attempts is defined as 1 + (the sum of number of
/// NACKs and number of times the acknowledgement deadline has been exceeded
/// for the message).
///
/// A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
/// client libraries may automatically extend ack_deadlines.
///
/// This field will be honored on a best effort basis.
///
/// If this parameter is 0, a default value of 5 is used.
#[prost(int32, tag = "2")]
pub max_delivery_attempts: i32,
}
/// A policy that specifies the conditions for resource expiration (i.e.,
/// automatic resource deletion).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ExpirationPolicy {
/// Optional. Specifies the "time-to-live" duration for an associated resource.
/// The resource expires if it is not active for a period of `ttl`. The
/// definition of "activity" depends on the type of the associated resource.
/// The minimum and maximum allowed values for `ttl` depend on the type of the
/// associated resource, as well. If `ttl` is not set, the associated resource
/// never expires.
#[prost(message, optional, tag = "1")]
pub ttl: ::core::option::Option<::prost_types::Duration>,
}
/// Configuration for a push delivery endpoint.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PushConfig {
/// Optional. A URL locating the endpoint to which messages should be pushed.
/// For example, a Webhook endpoint might use `<https://example.com/push`.>
#[prost(string, tag = "1")]
pub push_endpoint: ::prost::alloc::string::String,
/// Optional. Endpoint configuration attributes that can be used to control
/// different aspects of the message delivery.
///
/// The only currently supported attribute is `x-goog-version`, which you can
/// use to change the format of the pushed message. This attribute
/// indicates the version of the data expected by the endpoint. This
/// controls the shape of the pushed message (i.e., its fields and metadata).
///
/// If not present during the `CreateSubscription` call, it will default to
/// the version of the Pub/Sub API used to make such call. If not present in a
/// `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
/// calls will always return a valid version, even if the subscription was
/// created without this attribute.
///
/// The only supported values for the `x-goog-version` attribute are:
///
/// * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
/// * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
///
/// For example:
/// `attributes { "x-goog-version": "v1" }`
#[prost(btree_map = "string, string", tag = "2")]
pub attributes: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// An authentication method used by push endpoints to verify the source of
/// push requests. This can be used with push endpoints that are private by
/// default to allow requests only from the Pub/Sub system, for example.
/// This field is optional and should be set only by users interested in
/// authenticated push.
#[prost(oneof = "push_config::AuthenticationMethod", tags = "3")]
pub authentication_method: ::core::option::Option<push_config::AuthenticationMethod>,
/// The format of the delivered message to the push endpoint is defined by
/// the chosen wrapper. When unset, `PubsubWrapper` is used.
#[prost(oneof = "push_config::Wrapper", tags = "4, 5")]
pub wrapper: ::core::option::Option<push_config::Wrapper>,
}
/// Nested message and enum types in `PushConfig`.
pub mod push_config {
/// Contains information needed for generating an
/// [OpenID Connect
/// token](<https://developers.google.com/identity/protocols/OpenIDConnect>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OidcToken {
/// Optional. [Service account
/// email](<https://cloud.google.com/iam/docs/service-accounts>)
/// used for generating the OIDC token. For more information
/// on setting up authentication, see
/// [Push subscriptions](<https://cloud.google.com/pubsub/docs/push>).
#[prost(string, tag = "1")]
pub service_account_email: ::prost::alloc::string::String,
/// Optional. Audience to be used when generating OIDC token. The audience
/// claim identifies the recipients that the JWT is intended for. The
/// audience value is a single case-sensitive string. Having multiple values
/// (array) for the audience field is not supported. More info about the OIDC
/// JWT token audience here:
/// <https://tools.ietf.org/html/rfc7519#section-4.1.3> Note: if not specified,
/// the Push endpoint URL will be used.
#[prost(string, tag = "2")]
pub audience: ::prost::alloc::string::String,
}
/// The payload to the push endpoint is in the form of the JSON representation
/// of a PubsubMessage
/// (<https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage>).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct PubsubWrapper {}
/// Sets the `data` field as the HTTP body for delivery.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct NoWrapper {
/// Optional. When true, writes the Pub/Sub message metadata to
/// `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
/// Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
#[prost(bool, tag = "1")]
pub write_metadata: bool,
}
/// An authentication method used by push endpoints to verify the source of
/// push requests. This can be used with push endpoints that are private by
/// default to allow requests only from the Pub/Sub system, for example.
/// This field is optional and should be set only by users interested in
/// authenticated push.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum AuthenticationMethod {
/// Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
/// token as an `Authorization` header in the HTTP request for every pushed
/// message.
#[prost(message, tag = "3")]
OidcToken(OidcToken),
}
/// The format of the delivered message to the push endpoint is defined by
/// the chosen wrapper. When unset, `PubsubWrapper` is used.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Wrapper {
/// Optional. When set, the payload to the push endpoint is in the form of
/// the JSON representation of a PubsubMessage
/// (<https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage>).
#[prost(message, tag = "4")]
PubsubWrapper(PubsubWrapper),
/// Optional. When set, the payload to the push endpoint is not wrapped.
#[prost(message, tag = "5")]
NoWrapper(NoWrapper),
}
}
/// Configuration for a BigQuery subscription.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BigQueryConfig {
/// Optional. The name of the table to which to write data, of the form
/// {projectId}.{datasetId}.{tableId}
#[prost(string, tag = "1")]
pub table: ::prost::alloc::string::String,
/// Optional. When true, use the topic's schema as the columns to write to in
/// BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be
/// enabled at the same time.
#[prost(bool, tag = "2")]
pub use_topic_schema: bool,
/// Optional. When true, write the subscription name, message_id, publish_time,
/// attributes, and ordering_key to additional columns in the table. The
/// subscription name, message_id, and publish_time fields are put in their own
/// columns while all other message properties (other than data) are written to
/// a JSON object in the attributes column.
#[prost(bool, tag = "3")]
pub write_metadata: bool,
/// Optional. When true and use_topic_schema is true, any fields that are a
/// part of the topic schema that are not part of the BigQuery table schema are
/// dropped when writing to BigQuery. Otherwise, the schemas must be kept in
/// sync and any messages with extra fields are not written and remain in the
/// subscription's backlog.
#[prost(bool, tag = "4")]
pub drop_unknown_fields: bool,
/// Output only. An output-only field that indicates whether or not the
/// subscription can receive messages.
#[prost(enumeration = "big_query_config::State", tag = "5")]
pub state: i32,
/// Optional. When true, use the BigQuery table's schema as the columns to
/// write to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be
/// enabled at the same time.
#[prost(bool, tag = "6")]
pub use_table_schema: bool,
/// Optional. The service account to use to write to BigQuery. The subscription
/// creator or updater that specifies this field must have
/// `iam.serviceAccounts.actAs` permission on the service account. If not
/// specified, the Pub/Sub [service
/// agent](<https://cloud.google.com/iam/docs/service-agents>),
/// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
#[prost(string, tag = "7")]
pub service_account_email: ::prost::alloc::string::String,
}
/// Nested message and enum types in `BigQueryConfig`.
pub mod big_query_config {
/// Possible states for a BigQuery subscription.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Default value. This value is unused.
Unspecified = 0,
/// The subscription can actively send messages to BigQuery
Active = 1,
/// Cannot write to the BigQuery table because of permission denied errors.
/// This can happen if
/// - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
/// permissions](<https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account>)
/// - bigquery.googleapis.com API is not enabled for the project
/// ([instructions](<https://cloud.google.com/service-usage/docs/enable-disable>))
PermissionDenied = 2,
/// Cannot write to the BigQuery table because it does not exist.
NotFound = 3,
/// Cannot write to the BigQuery table due to a schema mismatch.
SchemaMismatch = 4,
/// Cannot write to the destination because enforce_in_transit is set to true
/// and the destination locations are not in the allowed regions.
InTransitLocationRestriction = 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::Active => "ACTIVE",
State::PermissionDenied => "PERMISSION_DENIED",
State::NotFound => "NOT_FOUND",
State::SchemaMismatch => "SCHEMA_MISMATCH",
State::InTransitLocationRestriction => "IN_TRANSIT_LOCATION_RESTRICTION",
}
}
/// 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),
"PERMISSION_DENIED" => Some(Self::PermissionDenied),
"NOT_FOUND" => Some(Self::NotFound),
"SCHEMA_MISMATCH" => Some(Self::SchemaMismatch),
"IN_TRANSIT_LOCATION_RESTRICTION" => {
Some(Self::InTransitLocationRestriction)
}
_ => None,
}
}
}
}
/// Configuration for a Cloud Storage subscription.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CloudStorageConfig {
/// Required. User-provided name for the Cloud Storage bucket.
/// The bucket must be created by the user. The bucket name must be without
/// any prefix like "gs://". See the [bucket naming
/// requirements] (<https://cloud.google.com/storage/docs/buckets#naming>).
#[prost(string, tag = "1")]
pub bucket: ::prost::alloc::string::String,
/// Optional. User-provided prefix for Cloud Storage filename. See the [object
/// naming requirements](<https://cloud.google.com/storage/docs/objects#naming>).
#[prost(string, tag = "2")]
pub filename_prefix: ::prost::alloc::string::String,
/// Optional. User-provided suffix for Cloud Storage filename. See the [object
/// naming requirements](<https://cloud.google.com/storage/docs/objects#naming>).
/// Must not end in "/".
#[prost(string, tag = "3")]
pub filename_suffix: ::prost::alloc::string::String,
/// Optional. User-provided format string specifying how to represent datetimes
/// in Cloud Storage filenames. See the [datetime format
/// guidance](<https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names>).
#[prost(string, tag = "10")]
pub filename_datetime_format: ::prost::alloc::string::String,
/// Optional. The maximum duration that can elapse before a new Cloud Storage
/// file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
/// exceed the subscription's acknowledgement deadline.
#[prost(message, optional, tag = "6")]
pub max_duration: ::core::option::Option<::prost_types::Duration>,
/// Optional. The maximum bytes that can be written to a Cloud Storage file
/// before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may
/// be exceeded in cases where messages are larger than the limit.
#[prost(int64, tag = "7")]
pub max_bytes: i64,
/// Optional. The maximum number of messages that can be written to a Cloud
/// Storage file before a new file is created. Min 1000 messages.
#[prost(int64, tag = "8")]
pub max_messages: i64,
/// Output only. An output-only field that indicates whether or not the
/// subscription can receive messages.
#[prost(enumeration = "cloud_storage_config::State", tag = "9")]
pub state: i32,
/// Optional. The service account to use to write to Cloud Storage. The
/// subscription creator or updater that specifies this field must have
/// `iam.serviceAccounts.actAs` permission on the service account. If not
/// specified, the Pub/Sub
/// [service agent](<https://cloud.google.com/iam/docs/service-agents>),
/// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
#[prost(string, tag = "11")]
pub service_account_email: ::prost::alloc::string::String,
/// Defaults to text format.
#[prost(oneof = "cloud_storage_config::OutputFormat", tags = "4, 5")]
pub output_format: ::core::option::Option<cloud_storage_config::OutputFormat>,
}
/// Nested message and enum types in `CloudStorageConfig`.
pub mod cloud_storage_config {
/// Configuration for writing message data in text format.
/// Message payloads will be written to files as raw text, separated by a
/// newline.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TextConfig {}
/// Configuration for writing message data in Avro format.
/// Message payloads and metadata will be written to files as an Avro binary.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AvroConfig {
/// Optional. When true, write the subscription name, message_id,
/// publish_time, attributes, and ordering_key as additional fields in the
/// output. The subscription name, message_id, and publish_time fields are
/// put in their own fields while all other message properties other than
/// data (for example, an ordering_key, if present) are added as entries in
/// the attributes map.
#[prost(bool, tag = "1")]
pub write_metadata: bool,
/// Optional. When true, the output Cloud Storage file will be serialized
/// using the topic schema, if it exists.
#[prost(bool, tag = "2")]
pub use_topic_schema: bool,
}
/// Possible states for a Cloud Storage subscription.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Default value. This value is unused.
Unspecified = 0,
/// The subscription can actively send messages to Cloud Storage.
Active = 1,
/// Cannot write to the Cloud Storage bucket because of permission denied
/// errors.
PermissionDenied = 2,
/// Cannot write to the Cloud Storage bucket because it does not exist.
NotFound = 3,
/// Cannot write to the destination because enforce_in_transit is set to true
/// and the destination locations are not in the allowed regions.
InTransitLocationRestriction = 4,
/// Cannot write to the Cloud Storage bucket due to an incompatibility
/// between the topic schema and subscription settings.
SchemaMismatch = 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::Active => "ACTIVE",
State::PermissionDenied => "PERMISSION_DENIED",
State::NotFound => "NOT_FOUND",
State::InTransitLocationRestriction => "IN_TRANSIT_LOCATION_RESTRICTION",
State::SchemaMismatch => "SCHEMA_MISMATCH",
}
}
/// 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),
"PERMISSION_DENIED" => Some(Self::PermissionDenied),
"NOT_FOUND" => Some(Self::NotFound),
"IN_TRANSIT_LOCATION_RESTRICTION" => {
Some(Self::InTransitLocationRestriction)
}
"SCHEMA_MISMATCH" => Some(Self::SchemaMismatch),
_ => None,
}
}
}
/// Defaults to text format.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum OutputFormat {
/// Optional. If set, message data will be written to Cloud Storage in text
/// format.
#[prost(message, tag = "4")]
TextConfig(TextConfig),
/// Optional. If set, message data will be written to Cloud Storage in Avro
/// format.
#[prost(message, tag = "5")]
AvroConfig(AvroConfig),
}
}
/// A message and its corresponding acknowledgment ID.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReceivedMessage {
/// Optional. This ID can be used to acknowledge the received message.
#[prost(string, tag = "1")]
pub ack_id: ::prost::alloc::string::String,
/// Optional. The message.
#[prost(message, optional, tag = "2")]
pub message: ::core::option::Option<PubsubMessage>,
/// Optional. The approximate number of times that Pub/Sub has attempted to
/// deliver the associated message to a subscriber.
///
/// More precisely, this is 1 + (number of NACKs) +
/// (number of ack_deadline exceeds) for this message.
///
/// A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
/// exceeds event is whenever a message is not acknowledged within
/// ack_deadline. Note that ack_deadline is initially
/// Subscription.ackDeadlineSeconds, but may get extended automatically by
/// the client library.
///
/// Upon the first delivery of a given message, `delivery_attempt` will have a
/// value of 1. The value is calculated at best effort and is approximate.
///
/// If a DeadLetterPolicy is not set on the subscription, this will be 0.
#[prost(int32, tag = "3")]
pub delivery_attempt: i32,
}
/// Request for the GetSubscription method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSubscriptionRequest {
/// Required. The name of the subscription to get.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
}
/// Request for the UpdateSubscription method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateSubscriptionRequest {
/// Required. The updated subscription object.
#[prost(message, optional, tag = "1")]
pub subscription: ::core::option::Option<Subscription>,
/// Required. Indicates which fields in the provided subscription to update.
/// Must be specified and non-empty.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request for the `ListSubscriptions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSubscriptionsRequest {
/// Required. The name of the project in which to list subscriptions.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub project: ::prost::alloc::string::String,
/// Optional. Maximum number of subscriptions to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. The value returned by the last `ListSubscriptionsResponse`;
/// indicates that this is a continuation of a prior `ListSubscriptions` call,
/// and that the system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListSubscriptions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSubscriptionsResponse {
/// Optional. The subscriptions that match the request.
#[prost(message, repeated, tag = "1")]
pub subscriptions: ::prost::alloc::vec::Vec<Subscription>,
/// Optional. If not empty, indicates that there may be more subscriptions that
/// match the request; this value should be passed in a new
/// `ListSubscriptionsRequest` to get more subscriptions.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the DeleteSubscription method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSubscriptionRequest {
/// Required. The subscription to delete.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
}
/// Request for the ModifyPushConfig method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyPushConfigRequest {
/// Required. The name of the subscription.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Required. The push configuration for future deliveries.
///
/// An empty `pushConfig` indicates that the Pub/Sub system should
/// stop pushing messages from the given subscription and allow
/// messages to be pulled and acknowledged - effectively pausing
/// the subscription if `Pull` or `StreamingPull` is not called.
#[prost(message, optional, tag = "2")]
pub push_config: ::core::option::Option<PushConfig>,
}
/// Request for the `Pull` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PullRequest {
/// Required. The subscription from which messages should be pulled.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Optional. If this field set to true, the system will respond immediately
/// even if it there are no messages available to return in the `Pull`
/// response. Otherwise, the system may wait (for a bounded amount of time)
/// until at least one message is available, rather than returning no messages.
/// Warning: setting this field to `true` is discouraged because it adversely
/// impacts the performance of `Pull` operations. We recommend that users do
/// not set this field.
#[deprecated]
#[prost(bool, tag = "2")]
pub return_immediately: bool,
/// Required. The maximum number of messages to return for this request. Must
/// be a positive integer. The Pub/Sub system may return fewer than the number
/// specified.
#[prost(int32, tag = "3")]
pub max_messages: i32,
}
/// Response for the `Pull` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PullResponse {
/// Optional. Received Pub/Sub messages. The list will be empty if there are no
/// more messages available in the backlog, or if no messages could be returned
/// before the request timeout. For JSON, the response can be entirely
/// empty. The Pub/Sub system may return fewer than the `maxMessages` requested
/// even if there are more messages available in the backlog.
#[prost(message, repeated, tag = "1")]
pub received_messages: ::prost::alloc::vec::Vec<ReceivedMessage>,
}
/// Request for the ModifyAckDeadline method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyAckDeadlineRequest {
/// Required. The name of the subscription.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Required. List of acknowledgment IDs.
#[prost(string, repeated, tag = "4")]
pub ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Required. The new ack deadline with respect to the time this request was
/// sent to the Pub/Sub system. For example, if the value is 10, the new ack
/// deadline will expire 10 seconds after the `ModifyAckDeadline` call was
/// made. Specifying zero might immediately make the message available for
/// delivery to another subscriber client. This typically results in an
/// increase in the rate of message redeliveries (that is, duplicates).
/// The minimum deadline you can specify is 0 seconds.
/// The maximum deadline you can specify in a single request is 600 seconds
/// (10 minutes).
#[prost(int32, tag = "3")]
pub ack_deadline_seconds: i32,
}
/// Request for the Acknowledge method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AcknowledgeRequest {
/// Required. The subscription whose message is being acknowledged.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Required. The acknowledgment ID for the messages being acknowledged that
/// was returned by the Pub/Sub system in the `Pull` response. Must not be
/// empty.
#[prost(string, repeated, tag = "2")]
pub ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request for the `StreamingPull` streaming RPC method. This request is used to
/// establish the initial stream as well as to stream acknowledgements and ack
/// deadline modifications from the client to the server.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingPullRequest {
/// Required. The subscription for which to initialize the new stream. This
/// must be provided in the first request on the stream, and must not be set in
/// subsequent requests from client to server.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Optional. List of acknowledgement IDs for acknowledging previously received
/// messages (received on this stream or a different stream). If an ack ID has
/// expired, the corresponding message may be redelivered later. Acknowledging
/// a message more than once will not result in an error. If the
/// acknowledgement ID is malformed, the stream will be aborted with status
/// `INVALID_ARGUMENT`.
#[prost(string, repeated, tag = "2")]
pub ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. The list of new ack deadlines for the IDs listed in
/// `modify_deadline_ack_ids`. The size of this list must be the same as the
/// size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
/// with `INVALID_ARGUMENT`. Each element in this list is applied to the
/// element in the same position in `modify_deadline_ack_ids`. The new ack
/// deadline is with respect to the time this request was sent to the Pub/Sub
/// system. Must be >= 0. For example, if the value is 10, the new ack deadline
/// will expire 10 seconds after this request is received. If the value is 0,
/// the message is immediately made available for another streaming or
/// non-streaming pull request. If the value is < 0 (an error), the stream will
/// be aborted with status `INVALID_ARGUMENT`.
#[prost(int32, repeated, packed = "false", tag = "3")]
pub modify_deadline_seconds: ::prost::alloc::vec::Vec<i32>,
/// Optional. List of acknowledgement IDs whose deadline will be modified based
/// on the corresponding element in `modify_deadline_seconds`. This field can
/// be used to indicate that more time is needed to process a message by the
/// subscriber, or to make the message available for redelivery if the
/// processing was interrupted.
#[prost(string, repeated, tag = "4")]
pub modify_deadline_ack_ids: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// Required. The ack deadline to use for the stream. This must be provided in
/// the first request on the stream, but it can also be updated on subsequent
/// requests from client to server. The minimum deadline you can specify is 10
/// seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
#[prost(int32, tag = "5")]
pub stream_ack_deadline_seconds: i32,
/// Optional. A unique identifier that is used to distinguish client instances
/// from each other. Only needs to be provided on the initial request. When a
/// stream disconnects and reconnects for the same stream, the client_id should
/// be set to the same value so that state associated with the old stream can
/// be transferred to the new stream. The same client_id should not be used for
/// different client instances.
#[prost(string, tag = "6")]
pub client_id: ::prost::alloc::string::String,
/// Optional. Flow control settings for the maximum number of outstanding
/// messages. When there are `max_outstanding_messages` currently sent to the
/// streaming pull client that have not yet been acked or nacked, the server
/// stops sending more messages. The sending of messages resumes once the
/// number of outstanding messages is less than this value. If the value is
/// <= 0, there is no limit to the number of outstanding messages. This
/// property can only be set on the initial StreamingPullRequest. If it is set
/// on a subsequent request, the stream will be aborted with status
/// `INVALID_ARGUMENT`.
#[prost(int64, tag = "7")]
pub max_outstanding_messages: i64,
/// Optional. Flow control settings for the maximum number of outstanding
/// bytes. When there are `max_outstanding_bytes` or more worth of messages
/// currently sent to the streaming pull client that have not yet been acked or
/// nacked, the server will stop sending more messages. The sending of messages
/// resumes once the number of outstanding bytes is less than this value. If
/// the value is <= 0, there is no limit to the number of outstanding bytes.
/// This property can only be set on the initial StreamingPullRequest. If it is
/// set on a subsequent request, the stream will be aborted with status
/// `INVALID_ARGUMENT`.
#[prost(int64, tag = "8")]
pub max_outstanding_bytes: i64,
}
/// Response for the `StreamingPull` method. This response is used to stream
/// messages from the server to the client.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingPullResponse {
/// Optional. Received Pub/Sub messages. This will not be empty.
#[prost(message, repeated, tag = "1")]
pub received_messages: ::prost::alloc::vec::Vec<ReceivedMessage>,
/// Optional. This field will only be set if `enable_exactly_once_delivery` is
/// set to `true`.
#[prost(message, optional, tag = "5")]
pub acknowledge_confirmation: ::core::option::Option<
streaming_pull_response::AcknowledgeConfirmation,
>,
/// Optional. This field will only be set if `enable_exactly_once_delivery` is
/// set to `true`.
#[prost(message, optional, tag = "3")]
pub modify_ack_deadline_confirmation: ::core::option::Option<
streaming_pull_response::ModifyAckDeadlineConfirmation,
>,
/// Optional. Properties associated with this subscription.
#[prost(message, optional, tag = "4")]
pub subscription_properties: ::core::option::Option<
streaming_pull_response::SubscriptionProperties,
>,
}
/// Nested message and enum types in `StreamingPullResponse`.
pub mod streaming_pull_response {
/// Acknowledgement IDs sent in one or more previous requests to acknowledge a
/// previously received message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AcknowledgeConfirmation {
/// Optional. Successfully processed acknowledgement IDs.
#[prost(string, repeated, tag = "1")]
pub ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. List of acknowledgement IDs that were malformed or whose
/// acknowledgement deadline has expired.
#[prost(string, repeated, tag = "2")]
pub invalid_ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. List of acknowledgement IDs that were out of order.
#[prost(string, repeated, tag = "3")]
pub unordered_ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. List of acknowledgement IDs that failed processing with
/// temporary issues.
#[prost(string, repeated, tag = "4")]
pub temporary_failed_ack_ids: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
/// Acknowledgement IDs sent in one or more previous requests to modify the
/// deadline for a specific message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyAckDeadlineConfirmation {
/// Optional. Successfully processed acknowledgement IDs.
#[prost(string, repeated, tag = "1")]
pub ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. List of acknowledgement IDs that were malformed or whose
/// acknowledgement deadline has expired.
#[prost(string, repeated, tag = "2")]
pub invalid_ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional. List of acknowledgement IDs that failed processing with
/// temporary issues.
#[prost(string, repeated, tag = "3")]
pub temporary_failed_ack_ids: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
/// Subscription properties sent as part of the response.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SubscriptionProperties {
/// Optional. True iff exactly once delivery is enabled for this
/// subscription.
#[prost(bool, tag = "1")]
pub exactly_once_delivery_enabled: bool,
/// Optional. True iff message ordering is enabled for this subscription.
#[prost(bool, tag = "2")]
pub message_ordering_enabled: bool,
}
}
/// Request for the `CreateSnapshot` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSnapshotRequest {
/// Required. User-provided name for this snapshot. If the name is not provided
/// in the request, the server will assign a random name for this snapshot on
/// the same project as the subscription. Note that for REST API requests, you
/// must specify a name. See the [resource name
/// rules](<https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names>).
/// Format is `projects/{project}/snapshots/{snap}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The subscription whose backlog the snapshot retains.
/// Specifically, the created snapshot is guaranteed to retain:
/// (a) The existing backlog on the subscription. More precisely, this is
/// defined as the messages in the subscription's backlog that are
/// unacknowledged upon the successful completion of the
/// `CreateSnapshot` request; as well as:
/// (b) Any messages published to the subscription's topic following the
/// successful completion of the CreateSnapshot request.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "2")]
pub subscription: ::prost::alloc::string::String,
/// Optional. See [Creating and managing
/// labels](<https://cloud.google.com/pubsub/docs/labels>).
#[prost(btree_map = "string, string", tag = "3")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
}
/// Request for the UpdateSnapshot method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateSnapshotRequest {
/// Required. The updated snapshot object.
#[prost(message, optional, tag = "1")]
pub snapshot: ::core::option::Option<Snapshot>,
/// Required. Indicates which fields in the provided snapshot to update.
/// Must be specified and non-empty.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// A snapshot resource. Snapshots are used in
/// [Seek](<https://cloud.google.com/pubsub/docs/replay-overview>)
/// operations, which allow you to manage message acknowledgments in bulk. That
/// is, you can set the acknowledgment state of messages in an existing
/// subscription to the state captured by a snapshot.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Snapshot {
/// Optional. The name of the snapshot.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The name of the topic from which this snapshot is retaining
/// messages.
#[prost(string, tag = "2")]
pub topic: ::prost::alloc::string::String,
/// Optional. The snapshot is guaranteed to exist up until this time.
/// A newly-created snapshot expires no later than 7 days from the time of its
/// creation. Its exact lifetime is determined at creation by the existing
/// backlog in the source subscription. Specifically, the lifetime of the
/// snapshot is `7 days - (age of oldest unacked message in the subscription)`.
/// For example, consider a subscription whose oldest unacked message is 3 days
/// old. If a snapshot is created from this subscription, the snapshot -- which
/// will always capture this 3-day-old backlog as long as the snapshot
/// exists -- will expire in 4 days. The service will refuse to create a
/// snapshot that would expire in less than 1 hour after creation.
#[prost(message, optional, tag = "3")]
pub expire_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. See \[Creating and managing labels\]
/// (<https://cloud.google.com/pubsub/docs/labels>).
#[prost(btree_map = "string, string", tag = "4")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
}
/// Request for the GetSnapshot method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSnapshotRequest {
/// Required. The name of the snapshot to get.
/// Format is `projects/{project}/snapshots/{snap}`.
#[prost(string, tag = "1")]
pub snapshot: ::prost::alloc::string::String,
}
/// Request for the `ListSnapshots` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSnapshotsRequest {
/// Required. The name of the project in which to list snapshots.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub project: ::prost::alloc::string::String,
/// Optional. Maximum number of snapshots to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. The value returned by the last `ListSnapshotsResponse`; indicates
/// that this is a continuation of a prior `ListSnapshots` call, and that the
/// system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListSnapshots` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSnapshotsResponse {
/// Optional. The resulting snapshots.
#[prost(message, repeated, tag = "1")]
pub snapshots: ::prost::alloc::vec::Vec<Snapshot>,
/// Optional. If not empty, indicates that there may be more snapshot that
/// match the request; this value should be passed in a new
/// `ListSnapshotsRequest`.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `DeleteSnapshot` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSnapshotRequest {
/// Required. The name of the snapshot to delete.
/// Format is `projects/{project}/snapshots/{snap}`.
#[prost(string, tag = "1")]
pub snapshot: ::prost::alloc::string::String,
}
/// Request for the `Seek` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SeekRequest {
/// Required. The subscription to affect.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
#[prost(oneof = "seek_request::Target", tags = "2, 3")]
pub target: ::core::option::Option<seek_request::Target>,
}
/// Nested message and enum types in `SeekRequest`.
pub mod seek_request {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Target {
/// Optional. The time to seek to.
/// Messages retained in the subscription that were published before this
/// time are marked as acknowledged, and messages retained in the
/// subscription that were published after this time are marked as
/// unacknowledged. Note that this operation affects only those messages
/// retained in the subscription (configured by the combination of
/// `message_retention_duration` and `retain_acked_messages`). For example,
/// if `time` corresponds to a point before the message retention
/// window (or to a point before the system's notion of the subscription
/// creation time), only retained messages will be marked as unacknowledged,
/// and already-expunged messages will not be restored.
#[prost(message, tag = "2")]
Time(::prost_types::Timestamp),
/// Optional. The snapshot to seek to. The snapshot's topic must be the same
/// as that of the provided subscription. Format is
/// `projects/{project}/snapshots/{snap}`.
#[prost(string, tag = "3")]
Snapshot(::prost::alloc::string::String),
}
}
/// Response for the `Seek` method (this response is empty).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SeekResponse {}
/// Generated client implementations.
pub mod publisher_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The service that an application uses to manipulate topics, and to send
/// messages to a topic.
#[derive(Debug, Clone)]
pub struct PublisherClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> PublisherClient<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,
) -> PublisherClient<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,
{
PublisherClient::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 the given topic with the given name. See the [resource name rules]
/// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
pub async fn create_topic(
&mut self,
request: impl tonic::IntoRequest<super::Topic>,
) -> std::result::Result<tonic::Response<super::Topic>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/CreateTopic",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Publisher", "CreateTopic"));
self.inner.unary(req, path, codec).await
}
/// Updates an existing topic by updating the fields specified in the update
/// mask. Note that certain properties of a topic are not modifiable.
pub async fn update_topic(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTopicRequest>,
) -> std::result::Result<tonic::Response<super::Topic>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/UpdateTopic",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Publisher", "UpdateTopic"));
self.inner.unary(req, path, codec).await
}
/// Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
/// does not exist.
pub async fn publish(
&mut self,
request: impl tonic::IntoRequest<super::PublishRequest>,
) -> std::result::Result<
tonic::Response<super::PublishResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/Publish",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Publisher", "Publish"));
self.inner.unary(req, path, codec).await
}
/// Gets the configuration of a topic.
pub async fn get_topic(
&mut self,
request: impl tonic::IntoRequest<super::GetTopicRequest>,
) -> std::result::Result<tonic::Response<super::Topic>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/GetTopic",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Publisher", "GetTopic"));
self.inner.unary(req, path, codec).await
}
/// Lists matching topics.
pub async fn list_topics(
&mut self,
request: impl tonic::IntoRequest<super::ListTopicsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTopicsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/ListTopics",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Publisher", "ListTopics"));
self.inner.unary(req, path, codec).await
}
/// Lists the names of the attached subscriptions on this topic.
pub async fn list_topic_subscriptions(
&mut self,
request: impl tonic::IntoRequest<super::ListTopicSubscriptionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTopicSubscriptionsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/ListTopicSubscriptions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.pubsub.v1.Publisher",
"ListTopicSubscriptions",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists the names of the snapshots on this topic. Snapshots are used in
/// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
/// which allow you to manage message acknowledgments in bulk. That is, you can
/// set the acknowledgment state of messages in an existing subscription to the
/// state captured by a snapshot.
pub async fn list_topic_snapshots(
&mut self,
request: impl tonic::IntoRequest<super::ListTopicSnapshotsRequest>,
) -> std::result::Result<
tonic::Response<super::ListTopicSnapshotsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/ListTopicSnapshots",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Publisher", "ListTopicSnapshots"),
);
self.inner.unary(req, path, codec).await
}
/// Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
/// does not exist. After a topic is deleted, a new topic may be created with
/// the same name; this is an entirely new topic with none of the old
/// configuration or subscriptions. Existing subscriptions to this topic are
/// not deleted, but their `topic` field is set to `_deleted-topic_`.
pub async fn delete_topic(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTopicRequest>,
) -> 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.pubsub.v1.Publisher/DeleteTopic",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Publisher", "DeleteTopic"));
self.inner.unary(req, path, codec).await
}
/// Detaches a subscription from this topic. All messages retained in the
/// subscription are dropped. Subsequent `Pull` and `StreamingPull` requests
/// will return FAILED_PRECONDITION. If the subscription is a push
/// subscription, pushes to the endpoint will stop.
pub async fn detach_subscription(
&mut self,
request: impl tonic::IntoRequest<super::DetachSubscriptionRequest>,
) -> std::result::Result<
tonic::Response<super::DetachSubscriptionResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/DetachSubscription",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Publisher", "DetachSubscription"),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Generated client implementations.
pub mod subscriber_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The service that an application uses to manipulate subscriptions and to
/// consume messages from a subscription via the `Pull` method or by
/// establishing a bi-directional stream using the `StreamingPull` method.
#[derive(Debug, Clone)]
pub struct SubscriberClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> SubscriberClient<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,
) -> SubscriberClient<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,
{
SubscriberClient::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 subscription to a given topic. See the [resource name rules]
/// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
/// If the subscription already exists, returns `ALREADY_EXISTS`.
/// If the corresponding topic doesn't exist, returns `NOT_FOUND`.
///
/// If the name is not provided in the request, the server will assign a random
/// name for this subscription on the same project as the topic, conforming
/// to the [resource name format]
/// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
/// generated name is populated in the returned Subscription object. Note that
/// for REST API requests, you must specify a name in the request.
pub async fn create_subscription(
&mut self,
request: impl tonic::IntoRequest<super::Subscription>,
) -> std::result::Result<tonic::Response<super::Subscription>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/CreateSubscription",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "CreateSubscription"),
);
self.inner.unary(req, path, codec).await
}
/// Gets the configuration details of a subscription.
pub async fn get_subscription(
&mut self,
request: impl tonic::IntoRequest<super::GetSubscriptionRequest>,
) -> std::result::Result<tonic::Response<super::Subscription>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/GetSubscription",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "GetSubscription"),
);
self.inner.unary(req, path, codec).await
}
/// Updates an existing subscription by updating the fields specified in the
/// update mask. Note that certain properties of a subscription, such as its
/// topic, are not modifiable.
pub async fn update_subscription(
&mut self,
request: impl tonic::IntoRequest<super::UpdateSubscriptionRequest>,
) -> std::result::Result<tonic::Response<super::Subscription>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/UpdateSubscription",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "UpdateSubscription"),
);
self.inner.unary(req, path, codec).await
}
/// Lists matching subscriptions.
pub async fn list_subscriptions(
&mut self,
request: impl tonic::IntoRequest<super::ListSubscriptionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListSubscriptionsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/ListSubscriptions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "ListSubscriptions"),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an existing subscription. All messages retained in the subscription
/// are immediately dropped. Calls to `Pull` after deletion will return
/// `NOT_FOUND`. After a subscription is deleted, a new one may be created with
/// the same name, but the new one has no association with the old
/// subscription or its topic unless the same topic is specified.
pub async fn delete_subscription(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSubscriptionRequest>,
) -> 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.pubsub.v1.Subscriber/DeleteSubscription",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "DeleteSubscription"),
);
self.inner.unary(req, path, codec).await
}
/// Modifies the ack deadline for a specific message. This method is useful
/// to indicate that more time is needed to process a message by the
/// subscriber, or to make the message available for redelivery if the
/// processing was interrupted. Note that this does not modify the
/// subscription-level `ackDeadlineSeconds` used for subsequent messages.
pub async fn modify_ack_deadline(
&mut self,
request: impl tonic::IntoRequest<super::ModifyAckDeadlineRequest>,
) -> 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.pubsub.v1.Subscriber/ModifyAckDeadline",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "ModifyAckDeadline"),
);
self.inner.unary(req, path, codec).await
}
/// Acknowledges the messages associated with the `ack_ids` in the
/// `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
/// from the subscription.
///
/// Acknowledging a message whose ack deadline has expired may succeed,
/// but such a message may be redelivered later. Acknowledging a message more
/// than once will not result in an error.
pub async fn acknowledge(
&mut self,
request: impl tonic::IntoRequest<super::AcknowledgeRequest>,
) -> 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.pubsub.v1.Subscriber/Acknowledge",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Subscriber", "Acknowledge"));
self.inner.unary(req, path, codec).await
}
/// Pulls messages from the server.
pub async fn pull(
&mut self,
request: impl tonic::IntoRequest<super::PullRequest>,
) -> std::result::Result<tonic::Response<super::PullResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/Pull",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Subscriber", "Pull"));
self.inner.unary(req, path, codec).await
}
/// Establishes a stream with the server, which sends messages down to the
/// client. The client streams acknowledgements and ack deadline modifications
/// back to the server. The server will close the stream and return the status
/// on any error. The server may close the stream with status `UNAVAILABLE` to
/// reassign server-side resources, in which case, the client should
/// re-establish the stream. Flow control can be achieved by configuring the
/// underlying RPC channel.
pub async fn streaming_pull(
&mut self,
request: impl tonic::IntoStreamingRequest<
Message = super::StreamingPullRequest,
>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::StreamingPullResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/StreamingPull",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Subscriber", "StreamingPull"));
self.inner.streaming(req, path, codec).await
}
/// Modifies the `PushConfig` for a specified subscription.
///
/// This may be used to change a push subscription to a pull one (signified by
/// an empty `PushConfig`) or vice versa, or change the endpoint URL and other
/// attributes of a push subscription. Messages will accumulate for delivery
/// continuously through the call regardless of changes to the `PushConfig`.
pub async fn modify_push_config(
&mut self,
request: impl tonic::IntoRequest<super::ModifyPushConfigRequest>,
) -> 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.pubsub.v1.Subscriber/ModifyPushConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "ModifyPushConfig"),
);
self.inner.unary(req, path, codec).await
}
/// Gets the configuration details of a snapshot. Snapshots are used in
/// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
/// which allow you to manage message acknowledgments in bulk. That is, you can
/// set the acknowledgment state of messages in an existing subscription to the
/// state captured by a snapshot.
pub async fn get_snapshot(
&mut self,
request: impl tonic::IntoRequest<super::GetSnapshotRequest>,
) -> std::result::Result<tonic::Response<super::Snapshot>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/GetSnapshot",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Subscriber", "GetSnapshot"));
self.inner.unary(req, path, codec).await
}
/// Lists the existing snapshots. Snapshots are used in [Seek](
/// https://cloud.google.com/pubsub/docs/replay-overview) operations, which
/// allow you to manage message acknowledgments in bulk. That is, you can set
/// the acknowledgment state of messages in an existing subscription to the
/// state captured by a snapshot.
pub async fn list_snapshots(
&mut self,
request: impl tonic::IntoRequest<super::ListSnapshotsRequest>,
) -> std::result::Result<
tonic::Response<super::ListSnapshotsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/ListSnapshots",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Subscriber", "ListSnapshots"));
self.inner.unary(req, path, codec).await
}
/// Creates a snapshot from the requested subscription. Snapshots are used in
/// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
/// which allow you to manage message acknowledgments in bulk. That is, you can
/// set the acknowledgment state of messages in an existing subscription to the
/// state captured by a snapshot.
/// If the snapshot already exists, returns `ALREADY_EXISTS`.
/// If the requested subscription doesn't exist, returns `NOT_FOUND`.
/// If the backlog in the subscription is too old -- and the resulting snapshot
/// would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.
/// See also the `Snapshot.expire_time` field. If the name is not provided in
/// the request, the server will assign a random
/// name for this snapshot on the same project as the subscription, conforming
/// to the [resource name format]
/// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
/// generated name is populated in the returned Snapshot object. Note that for
/// REST API requests, you must specify a name in the request.
pub async fn create_snapshot(
&mut self,
request: impl tonic::IntoRequest<super::CreateSnapshotRequest>,
) -> std::result::Result<tonic::Response<super::Snapshot>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/CreateSnapshot",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "CreateSnapshot"),
);
self.inner.unary(req, path, codec).await
}
/// Updates an existing snapshot by updating the fields specified in the update
/// mask. Snapshots are used in
/// [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
/// which allow you to manage message acknowledgments in bulk. That is, you can
/// set the acknowledgment state of messages in an existing subscription to the
/// state captured by a snapshot.
pub async fn update_snapshot(
&mut self,
request: impl tonic::IntoRequest<super::UpdateSnapshotRequest>,
) -> std::result::Result<tonic::Response<super::Snapshot>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/UpdateSnapshot",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "UpdateSnapshot"),
);
self.inner.unary(req, path, codec).await
}
/// Removes an existing snapshot. Snapshots are used in [Seek]
/// (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
/// allow you to manage message acknowledgments in bulk. That is, you can set
/// the acknowledgment state of messages in an existing subscription to the
/// state captured by a snapshot.
/// When the snapshot is deleted, all messages retained in the snapshot
/// are immediately dropped. After a snapshot is deleted, a new one may be
/// created with the same name, but the new one has no association with the old
/// snapshot or its subscription, unless the same subscription is specified.
pub async fn delete_snapshot(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSnapshotRequest>,
) -> 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.pubsub.v1.Subscriber/DeleteSnapshot",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.pubsub.v1.Subscriber", "DeleteSnapshot"),
);
self.inner.unary(req, path, codec).await
}
/// Seeks an existing subscription to a point in time or to a given snapshot,
/// whichever is provided in the request. Snapshots are used in [Seek]
/// (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
/// allow you to manage message acknowledgments in bulk. That is, you can set
/// the acknowledgment state of messages in an existing subscription to the
/// state captured by a snapshot. Note that both the subscription and the
/// snapshot must be on the same topic.
pub async fn seek(
&mut self,
request: impl tonic::IntoRequest<super::SeekRequest>,
) -> std::result::Result<tonic::Response<super::SeekResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/Seek",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.pubsub.v1.Subscriber", "Seek"));
self.inner.unary(req, path, codec).await
}
}
}