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
// This file is @generated by prost-build.
/// Response metadata proto
/// This is an experimental feature that will be used to get zone_id and
/// cluster_id from response trailers to tag the metrics. This should not be
/// used by customers directly
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResponseParams {
/// The cloud bigtable zone associated with the cluster.
#[prost(string, optional, tag = "1")]
pub zone_id: ::core::option::Option<::prost::alloc::string::String>,
/// Identifier for a cluster that represents set of
/// bigtable resources.
#[prost(string, optional, tag = "2")]
pub cluster_id: ::core::option::Option<::prost::alloc::string::String>,
}
/// ReadIterationStats captures information about the iteration of rows or cells
/// over the course of a read, e.g. how many results were scanned in a read
/// operation versus the results returned.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ReadIterationStats {
/// The rows seen (scanned) as part of the request. This includes the count of
/// rows returned, as captured below.
#[prost(int64, tag = "1")]
pub rows_seen_count: i64,
/// The rows returned as part of the request.
#[prost(int64, tag = "2")]
pub rows_returned_count: i64,
/// The cells seen (scanned) as part of the request. This includes the count of
/// cells returned, as captured below.
#[prost(int64, tag = "3")]
pub cells_seen_count: i64,
/// The cells returned as part of the request.
#[prost(int64, tag = "4")]
pub cells_returned_count: i64,
}
/// RequestLatencyStats provides a measurement of the latency of the request as
/// it interacts with different systems over its lifetime, e.g. how long the
/// request took to execute within a frontend server.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RequestLatencyStats {
/// The latency measured by the frontend server handling this request, from
/// when the request was received, to when this value is sent back in the
/// response. For more context on the component that is measuring this latency,
/// see: <https://cloud.google.com/bigtable/docs/overview>
///
/// Note: This value may be slightly shorter than the value reported into
/// aggregate latency metrics in Monitoring for this request
/// (<https://cloud.google.com/bigtable/docs/monitoring-instance>) as this value
/// needs to be sent in the response before the latency measurement including
/// that transmission is finalized.
///
/// Note: This value includes the end-to-end latency of contacting nodes in
/// the targeted cluster, e.g. measuring from when the first byte arrives at
/// the frontend server, to when this value is sent back as the last value in
/// the response, including any latency incurred by contacting nodes, waiting
/// for results from nodes, and finally sending results from nodes back to the
/// caller.
#[prost(message, optional, tag = "1")]
pub frontend_server_latency: ::core::option::Option<::prost_types::Duration>,
}
/// FullReadStatsView captures all known information about a read.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FullReadStatsView {
/// Iteration stats describe how efficient the read is, e.g. comparing
/// rows seen vs. rows returned or cells seen vs cells returned can provide an
/// indication of read efficiency (the higher the ratio of seen to retuned the
/// better).
#[prost(message, optional, tag = "1")]
pub read_iteration_stats: ::core::option::Option<ReadIterationStats>,
/// Request latency stats describe the time taken to complete a request, from
/// the server side.
#[prost(message, optional, tag = "2")]
pub request_latency_stats: ::core::option::Option<RequestLatencyStats>,
}
/// RequestStats is the container for additional information pertaining to a
/// single request, helpful for evaluating the performance of the sent request.
/// Currently, there are the following supported methods:
/// * google.bigtable.v2.ReadRows
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RequestStats {
/// Information pertaining to each request type received. The type is chosen
/// based on the requested view.
///
/// See the messages above for additional context.
#[prost(oneof = "request_stats::StatsView", tags = "1")]
pub stats_view: ::core::option::Option<request_stats::StatsView>,
}
/// Nested message and enum types in `RequestStats`.
pub mod request_stats {
/// Information pertaining to each request type received. The type is chosen
/// based on the requested view.
///
/// See the messages above for additional context.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum StatsView {
/// Available with the ReadRowsRequest.RequestStatsView.REQUEST_STATS_FULL
/// view, see package google.bigtable.v2.
#[prost(message, tag = "1")]
FullReadStatsView(super::FullReadStatsView),
}
}
/// `Type` represents the type of data that is written to, read from, or stored
/// in Bigtable. It is heavily based on the GoogleSQL standard to help maintain
/// familiarity and consistency across products and features.
///
/// For compatibility with Bigtable's existing untyped APIs, each `Type` includes
/// an `Encoding` which describes how to convert to/from the underlying data.
///
/// Each encoding also defines the following properties:
///
/// * Order-preserving: Does the encoded value sort consistently with the
/// original typed value? Note that Bigtable will always sort data based on
/// the raw encoded value, *not* the decoded type.
/// - Example: BYTES values sort in the same order as their raw encodings.
/// - Counterexample: Encoding INT64 as a fixed-width decimal string does
/// *not* preserve sort order when dealing with negative numbers.
/// `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`.
/// * Self-delimiting: If we concatenate two encoded values, can we always tell
/// where the first one ends and the second one begins?
/// - Example: If we encode INT64s to fixed-width STRINGs, the first value
/// will always contain exactly N digits, possibly preceded by a sign.
/// - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have
/// no way to tell where the first one ends.
/// * Compatibility: Which other systems have matching encoding schemes? For
/// example, does this encoding have a GoogleSQL equivalent? HBase? Java?
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Type {
/// The kind of type that this represents.
#[prost(oneof = "r#type::Kind", tags = "1, 2, 5, 12, 9, 8, 10, 11, 6, 7, 3, 4")]
pub kind: ::core::option::Option<r#type::Kind>,
}
/// Nested message and enum types in `Type`.
pub mod r#type {
/// Bytes
/// Values of type `Bytes` are stored in `Value.bytes_value`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Bytes {
/// The encoding to use when converting to/from lower level types.
#[prost(message, optional, tag = "1")]
pub encoding: ::core::option::Option<bytes::Encoding>,
}
/// Nested message and enum types in `Bytes`.
pub mod bytes {
/// Rules used to convert to/from lower level types.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Encoding {
/// Which encoding to use.
#[prost(oneof = "encoding::Encoding", tags = "1")]
pub encoding: ::core::option::Option<encoding::Encoding>,
}
/// Nested message and enum types in `Encoding`.
pub mod encoding {
/// Leaves the value "as-is"
/// * Order-preserving? Yes
/// * Self-delimiting? No
/// * Compatibility? N/A
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Raw {}
/// Which encoding to use.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Encoding {
/// Use `Raw` encoding.
#[prost(message, tag = "1")]
Raw(Raw),
}
}
}
/// String
/// Values of type `String` are stored in `Value.string_value`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct String {
/// The encoding to use when converting to/from lower level types.
#[prost(message, optional, tag = "1")]
pub encoding: ::core::option::Option<string::Encoding>,
}
/// Nested message and enum types in `String`.
pub mod string {
/// Rules used to convert to/from lower level types.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Encoding {
/// Which encoding to use.
#[prost(oneof = "encoding::Encoding", tags = "1, 2")]
pub encoding: ::core::option::Option<encoding::Encoding>,
}
/// Nested message and enum types in `Encoding`.
pub mod encoding {
/// Deprecated: prefer the equivalent `Utf8Bytes`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Utf8Raw {}
/// UTF-8 encoding
/// * Order-preserving? Yes (code point order)
/// * Self-delimiting? No
/// * Compatibility?
/// - BigQuery Federation `TEXT` encoding
/// - HBase `Bytes.toBytes`
/// - Java `String#getBytes(StandardCharsets.UTF_8)`
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Utf8Bytes {}
/// Which encoding to use.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Encoding {
/// Deprecated: if set, converts to an empty `utf8_bytes`.
#[prost(message, tag = "1")]
Utf8Raw(Utf8Raw),
/// Use `Utf8Bytes` encoding.
#[prost(message, tag = "2")]
Utf8Bytes(Utf8Bytes),
}
}
}
/// Int64
/// Values of type `Int64` are stored in `Value.int_value`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Int64 {
/// The encoding to use when converting to/from lower level types.
#[prost(message, optional, tag = "1")]
pub encoding: ::core::option::Option<int64::Encoding>,
}
/// Nested message and enum types in `Int64`.
pub mod int64 {
/// Rules used to convert to/from lower level types.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Encoding {
/// Which encoding to use.
#[prost(oneof = "encoding::Encoding", tags = "1")]
pub encoding: ::core::option::Option<encoding::Encoding>,
}
/// Nested message and enum types in `Encoding`.
pub mod encoding {
/// Encodes the value as an 8-byte big endian twos complement `Bytes`
/// value.
/// * Order-preserving? No (positive values only)
/// * Self-delimiting? Yes
/// * Compatibility?
/// - BigQuery Federation `BINARY` encoding
/// - HBase `Bytes.toBytes`
/// - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BigEndianBytes {
/// Deprecated: ignored if set.
#[prost(message, optional, tag = "1")]
pub bytes_type: ::core::option::Option<super::super::Bytes>,
}
/// Which encoding to use.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Encoding {
/// Use `BigEndianBytes` encoding.
#[prost(message, tag = "1")]
BigEndianBytes(BigEndianBytes),
}
}
}
/// bool
/// Values of type `Bool` are stored in `Value.bool_value`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Bool {}
/// Float32
/// Values of type `Float32` are stored in `Value.float_value`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Float32 {}
/// Float64
/// Values of type `Float64` are stored in `Value.float_value`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Float64 {}
/// Timestamp
/// Values of type `Timestamp` are stored in `Value.timestamp_value`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Timestamp {}
/// Date
/// Values of type `Date` are stored in `Value.date_value`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Date {}
/// A structured data value, consisting of fields which map to dynamically
/// typed values.
/// Values of type `Struct` are stored in `Value.array_value` where entries are
/// in the same order and number as `field_types`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Struct {
/// The names and types of the fields in this struct.
#[prost(message, repeated, tag = "1")]
pub fields: ::prost::alloc::vec::Vec<r#struct::Field>,
}
/// Nested message and enum types in `Struct`.
pub mod r#struct {
/// A struct field and its type.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Field {
/// The field name (optional). Fields without a `field_name` are considered
/// anonymous and cannot be referenced by name.
#[prost(string, tag = "1")]
pub field_name: ::prost::alloc::string::String,
/// The type of values in this field.
#[prost(message, optional, tag = "2")]
pub r#type: ::core::option::Option<super::super::Type>,
}
}
/// An ordered list of elements of a given type.
/// Values of type `Array` are stored in `Value.array_value`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Array {
/// The type of the elements in the array. This must not be `Array`.
#[prost(message, optional, boxed, tag = "1")]
pub element_type: ::core::option::Option<
::prost::alloc::boxed::Box<super::Type>,
>,
}
/// A mapping of keys to values of a given type.
/// Values of type `Map` are stored in a `Value.array_value` where each entry
/// is another `Value.array_value` with two elements (the key and the value,
/// in that order).
/// Normally encoded Map values won't have repeated keys, however, clients are
/// expected to handle the case in which they do. If the same key appears
/// multiple times, the _last_ value takes precedence.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Map {
/// The type of a map key.
/// Only `Bytes`, `String`, and `Int64` are allowed as key types.
#[prost(message, optional, boxed, tag = "1")]
pub key_type: ::core::option::Option<::prost::alloc::boxed::Box<super::Type>>,
/// The type of the values in a map.
#[prost(message, optional, boxed, tag = "2")]
pub value_type: ::core::option::Option<::prost::alloc::boxed::Box<super::Type>>,
}
/// A value that combines incremental updates into a summarized value.
///
/// Data is never directly written or read using type `Aggregate`. Writes will
/// provide either the `input_type` or `state_type`, and reads will always
/// return the `state_type` .
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Aggregate {
/// Type of the inputs that are accumulated by this `Aggregate`, which must
/// specify a full encoding.
/// Use `AddInput` mutations to accumulate new inputs.
#[prost(message, optional, boxed, tag = "1")]
pub input_type: ::core::option::Option<::prost::alloc::boxed::Box<super::Type>>,
/// Output only. Type that holds the internal accumulator state for the
/// `Aggregate`. This is a function of the `input_type` and `aggregator`
/// chosen, and will always specify a full encoding.
#[prost(message, optional, boxed, tag = "2")]
pub state_type: ::core::option::Option<::prost::alloc::boxed::Box<super::Type>>,
/// Which aggregator function to use. The configured types must match.
#[prost(oneof = "aggregate::Aggregator", tags = "4, 5, 6, 7")]
pub aggregator: ::core::option::Option<aggregate::Aggregator>,
}
/// Nested message and enum types in `Aggregate`.
pub mod aggregate {
/// Computes the sum of the input values.
/// Allowed input: `Int64`
/// State: same as input
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Sum {}
/// Computes the max of the input values.
/// Allowed input: `Int64`
/// State: same as input
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Max {}
/// Computes the min of the input values.
/// Allowed input: `Int64`
/// State: same as input
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Min {}
/// Computes an approximate unique count over the input values. When using
/// raw data as input, be careful to use a consistent encoding. Otherwise
/// the same value encoded differently could count more than once, or two
/// distinct values could count as identical.
/// Input: Any, or omit for Raw
/// State: TBD
/// Special state conversions: `Int64` (the unique count estimate)
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct HyperLogLogPlusPlusUniqueCount {}
/// Which aggregator function to use. The configured types must match.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum Aggregator {
/// Sum aggregator.
#[prost(message, tag = "4")]
Sum(Sum),
/// HyperLogLogPlusPlusUniqueCount aggregator.
#[prost(message, tag = "5")]
HllppUniqueCount(HyperLogLogPlusPlusUniqueCount),
/// Max aggregator.
#[prost(message, tag = "6")]
Max(Max),
/// Min aggregator.
#[prost(message, tag = "7")]
Min(Min),
}
}
/// The kind of type that this represents.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
/// Bytes
#[prost(message, tag = "1")]
BytesType(Bytes),
/// String
#[prost(message, tag = "2")]
StringType(String),
/// Int64
#[prost(message, tag = "5")]
Int64Type(Int64),
/// Float32
#[prost(message, tag = "12")]
Float32Type(Float32),
/// Float64
#[prost(message, tag = "9")]
Float64Type(Float64),
/// Bool
#[prost(message, tag = "8")]
BoolType(Bool),
/// Timestamp
#[prost(message, tag = "10")]
TimestampType(Timestamp),
/// Date
#[prost(message, tag = "11")]
DateType(Date),
/// Aggregate
#[prost(message, tag = "6")]
AggregateType(::prost::alloc::boxed::Box<Aggregate>),
/// Struct
#[prost(message, tag = "7")]
StructType(Struct),
/// Array
#[prost(message, tag = "3")]
ArrayType(::prost::alloc::boxed::Box<Array>),
/// Map
#[prost(message, tag = "4")]
MapType(::prost::alloc::boxed::Box<Map>),
}
}
/// Specifies the complete (requested) contents of a single row of a table.
/// Rows which exceed 256MiB in size cannot be read in full.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Row {
/// The unique key which identifies this row within its table. This is the same
/// key that's used to identify the row in, for example, a MutateRowRequest.
/// May contain any non-empty byte string up to 4KiB in length.
#[prost(bytes = "bytes", tag = "1")]
pub key: ::prost::bytes::Bytes,
/// May be empty, but only if the entire row is empty.
/// The mutual ordering of column families is not specified.
#[prost(message, repeated, tag = "2")]
pub families: ::prost::alloc::vec::Vec<Family>,
}
/// Specifies (some of) the contents of a single row/column family intersection
/// of a table.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Family {
/// The unique key which identifies this family within its row. This is the
/// same key that's used to identify the family in, for example, a RowFilter
/// which sets its "family_name_regex_filter" field.
/// Must match `\[-_.a-zA-Z0-9\]+`, except that AggregatingRowProcessors may
/// produce cells in a sentinel family with an empty name.
/// Must be no greater than 64 characters in length.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Must not be empty. Sorted in order of increasing "qualifier".
#[prost(message, repeated, tag = "2")]
pub columns: ::prost::alloc::vec::Vec<Column>,
}
/// Specifies (some of) the contents of a single row/column intersection of a
/// table.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Column {
/// The unique key which identifies this column within its family. This is the
/// same key that's used to identify the column in, for example, a RowFilter
/// which sets its `column_qualifier_regex_filter` field.
/// May contain any byte string, including the empty string, up to 16kiB in
/// length.
#[prost(bytes = "bytes", tag = "1")]
pub qualifier: ::prost::bytes::Bytes,
/// Must not be empty. Sorted in order of decreasing "timestamp_micros".
#[prost(message, repeated, tag = "2")]
pub cells: ::prost::alloc::vec::Vec<Cell>,
}
/// Specifies (some of) the contents of a single row/column/timestamp of a table.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Cell {
/// The cell's stored timestamp, which also uniquely identifies it within
/// its column.
/// Values are always expressed in microseconds, but individual tables may set
/// a coarser granularity to further restrict the allowed values. For
/// example, a table which specifies millisecond granularity will only allow
/// values of `timestamp_micros` which are multiples of 1000.
#[prost(int64, tag = "1")]
pub timestamp_micros: i64,
/// The value stored in the cell.
/// May contain any byte string, including the empty string, up to 100MiB in
/// length.
#[prost(bytes = "bytes", tag = "2")]
pub value: ::prost::bytes::Bytes,
/// Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter].
#[prost(string, repeated, tag = "3")]
pub labels: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// `Value` represents a dynamically typed value.
/// The typed fields in `Value` are used as a transport encoding for the actual
/// value (which may be of a more complex type). See the documentation of the
/// `Type` message for more details.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Value {
/// The verified `Type` of this `Value`, if it cannot be inferred.
///
/// Read results will never specify the encoding for `type` since the value
/// will already have been decoded by the server. Furthermore, the `type` will
/// be omitted entirely if it can be inferred from a previous response. The
/// exact semantics for inferring `type` will vary, and are therefore
/// documented separately for each read method.
///
/// When using composite types (Struct, Array, Map) only the outermost `Value`
/// will specify the `type`. This top-level `type` will define the types for
/// any nested `Struct' fields, `Array` elements, or `Map` key/value pairs.
/// If a nested `Value` provides a `type` on write, the request will be
/// rejected with INVALID_ARGUMENT.
#[prost(message, optional, tag = "7")]
pub r#type: ::core::option::Option<Type>,
/// Options for transporting values within the protobuf type system. A given
/// `kind` may support more than one `type` and vice versa. On write, this is
/// roughly analogous to a GoogleSQL literal.
///
/// The value is `NULL` if none of the fields in `kind` is set. If `type` is
/// also omitted on write, we will infer it based on the schema.
#[prost(oneof = "value::Kind", tags = "8, 9, 2, 3, 6, 10, 11, 12, 13, 4")]
pub kind: ::core::option::Option<value::Kind>,
}
/// Nested message and enum types in `Value`.
pub mod value {
/// Options for transporting values within the protobuf type system. A given
/// `kind` may support more than one `type` and vice versa. On write, this is
/// roughly analogous to a GoogleSQL literal.
///
/// The value is `NULL` if none of the fields in `kind` is set. If `type` is
/// also omitted on write, we will infer it based on the schema.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
/// Represents a raw byte sequence with no type information.
/// The `type` field must be omitted.
#[prost(bytes, tag = "8")]
RawValue(::prost::bytes::Bytes),
/// Represents a raw cell timestamp with no type information.
/// The `type` field must be omitted.
#[prost(int64, tag = "9")]
RawTimestampMicros(i64),
/// Represents a typed value transported as a byte sequence.
#[prost(bytes, tag = "2")]
BytesValue(::prost::bytes::Bytes),
/// Represents a typed value transported as a string.
#[prost(string, tag = "3")]
StringValue(::prost::alloc::string::String),
/// Represents a typed value transported as an integer.
#[prost(int64, tag = "6")]
IntValue(i64),
/// Represents a typed value transported as a boolean.
#[prost(bool, tag = "10")]
BoolValue(bool),
/// Represents a typed value transported as a floating point number.
#[prost(double, tag = "11")]
FloatValue(f64),
/// Represents a typed value transported as a timestamp.
#[prost(message, tag = "12")]
TimestampValue(::prost_types::Timestamp),
/// Represents a typed value transported as a date.
#[prost(message, tag = "13")]
DateValue(super::super::super::r#type::Date),
/// Represents a typed value transported as a sequence of values.
/// To differentiate between `Struct`, `Array`, and `Map`, the outermost
/// `Value` must provide an explicit `type` on write. This `type` will
/// apply recursively to the nested `Struct` fields, `Array` elements,
/// or `Map` key/value pairs, which *must not* supply their own `type`.
#[prost(message, tag = "4")]
ArrayValue(super::ArrayValue),
}
}
/// `ArrayValue` is an ordered list of `Value`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ArrayValue {
/// The ordered elements in the array.
#[prost(message, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<Value>,
}
/// Specifies a contiguous range of rows.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RowRange {
/// The row key at which to start the range.
/// If neither field is set, interpreted as the empty string, inclusive.
#[prost(oneof = "row_range::StartKey", tags = "1, 2")]
pub start_key: ::core::option::Option<row_range::StartKey>,
/// The row key at which to end the range.
/// If neither field is set, interpreted as the infinite row key, exclusive.
#[prost(oneof = "row_range::EndKey", tags = "3, 4")]
pub end_key: ::core::option::Option<row_range::EndKey>,
}
/// Nested message and enum types in `RowRange`.
pub mod row_range {
/// The row key at which to start the range.
/// If neither field is set, interpreted as the empty string, inclusive.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum StartKey {
/// Used when giving an inclusive lower bound for the range.
#[prost(bytes, tag = "1")]
StartKeyClosed(::prost::bytes::Bytes),
/// Used when giving an exclusive lower bound for the range.
#[prost(bytes, tag = "2")]
StartKeyOpen(::prost::bytes::Bytes),
}
/// The row key at which to end the range.
/// If neither field is set, interpreted as the infinite row key, exclusive.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum EndKey {
/// Used when giving an exclusive upper bound for the range.
#[prost(bytes, tag = "3")]
EndKeyOpen(::prost::bytes::Bytes),
/// Used when giving an inclusive upper bound for the range.
#[prost(bytes, tag = "4")]
EndKeyClosed(::prost::bytes::Bytes),
}
}
/// Specifies a non-contiguous set of rows.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RowSet {
/// Single rows included in the set.
#[prost(bytes = "bytes", repeated, tag = "1")]
pub row_keys: ::prost::alloc::vec::Vec<::prost::bytes::Bytes>,
/// Contiguous row ranges included in the set.
#[prost(message, repeated, tag = "2")]
pub row_ranges: ::prost::alloc::vec::Vec<RowRange>,
}
/// Specifies a contiguous range of columns within a single column family.
/// The range spans from <column_family>:<start_qualifier> to
/// <column_family>:<end_qualifier>, where both bounds can be either
/// inclusive or exclusive.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ColumnRange {
/// The name of the column family within which this range falls.
#[prost(string, tag = "1")]
pub family_name: ::prost::alloc::string::String,
/// The column qualifier at which to start the range (within `column_family`).
/// If neither field is set, interpreted as the empty string, inclusive.
#[prost(oneof = "column_range::StartQualifier", tags = "2, 3")]
pub start_qualifier: ::core::option::Option<column_range::StartQualifier>,
/// The column qualifier at which to end the range (within `column_family`).
/// If neither field is set, interpreted as the infinite string, exclusive.
#[prost(oneof = "column_range::EndQualifier", tags = "4, 5")]
pub end_qualifier: ::core::option::Option<column_range::EndQualifier>,
}
/// Nested message and enum types in `ColumnRange`.
pub mod column_range {
/// The column qualifier at which to start the range (within `column_family`).
/// If neither field is set, interpreted as the empty string, inclusive.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum StartQualifier {
/// Used when giving an inclusive lower bound for the range.
#[prost(bytes, tag = "2")]
StartQualifierClosed(::prost::bytes::Bytes),
/// Used when giving an exclusive lower bound for the range.
#[prost(bytes, tag = "3")]
StartQualifierOpen(::prost::bytes::Bytes),
}
/// The column qualifier at which to end the range (within `column_family`).
/// If neither field is set, interpreted as the infinite string, exclusive.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum EndQualifier {
/// Used when giving an inclusive upper bound for the range.
#[prost(bytes, tag = "4")]
EndQualifierClosed(::prost::bytes::Bytes),
/// Used when giving an exclusive upper bound for the range.
#[prost(bytes, tag = "5")]
EndQualifierOpen(::prost::bytes::Bytes),
}
}
/// Specified a contiguous range of microsecond timestamps.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TimestampRange {
/// Inclusive lower bound. If left empty, interpreted as 0.
#[prost(int64, tag = "1")]
pub start_timestamp_micros: i64,
/// Exclusive upper bound. If left empty, interpreted as infinity.
#[prost(int64, tag = "2")]
pub end_timestamp_micros: i64,
}
/// Specifies a contiguous range of raw byte values.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ValueRange {
/// The value at which to start the range.
/// If neither field is set, interpreted as the empty string, inclusive.
#[prost(oneof = "value_range::StartValue", tags = "1, 2")]
pub start_value: ::core::option::Option<value_range::StartValue>,
/// The value at which to end the range.
/// If neither field is set, interpreted as the infinite string, exclusive.
#[prost(oneof = "value_range::EndValue", tags = "3, 4")]
pub end_value: ::core::option::Option<value_range::EndValue>,
}
/// Nested message and enum types in `ValueRange`.
pub mod value_range {
/// The value at which to start the range.
/// If neither field is set, interpreted as the empty string, inclusive.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum StartValue {
/// Used when giving an inclusive lower bound for the range.
#[prost(bytes, tag = "1")]
StartValueClosed(::prost::bytes::Bytes),
/// Used when giving an exclusive lower bound for the range.
#[prost(bytes, tag = "2")]
StartValueOpen(::prost::bytes::Bytes),
}
/// The value at which to end the range.
/// If neither field is set, interpreted as the infinite string, exclusive.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum EndValue {
/// Used when giving an inclusive upper bound for the range.
#[prost(bytes, tag = "3")]
EndValueClosed(::prost::bytes::Bytes),
/// Used when giving an exclusive upper bound for the range.
#[prost(bytes, tag = "4")]
EndValueOpen(::prost::bytes::Bytes),
}
}
/// Takes a row as input and produces an alternate view of the row based on
/// specified rules. For example, a RowFilter might trim down a row to include
/// just the cells from columns matching a given regular expression, or might
/// return all the cells of a row but not their values. More complicated filters
/// can be composed out of these components to express requests such as, "within
/// every column of a particular family, give just the two most recent cells
/// which are older than timestamp X."
///
/// There are two broad categories of RowFilters (true filters and transformers),
/// as well as two ways to compose simple filters into more complex ones
/// (chains and interleaves). They work as follows:
///
/// * True filters alter the input row by excluding some of its cells wholesale
/// from the output row. An example of a true filter is the `value_regex_filter`,
/// which excludes cells whose values don't match the specified pattern. All
/// regex true filters use RE2 syntax (<https://github.com/google/re2/wiki/Syntax>)
/// in raw byte mode (RE2::Latin1), and are evaluated as full matches. An
/// important point to keep in mind is that `RE2(.)` is equivalent by default to
/// `RE2(\[^\n\])`, meaning that it does not match newlines. When attempting to
/// match an arbitrary byte, you should therefore use the escape sequence `\C`,
/// which may need to be further escaped as `\\C` in your client language.
///
/// * Transformers alter the input row by changing the values of some of its
/// cells in the output, without excluding them completely. Currently, the only
/// supported transformer is the `strip_value_transformer`, which replaces every
/// cell's value with the empty string.
///
/// * Chains and interleaves are described in more detail in the
/// RowFilter.Chain and RowFilter.Interleave documentation.
///
/// The total serialized size of a RowFilter message must not
/// exceed 20480 bytes, and RowFilters may not be nested within each other
/// (in Chains or Interleaves) to a depth of more than 20.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RowFilter {
/// Which of the possible RowFilter types to apply. If none are set, this
/// RowFilter returns all cells in the input row.
#[prost(
oneof = "row_filter::Filter",
tags = "1, 2, 3, 16, 17, 18, 4, 14, 5, 6, 7, 8, 9, 15, 10, 11, 12, 13, 19"
)]
pub filter: ::core::option::Option<row_filter::Filter>,
}
/// Nested message and enum types in `RowFilter`.
pub mod row_filter {
/// A RowFilter which sends rows through several RowFilters in sequence.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Chain {
/// The elements of "filters" are chained together to process the input row:
/// in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row
/// The full chain is executed atomically.
#[prost(message, repeated, tag = "1")]
pub filters: ::prost::alloc::vec::Vec<super::RowFilter>,
}
/// A RowFilter which sends each row to each of several component
/// RowFilters and interleaves the results.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Interleave {
/// The elements of "filters" all process a copy of the input row, and the
/// results are pooled, sorted, and combined into a single output row.
/// If multiple cells are produced with the same column and timestamp,
/// they will all appear in the output row in an unspecified mutual order.
/// Consider the following example, with three filters:
///
/// input row
/// |
/// -----------------------------------------------------
/// | | |
/// f(0) f(1) f(2)
/// | | |
/// 1: foo,bar,10,x foo,bar,10,z far,bar,7,a
/// 2: foo,blah,11,z far,blah,5,x far,blah,5,x
/// | | |
/// -----------------------------------------------------
/// |
/// 1: foo,bar,10,z // could have switched with #2
/// 2: foo,bar,10,x // could have switched with #1
/// 3: foo,blah,11,z
/// 4: far,bar,7,a
/// 5: far,blah,5,x // identical to #6
/// 6: far,blah,5,x // identical to #5
///
/// All interleaved filters are executed atomically.
#[prost(message, repeated, tag = "1")]
pub filters: ::prost::alloc::vec::Vec<super::RowFilter>,
}
/// A RowFilter which evaluates one of two possible RowFilters, depending on
/// whether or not a predicate RowFilter outputs any cells from the input row.
///
/// IMPORTANT NOTE: The predicate filter does not execute atomically with the
/// true and false filters, which may lead to inconsistent or unexpected
/// results. Additionally, Condition filters have poor performance, especially
/// when filters are set for the false condition.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Condition {
/// If `predicate_filter` outputs any cells, then `true_filter` will be
/// evaluated on the input row. Otherwise, `false_filter` will be evaluated.
#[prost(message, optional, boxed, tag = "1")]
pub predicate_filter: ::core::option::Option<
::prost::alloc::boxed::Box<super::RowFilter>,
>,
/// The filter to apply to the input row if `predicate_filter` returns any
/// results. If not provided, no results will be returned in the true case.
#[prost(message, optional, boxed, tag = "2")]
pub true_filter: ::core::option::Option<
::prost::alloc::boxed::Box<super::RowFilter>,
>,
/// The filter to apply to the input row if `predicate_filter` does not
/// return any results. If not provided, no results will be returned in the
/// false case.
#[prost(message, optional, boxed, tag = "3")]
pub false_filter: ::core::option::Option<
::prost::alloc::boxed::Box<super::RowFilter>,
>,
}
/// Which of the possible RowFilter types to apply. If none are set, this
/// RowFilter returns all cells in the input row.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Filter {
/// Applies several RowFilters to the data in sequence, progressively
/// narrowing the results.
#[prost(message, tag = "1")]
Chain(Chain),
/// Applies several RowFilters to the data in parallel and combines the
/// results.
#[prost(message, tag = "2")]
Interleave(Interleave),
/// Applies one of two possible RowFilters to the data based on the output of
/// a predicate RowFilter.
#[prost(message, tag = "3")]
Condition(::prost::alloc::boxed::Box<Condition>),
/// ADVANCED USE ONLY.
/// Hook for introspection into the RowFilter. Outputs all cells directly to
/// the output of the read rather than to any parent filter. Consider the
/// following example:
///
/// Chain(
/// FamilyRegex("A"),
/// Interleave(
/// All(),
/// Chain(Label("foo"), Sink())
/// ),
/// QualifierRegex("B")
/// )
///
/// A,A,1,w
/// A,B,2,x
/// B,B,4,z
/// |
/// FamilyRegex("A")
/// |
/// A,A,1,w
/// A,B,2,x
/// |
/// +------------+-------------+
/// | |
/// All() Label(foo)
/// | |
/// A,A,1,w A,A,1,w,labels:\[foo\]
/// A,B,2,x A,B,2,x,labels:\[foo\]
/// | |
/// | Sink() --------------+
/// | | |
/// +------------+ x------+ A,A,1,w,labels:\[foo\]
/// | A,B,2,x,labels:\[foo\]
/// A,A,1,w |
/// A,B,2,x |
/// | |
/// QualifierRegex("B") |
/// | |
/// A,B,2,x |
/// | |
/// +--------------------------------+
/// |
/// A,A,1,w,labels:\[foo\]
/// A,B,2,x,labels:\[foo\] // could be switched
/// A,B,2,x // could be switched
///
/// Despite being excluded by the qualifier filter, a copy of every cell
/// that reaches the sink is present in the final result.
///
/// As with an [Interleave][google.bigtable.v2.RowFilter.Interleave],
/// duplicate cells are possible, and appear in an unspecified mutual order.
/// In this case we have a duplicate with column "A:B" and timestamp 2,
/// because one copy passed through the all filter while the other was
/// passed through the label and sink. Note that one copy has label "foo",
/// while the other does not.
///
/// Cannot be used within the `predicate_filter`, `true_filter`, or
/// `false_filter` of a [Condition][google.bigtable.v2.RowFilter.Condition].
#[prost(bool, tag = "16")]
Sink(bool),
/// Matches all cells, regardless of input. Functionally equivalent to
/// leaving `filter` unset, but included for completeness.
#[prost(bool, tag = "17")]
PassAllFilter(bool),
/// Does not match any cells, regardless of input. Useful for temporarily
/// disabling just part of a filter.
#[prost(bool, tag = "18")]
BlockAllFilter(bool),
/// Matches only cells from rows whose keys satisfy the given RE2 regex. In
/// other words, passes through the entire row when the key matches, and
/// otherwise produces an empty row.
/// Note that, since row keys can contain arbitrary bytes, the `\C` escape
/// sequence must be used if a true wildcard is desired. The `.` character
/// will not match the new line character `\n`, which may be present in a
/// binary key.
#[prost(bytes, tag = "4")]
RowKeyRegexFilter(::prost::bytes::Bytes),
/// Matches all cells from a row with probability p, and matches no cells
/// from the row with probability 1-p.
#[prost(double, tag = "14")]
RowSampleFilter(f64),
/// Matches only cells from columns whose families satisfy the given RE2
/// regex. For technical reasons, the regex must not contain the `:`
/// character, even if it is not being used as a literal.
/// Note that, since column families cannot contain the new line character
/// `\n`, it is sufficient to use `.` as a full wildcard when matching
/// column family names.
#[prost(string, tag = "5")]
FamilyNameRegexFilter(::prost::alloc::string::String),
/// Matches only cells from columns whose qualifiers satisfy the given RE2
/// regex.
/// Note that, since column qualifiers can contain arbitrary bytes, the `\C`
/// escape sequence must be used if a true wildcard is desired. The `.`
/// character will not match the new line character `\n`, which may be
/// present in a binary qualifier.
#[prost(bytes, tag = "6")]
ColumnQualifierRegexFilter(::prost::bytes::Bytes),
/// Matches only cells from columns within the given range.
#[prost(message, tag = "7")]
ColumnRangeFilter(super::ColumnRange),
/// Matches only cells with timestamps within the given range.
#[prost(message, tag = "8")]
TimestampRangeFilter(super::TimestampRange),
/// Matches only cells with values that satisfy the given regular expression.
/// Note that, since cell values can contain arbitrary bytes, the `\C` escape
/// sequence must be used if a true wildcard is desired. The `.` character
/// will not match the new line character `\n`, which may be present in a
/// binary value.
#[prost(bytes, tag = "9")]
ValueRegexFilter(::prost::bytes::Bytes),
/// Matches only cells with values that fall within the given range.
#[prost(message, tag = "15")]
ValueRangeFilter(super::ValueRange),
/// Skips the first N cells of each row, matching all subsequent cells.
/// If duplicate cells are present, as is possible when using an Interleave,
/// each copy of the cell is counted separately.
#[prost(int32, tag = "10")]
CellsPerRowOffsetFilter(i32),
/// Matches only the first N cells of each row.
/// If duplicate cells are present, as is possible when using an Interleave,
/// each copy of the cell is counted separately.
#[prost(int32, tag = "11")]
CellsPerRowLimitFilter(i32),
/// Matches only the most recent N cells within each column. For example,
/// if N=2, this filter would match column `foo:bar` at timestamps 10 and 9,
/// skip all earlier cells in `foo:bar`, and then begin matching again in
/// column `foo:bar2`.
/// If duplicate cells are present, as is possible when using an Interleave,
/// each copy of the cell is counted separately.
#[prost(int32, tag = "12")]
CellsPerColumnLimitFilter(i32),
/// Replaces each cell's value with the empty string.
#[prost(bool, tag = "13")]
StripValueTransformer(bool),
/// Applies the given label to all cells in the output row. This allows
/// the client to determine which results were produced from which part of
/// the filter.
///
/// Values must be at most 15 characters in length, and match the RE2
/// pattern `\[a-z0-9\\-\]+`
///
/// Due to a technical limitation, it is not currently possible to apply
/// multiple labels to a cell. As a result, a Chain may have no more than
/// one sub-filter which contains a `apply_label_transformer`. It is okay for
/// an Interleave to contain multiple `apply_label_transformers`, as they
/// will be applied to separate copies of the input. This may be relaxed in
/// the future.
#[prost(string, tag = "19")]
ApplyLabelTransformer(::prost::alloc::string::String),
}
}
/// Specifies a particular change to be made to the contents of a row.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Mutation {
/// Which of the possible Mutation types to apply.
#[prost(oneof = "mutation::Mutation", tags = "1, 5, 6, 2, 3, 4")]
pub mutation: ::core::option::Option<mutation::Mutation>,
}
/// Nested message and enum types in `Mutation`.
pub mod mutation {
/// A Mutation which sets the value of the specified cell.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SetCell {
/// The name of the family into which new data should be written.
/// Must match `\[-_.a-zA-Z0-9\]+`
#[prost(string, tag = "1")]
pub family_name: ::prost::alloc::string::String,
/// The qualifier of the column into which new data should be written.
/// Can be any byte string, including the empty string.
#[prost(bytes = "bytes", tag = "2")]
pub column_qualifier: ::prost::bytes::Bytes,
/// The timestamp of the cell into which new data should be written.
/// Use -1 for current Bigtable server time.
/// Otherwise, the client should set this value itself, noting that the
/// default value is a timestamp of zero if the field is left unspecified.
/// Values must match the granularity of the table (e.g. micros, millis).
#[prost(int64, tag = "3")]
pub timestamp_micros: i64,
/// The value to be written into the specified cell.
#[prost(bytes = "bytes", tag = "4")]
pub value: ::prost::bytes::Bytes,
}
/// A Mutation which incrementally updates a cell in an `Aggregate` family.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AddToCell {
/// The name of the `Aggregate` family into which new data should be added.
/// This must be a family with a `value_type` of `Aggregate`.
/// Format: `\[-_.a-zA-Z0-9\]+`
#[prost(string, tag = "1")]
pub family_name: ::prost::alloc::string::String,
/// The qualifier of the column into which new data should be added. This
/// must be a `raw_value`.
#[prost(message, optional, tag = "2")]
pub column_qualifier: ::core::option::Option<super::Value>,
/// The timestamp of the cell to which new data should be added. This must
/// be a `raw_timestamp_micros` that matches the table's `granularity`.
#[prost(message, optional, tag = "3")]
pub timestamp: ::core::option::Option<super::Value>,
/// The input value to be accumulated into the specified cell. This must be
/// compatible with the family's `value_type.input_type`.
#[prost(message, optional, tag = "4")]
pub input: ::core::option::Option<super::Value>,
}
/// A Mutation which merges accumulated state into a cell in an `Aggregate`
/// family.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MergeToCell {
/// The name of the `Aggregate` family into which new data should be added.
/// This must be a family with a `value_type` of `Aggregate`.
/// Format: `\[-_.a-zA-Z0-9\]+`
#[prost(string, tag = "1")]
pub family_name: ::prost::alloc::string::String,
/// The qualifier of the column into which new data should be added. This
/// must be a `raw_value`.
#[prost(message, optional, tag = "2")]
pub column_qualifier: ::core::option::Option<super::Value>,
/// The timestamp of the cell to which new data should be added. This must
/// be a `raw_timestamp_micros` that matches the table's `granularity`.
#[prost(message, optional, tag = "3")]
pub timestamp: ::core::option::Option<super::Value>,
/// The input value to be merged into the specified cell. This must be
/// compatible with the family's `value_type.state_type`. Merging `NULL` is
/// allowed, but has no effect.
#[prost(message, optional, tag = "4")]
pub input: ::core::option::Option<super::Value>,
}
/// A Mutation which deletes cells from the specified column, optionally
/// restricting the deletions to a given timestamp range.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFromColumn {
/// The name of the family from which cells should be deleted.
/// Must match `\[-_.a-zA-Z0-9\]+`
#[prost(string, tag = "1")]
pub family_name: ::prost::alloc::string::String,
/// The qualifier of the column from which cells should be deleted.
/// Can be any byte string, including the empty string.
#[prost(bytes = "bytes", tag = "2")]
pub column_qualifier: ::prost::bytes::Bytes,
/// The range of timestamps within which cells should be deleted.
#[prost(message, optional, tag = "3")]
pub time_range: ::core::option::Option<super::TimestampRange>,
}
/// A Mutation which deletes all cells from the specified column family.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFromFamily {
/// The name of the family from which cells should be deleted.
/// Must match `\[-_.a-zA-Z0-9\]+`
#[prost(string, tag = "1")]
pub family_name: ::prost::alloc::string::String,
}
/// A Mutation which deletes all cells from the containing row.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DeleteFromRow {}
/// Which of the possible Mutation types to apply.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Mutation {
/// Set a cell's value.
#[prost(message, tag = "1")]
SetCell(SetCell),
/// Incrementally updates an `Aggregate` cell.
#[prost(message, tag = "5")]
AddToCell(AddToCell),
/// Merges accumulated state to an `Aggregate` cell.
#[prost(message, tag = "6")]
MergeToCell(MergeToCell),
/// Deletes cells from a column.
#[prost(message, tag = "2")]
DeleteFromColumn(DeleteFromColumn),
/// Deletes cells from a column family.
#[prost(message, tag = "3")]
DeleteFromFamily(DeleteFromFamily),
/// Deletes cells from the entire row.
#[prost(message, tag = "4")]
DeleteFromRow(DeleteFromRow),
}
}
/// Specifies an atomic read/modify/write operation on the latest value of the
/// specified column.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadModifyWriteRule {
/// The name of the family to which the read/modify/write should be applied.
/// Must match `\[-_.a-zA-Z0-9\]+`
#[prost(string, tag = "1")]
pub family_name: ::prost::alloc::string::String,
/// The qualifier of the column to which the read/modify/write should be
/// applied.
/// Can be any byte string, including the empty string.
#[prost(bytes = "bytes", tag = "2")]
pub column_qualifier: ::prost::bytes::Bytes,
/// The rule used to determine the column's new latest value from its current
/// latest value.
#[prost(oneof = "read_modify_write_rule::Rule", tags = "3, 4")]
pub rule: ::core::option::Option<read_modify_write_rule::Rule>,
}
/// Nested message and enum types in `ReadModifyWriteRule`.
pub mod read_modify_write_rule {
/// The rule used to determine the column's new latest value from its current
/// latest value.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Rule {
/// Rule specifying that `append_value` be appended to the existing value.
/// If the targeted cell is unset, it will be treated as containing the
/// empty string.
#[prost(bytes, tag = "3")]
AppendValue(::prost::bytes::Bytes),
/// Rule specifying that `increment_amount` be added to the existing value.
/// If the targeted cell is unset, it will be treated as containing a zero.
/// Otherwise, the targeted cell must contain an 8-byte value (interpreted
/// as a 64-bit big-endian signed integer), or the entire request will fail.
#[prost(int64, tag = "4")]
IncrementAmount(i64),
}
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// A partition of a change stream.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamPartition {
/// The row range covered by this partition and is specified by
/// [`start_key_closed`, `end_key_open`).
#[prost(message, optional, tag = "1")]
pub row_range: ::core::option::Option<RowRange>,
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// The information required to continue reading the data from multiple
/// `StreamPartitions` from where a previous read left off.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamContinuationTokens {
/// List of continuation tokens.
#[prost(message, repeated, tag = "1")]
pub tokens: ::prost::alloc::vec::Vec<StreamContinuationToken>,
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// The information required to continue reading the data from a
/// `StreamPartition` from where a previous read left off.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamContinuationToken {
/// The partition that this token applies to.
#[prost(message, optional, tag = "1")]
pub partition: ::core::option::Option<StreamPartition>,
/// An encoded position in the stream to restart reading from.
#[prost(string, tag = "2")]
pub token: ::prost::alloc::string::String,
}
/// Protocol buffers format descriptor, as described by Messages ProtoSchema and
/// ProtoRows
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ProtoFormat {}
/// Describes a column in a Bigtable Query Language result set.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ColumnMetadata {
/// The name of the column.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The type of the column.
#[prost(message, optional, tag = "2")]
pub r#type: ::core::option::Option<Type>,
}
/// ResultSet schema in proto format
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProtoSchema {
/// The columns in the result set.
#[prost(message, repeated, tag = "1")]
pub columns: ::prost::alloc::vec::Vec<ColumnMetadata>,
}
/// Describes the structure of a Bigtable result set.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResultSetMetadata {
/// The schema of the ResultSet, contains ordered list of column names
/// with types
#[prost(oneof = "result_set_metadata::Schema", tags = "1")]
pub schema: ::core::option::Option<result_set_metadata::Schema>,
}
/// Nested message and enum types in `ResultSetMetadata`.
pub mod result_set_metadata {
/// The schema of the ResultSet, contains ordered list of column names
/// with types
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Schema {
/// Schema in proto format
#[prost(message, tag = "1")]
ProtoSchema(super::ProtoSchema),
}
}
/// Rows represented in proto format.
///
/// This should be constructed by concatenating the `batch_data` from each
/// of the relevant `ProtoRowsBatch` messages and parsing the result as a
/// `ProtoRows` message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProtoRows {
/// A proto rows message consists of a list of values. Every N complete values
/// defines a row, where N is equal to the number of entries in the
/// `metadata.proto_schema.columns` value received in the first response.
#[prost(message, repeated, tag = "2")]
pub values: ::prost::alloc::vec::Vec<Value>,
}
/// Batch of serialized ProtoRows.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProtoRowsBatch {
/// Merge partial results by concatenating these bytes, then parsing the
/// overall value as a `ProtoRows` message.
#[prost(bytes = "bytes", tag = "1")]
pub batch_data: ::prost::bytes::Bytes,
}
/// A partial result set from the streaming query API.
/// CBT client will buffer partial_rows from result_sets until it gets a
/// resumption_token.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PartialResultSet {
/// An opaque token sent by the server to allow query resumption and signal
/// the client to accumulate `partial_rows` since the last non-empty
/// `resume_token`. On resumption, the resumed query will return the remaining
/// rows for this query.
///
/// If there is a batch in progress, a non-empty `resume_token`
/// means that that the batch of `partial_rows` will be complete after merging
/// the `partial_rows` from this response. The client must only yield
/// completed batches to the application, and must ensure that any future
/// retries send the latest token to avoid returning duplicate data.
///
/// The server may set 'resume_token' without a 'partial_rows'. If there is a
/// batch in progress the client should yield it.
///
/// The server will also send a sentinel `resume_token` when last batch of
/// `partial_rows` is sent. If the client retries the ExecuteQueryRequest with
/// the sentinel `resume_token`, the server will emit it again without any
/// `partial_rows`, then return OK.
#[prost(bytes = "bytes", tag = "5")]
pub resume_token: ::prost::bytes::Bytes,
/// Estimated size of a new batch. The server will always set this when
/// returning the first `partial_rows` of a batch, and will not set it at any
/// other time.
///
/// The client can use this estimate to allocate an initial buffer for the
/// batched results. This helps minimize the number of allocations required,
/// though the buffer size may still need to be increased if the estimate is
/// too low.
#[prost(int32, tag = "4")]
pub estimated_batch_size: i32,
/// Partial Rows in one of the supported formats. It may require many
/// PartialResultSets to stream a batch of rows that can decoded on the client.
/// The client should buffer partial_rows until it gets a `resume_token`,
/// at which point the batch is complete and can be decoded and yielded to the
/// user. Each sub-message documents the appropriate way to combine results.
#[prost(oneof = "partial_result_set::PartialRows", tags = "3")]
pub partial_rows: ::core::option::Option<partial_result_set::PartialRows>,
}
/// Nested message and enum types in `PartialResultSet`.
pub mod partial_result_set {
/// Partial Rows in one of the supported formats. It may require many
/// PartialResultSets to stream a batch of rows that can decoded on the client.
/// The client should buffer partial_rows until it gets a `resume_token`,
/// at which point the batch is complete and can be decoded and yielded to the
/// user. Each sub-message documents the appropriate way to combine results.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum PartialRows {
/// Partial rows in serialized ProtoRows format.
#[prost(message, tag = "3")]
ProtoRowsBatch(super::ProtoRowsBatch),
}
}
/// Request message for Bigtable.ReadRows.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadRowsRequest {
/// Optional. The unique name of the table from which to read.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>`.
#[prost(string, tag = "1")]
pub table_name: ::prost::alloc::string::String,
/// Optional. The unique name of the AuthorizedView from which to read.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
#[prost(string, tag = "9")]
pub authorized_view_name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
#[prost(string, tag = "5")]
pub app_profile_id: ::prost::alloc::string::String,
/// The row keys and/or ranges to read sequentially. If not specified, reads
/// from all rows.
#[prost(message, optional, tag = "2")]
pub rows: ::core::option::Option<RowSet>,
/// The filter to apply to the contents of the specified row(s). If unset,
/// reads the entirety of each row.
#[prost(message, optional, tag = "3")]
pub filter: ::core::option::Option<RowFilter>,
/// The read will stop after committing to N rows' worth of results. The
/// default (zero) is to return all results.
#[prost(int64, tag = "4")]
pub rows_limit: i64,
/// The view into RequestStats, as described above.
#[prost(enumeration = "read_rows_request::RequestStatsView", tag = "6")]
pub request_stats_view: i32,
/// Experimental API - Please note that this API is currently experimental
/// and can change in the future.
///
/// Return rows in lexiographical descending order of the row keys. The row
/// contents will not be affected by this flag.
///
/// Example result set:
///
/// [
/// {key: "k2", "f:col1": "v1", "f:col2": "v1"},
/// {key: "k1", "f:col1": "v2", "f:col2": "v2"}
/// ]
#[prost(bool, tag = "7")]
pub reversed: bool,
}
/// Nested message and enum types in `ReadRowsRequest`.
pub mod read_rows_request {
/// The desired view into RequestStats that should be returned in the response.
///
/// See also: RequestStats message.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum RequestStatsView {
/// The default / unset value. The API will default to the NONE option below.
Unspecified = 0,
/// Do not include any RequestStats in the response. This will leave the
/// RequestStats embedded message unset in the response.
RequestStatsNone = 1,
/// Include the full set of available RequestStats in the response,
/// applicable to this read.
RequestStatsFull = 2,
}
impl RequestStatsView {
/// 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 {
RequestStatsView::Unspecified => "REQUEST_STATS_VIEW_UNSPECIFIED",
RequestStatsView::RequestStatsNone => "REQUEST_STATS_NONE",
RequestStatsView::RequestStatsFull => "REQUEST_STATS_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 {
"REQUEST_STATS_VIEW_UNSPECIFIED" => Some(Self::Unspecified),
"REQUEST_STATS_NONE" => Some(Self::RequestStatsNone),
"REQUEST_STATS_FULL" => Some(Self::RequestStatsFull),
_ => None,
}
}
}
}
/// Response message for Bigtable.ReadRows.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadRowsResponse {
/// A collection of a row's contents as part of the read request.
#[prost(message, repeated, tag = "1")]
pub chunks: ::prost::alloc::vec::Vec<read_rows_response::CellChunk>,
/// Optionally the server might return the row key of the last row it
/// has scanned. The client can use this to construct a more
/// efficient retry request if needed: any row keys or portions of
/// ranges less than this row key can be dropped from the request.
/// This is primarily useful for cases where the server has read a
/// lot of data that was filtered out since the last committed row
/// key, allowing the client to skip that work on a retry.
#[prost(bytes = "bytes", tag = "2")]
pub last_scanned_row_key: ::prost::bytes::Bytes,
///
/// If requested, provide enhanced query performance statistics. The semantics
/// dictate:
/// * request_stats is empty on every (streamed) response, except
/// * request_stats has non-empty information after all chunks have been
/// streamed, where the ReadRowsResponse message only contains
/// request_stats.
/// * For example, if a read request would have returned an empty
/// response instead a single ReadRowsResponse is streamed with empty
/// chunks and request_stats filled.
///
/// Visually, response messages will stream as follows:
/// ... -> {chunks: \[...\]} -> {chunks: \[\], request_stats: {...}}
/// \______________________/ \________________________________/
/// Primary response Trailer of RequestStats info
///
/// Or if the read did not return any values:
/// {chunks: \[\], request_stats: {...}}
/// \________________________________/
/// Trailer of RequestStats info
#[prost(message, optional, tag = "3")]
pub request_stats: ::core::option::Option<RequestStats>,
}
/// Nested message and enum types in `ReadRowsResponse`.
pub mod read_rows_response {
/// Specifies a piece of a row's contents returned as part of the read
/// response stream.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CellChunk {
/// The row key for this chunk of data. If the row key is empty,
/// this CellChunk is a continuation of the same row as the previous
/// CellChunk in the response stream, even if that CellChunk was in a
/// previous ReadRowsResponse message.
#[prost(bytes = "bytes", tag = "1")]
pub row_key: ::prost::bytes::Bytes,
/// The column family name for this chunk of data. If this message
/// is not present this CellChunk is a continuation of the same column
/// family as the previous CellChunk. The empty string can occur as a
/// column family name in a response so clients must check
/// explicitly for the presence of this message, not just for
/// `family_name.value` being non-empty.
#[prost(message, optional, tag = "2")]
pub family_name: ::core::option::Option<::prost::alloc::string::String>,
/// The column qualifier for this chunk of data. If this message
/// is not present, this CellChunk is a continuation of the same column
/// as the previous CellChunk. Column qualifiers may be empty so
/// clients must check for the presence of this message, not just
/// for `qualifier.value` being non-empty.
#[prost(message, optional, tag = "3")]
pub qualifier: ::core::option::Option<::prost::alloc::vec::Vec<u8>>,
/// The cell's stored timestamp, which also uniquely identifies it
/// within its column. Values are always expressed in
/// microseconds, but individual tables may set a coarser
/// granularity to further restrict the allowed values. For
/// example, a table which specifies millisecond granularity will
/// only allow values of `timestamp_micros` which are multiples of
/// 1000. Timestamps are only set in the first CellChunk per cell
/// (for cells split into multiple chunks).
#[prost(int64, tag = "4")]
pub timestamp_micros: i64,
/// Labels applied to the cell by a
/// [RowFilter][google.bigtable.v2.RowFilter]. Labels are only set
/// on the first CellChunk per cell.
#[prost(string, repeated, tag = "5")]
pub labels: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The value stored in the cell. Cell values can be split across
/// multiple CellChunks. In that case only the value field will be
/// set in CellChunks after the first: the timestamp and labels
/// will only be present in the first CellChunk, even if the first
/// CellChunk came in a previous ReadRowsResponse.
#[prost(bytes = "bytes", tag = "6")]
pub value: ::prost::bytes::Bytes,
/// If this CellChunk is part of a chunked cell value and this is
/// not the final chunk of that cell, value_size will be set to the
/// total length of the cell value. The client can use this size
/// to pre-allocate memory to hold the full cell value.
#[prost(int32, tag = "7")]
pub value_size: i32,
/// Signals to the client concerning previous CellChunks received.
#[prost(oneof = "cell_chunk::RowStatus", tags = "8, 9")]
pub row_status: ::core::option::Option<cell_chunk::RowStatus>,
}
/// Nested message and enum types in `CellChunk`.
pub mod cell_chunk {
/// Signals to the client concerning previous CellChunks received.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum RowStatus {
/// Indicates that the client should drop all previous chunks for
/// `row_key`, as it will be re-read from the beginning.
#[prost(bool, tag = "8")]
ResetRow(bool),
/// Indicates that the client can safely process all previous chunks for
/// `row_key`, as its data has been fully read.
#[prost(bool, tag = "9")]
CommitRow(bool),
}
}
}
/// Request message for Bigtable.SampleRowKeys.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SampleRowKeysRequest {
/// Optional. The unique name of the table from which to sample row keys.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>`.
#[prost(string, tag = "1")]
pub table_name: ::prost::alloc::string::String,
/// Optional. The unique name of the AuthorizedView from which to sample row
/// keys.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
#[prost(string, tag = "4")]
pub authorized_view_name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
#[prost(string, tag = "2")]
pub app_profile_id: ::prost::alloc::string::String,
}
/// Response message for Bigtable.SampleRowKeys.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SampleRowKeysResponse {
/// Sorted streamed sequence of sample row keys in the table. The table might
/// have contents before the first row key in the list and after the last one,
/// but a key containing the empty string indicates "end of table" and will be
/// the last response given, if present.
/// Note that row keys in this list may not have ever been written to or read
/// from, and users should therefore not make any assumptions about the row key
/// structure that are specific to their use case.
#[prost(bytes = "bytes", tag = "1")]
pub row_key: ::prost::bytes::Bytes,
/// Approximate total storage space used by all rows in the table which precede
/// `row_key`. Buffering the contents of all rows between two subsequent
/// samples would require space roughly equal to the difference in their
/// `offset_bytes` fields.
#[prost(int64, tag = "2")]
pub offset_bytes: i64,
}
/// Request message for Bigtable.MutateRow.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateRowRequest {
/// Optional. The unique name of the table to which the mutation should be
/// applied.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>`.
#[prost(string, tag = "1")]
pub table_name: ::prost::alloc::string::String,
/// Optional. The unique name of the AuthorizedView to which the mutation
/// should be applied.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
#[prost(string, tag = "6")]
pub authorized_view_name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
#[prost(string, tag = "4")]
pub app_profile_id: ::prost::alloc::string::String,
/// Required. The key of the row to which the mutation should be applied.
#[prost(bytes = "bytes", tag = "2")]
pub row_key: ::prost::bytes::Bytes,
/// Required. Changes to be atomically applied to the specified row. Entries
/// are applied in order, meaning that earlier mutations can be masked by later
/// ones. Must contain at least one entry and at most 100000.
#[prost(message, repeated, tag = "3")]
pub mutations: ::prost::alloc::vec::Vec<Mutation>,
}
/// Response message for Bigtable.MutateRow.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct MutateRowResponse {}
/// Request message for BigtableService.MutateRows.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateRowsRequest {
/// Optional. The unique name of the table to which the mutations should be
/// applied.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>`.
#[prost(string, tag = "1")]
pub table_name: ::prost::alloc::string::String,
/// Optional. The unique name of the AuthorizedView to which the mutations
/// should be applied.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
#[prost(string, tag = "5")]
pub authorized_view_name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
#[prost(string, tag = "3")]
pub app_profile_id: ::prost::alloc::string::String,
/// Required. The row keys and corresponding mutations to be applied in bulk.
/// Each entry is applied as an atomic mutation, but the entries may be
/// applied in arbitrary order (even between entries for the same row).
/// At least one entry must be specified, and in total the entries can
/// contain at most 100000 mutations.
#[prost(message, repeated, tag = "2")]
pub entries: ::prost::alloc::vec::Vec<mutate_rows_request::Entry>,
}
/// Nested message and enum types in `MutateRowsRequest`.
pub mod mutate_rows_request {
/// A mutation for a given row.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Entry {
/// The key of the row to which the `mutations` should be applied.
#[prost(bytes = "bytes", tag = "1")]
pub row_key: ::prost::bytes::Bytes,
/// Required. Changes to be atomically applied to the specified row.
/// Mutations are applied in order, meaning that earlier mutations can be
/// masked by later ones. You must specify at least one mutation.
#[prost(message, repeated, tag = "2")]
pub mutations: ::prost::alloc::vec::Vec<super::Mutation>,
}
}
/// Response message for BigtableService.MutateRows.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutateRowsResponse {
/// One or more results for Entries from the batch request.
#[prost(message, repeated, tag = "1")]
pub entries: ::prost::alloc::vec::Vec<mutate_rows_response::Entry>,
/// Information about how client should limit the rate (QPS). Primirily used by
/// supported official Cloud Bigtable clients. If unset, the rate limit info is
/// not provided by the server.
#[prost(message, optional, tag = "3")]
pub rate_limit_info: ::core::option::Option<RateLimitInfo>,
}
/// Nested message and enum types in `MutateRowsResponse`.
pub mod mutate_rows_response {
/// The result of applying a passed mutation in the original request.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Entry {
/// The index into the original request's `entries` list of the Entry
/// for which a result is being reported.
#[prost(int64, tag = "1")]
pub index: i64,
/// The result of the request Entry identified by `index`.
/// Depending on how requests are batched during execution, it is possible
/// for one Entry to fail due to an error with another Entry. In the event
/// that this occurs, the same error will be reported for both entries.
#[prost(message, optional, tag = "2")]
pub status: ::core::option::Option<super::super::super::rpc::Status>,
}
}
/// Information about how client should adjust the load to Bigtable.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RateLimitInfo {
/// Time that clients should wait before adjusting the target rate again.
/// If clients adjust rate too frequently, the impact of the previous
/// adjustment may not have been taken into account and may
/// over-throttle or under-throttle. If clients adjust rate too slowly, they
/// will not be responsive to load changes on server side, and may
/// over-throttle or under-throttle.
#[prost(message, optional, tag = "1")]
pub period: ::core::option::Option<::prost_types::Duration>,
/// If it has been at least one `period` since the last load adjustment, the
/// client should multiply the current load by this value to get the new target
/// load. For example, if the current load is 100 and `factor` is 0.8, the new
/// target load should be 80. After adjusting, the client should ignore
/// `factor` until another `period` has passed.
///
/// The client can measure its load using any unit that's comparable over time
/// For example, QPS can be used as long as each request involves a similar
/// amount of work.
#[prost(double, tag = "2")]
pub factor: f64,
}
/// Request message for Bigtable.CheckAndMutateRow.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckAndMutateRowRequest {
/// Optional. The unique name of the table to which the conditional mutation
/// should be applied.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>`.
#[prost(string, tag = "1")]
pub table_name: ::prost::alloc::string::String,
/// Optional. The unique name of the AuthorizedView to which the conditional
/// mutation should be applied.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
#[prost(string, tag = "9")]
pub authorized_view_name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
#[prost(string, tag = "7")]
pub app_profile_id: ::prost::alloc::string::String,
/// Required. The key of the row to which the conditional mutation should be
/// applied.
#[prost(bytes = "bytes", tag = "2")]
pub row_key: ::prost::bytes::Bytes,
/// The filter to be applied to the contents of the specified row. Depending
/// on whether or not any results are yielded, either `true_mutations` or
/// `false_mutations` will be executed. If unset, checks that the row contains
/// any values at all.
#[prost(message, optional, tag = "6")]
pub predicate_filter: ::core::option::Option<RowFilter>,
/// Changes to be atomically applied to the specified row if `predicate_filter`
/// yields at least one cell when applied to `row_key`. Entries are applied in
/// order, meaning that earlier mutations can be masked by later ones.
/// Must contain at least one entry if `false_mutations` is empty, and at most
/// 100000.
#[prost(message, repeated, tag = "4")]
pub true_mutations: ::prost::alloc::vec::Vec<Mutation>,
/// Changes to be atomically applied to the specified row if `predicate_filter`
/// does not yield any cells when applied to `row_key`. Entries are applied in
/// order, meaning that earlier mutations can be masked by later ones.
/// Must contain at least one entry if `true_mutations` is empty, and at most
/// 100000.
#[prost(message, repeated, tag = "5")]
pub false_mutations: ::prost::alloc::vec::Vec<Mutation>,
}
/// Response message for Bigtable.CheckAndMutateRow.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CheckAndMutateRowResponse {
/// Whether or not the request's `predicate_filter` yielded any results for
/// the specified row.
#[prost(bool, tag = "1")]
pub predicate_matched: bool,
}
/// Request message for client connection keep-alive and warming.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PingAndWarmRequest {
/// Required. The unique name of the instance to check permissions for as well
/// as respond. Values are of the form
/// `projects/<project>/instances/<instance>`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
#[prost(string, tag = "2")]
pub app_profile_id: ::prost::alloc::string::String,
}
/// Response message for Bigtable.PingAndWarm connection keepalive and warming.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct PingAndWarmResponse {}
/// Request message for Bigtable.ReadModifyWriteRow.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadModifyWriteRowRequest {
/// Optional. The unique name of the table to which the read/modify/write rules
/// should be applied.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>`.
#[prost(string, tag = "1")]
pub table_name: ::prost::alloc::string::String,
/// Optional. The unique name of the AuthorizedView to which the
/// read/modify/write rules should be applied.
///
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
#[prost(string, tag = "6")]
pub authorized_view_name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
#[prost(string, tag = "4")]
pub app_profile_id: ::prost::alloc::string::String,
/// Required. The key of the row to which the read/modify/write rules should be
/// applied.
#[prost(bytes = "bytes", tag = "2")]
pub row_key: ::prost::bytes::Bytes,
/// Required. Rules specifying how the specified row's contents are to be
/// transformed into writes. Entries are applied in order, meaning that earlier
/// rules will affect the results of later ones.
#[prost(message, repeated, tag = "3")]
pub rules: ::prost::alloc::vec::Vec<ReadModifyWriteRule>,
}
/// Response message for Bigtable.ReadModifyWriteRow.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadModifyWriteRowResponse {
/// A Row containing the new contents of all cells modified by the request.
#[prost(message, optional, tag = "1")]
pub row: ::core::option::Option<Row>,
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// Request message for Bigtable.GenerateInitialChangeStreamPartitions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GenerateInitialChangeStreamPartitionsRequest {
/// Required. The unique name of the table from which to get change stream
/// partitions. Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>`.
/// Change streaming must be enabled on the table.
#[prost(string, tag = "1")]
pub table_name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
/// Single cluster routing must be configured on the profile.
#[prost(string, tag = "2")]
pub app_profile_id: ::prost::alloc::string::String,
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// Response message for Bigtable.GenerateInitialChangeStreamPartitions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GenerateInitialChangeStreamPartitionsResponse {
/// A partition of the change stream.
#[prost(message, optional, tag = "1")]
pub partition: ::core::option::Option<StreamPartition>,
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// Request message for Bigtable.ReadChangeStream.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadChangeStreamRequest {
/// Required. The unique name of the table from which to read a change stream.
/// Values are of the form
/// `projects/<project>/instances/<instance>/tables/<table>`.
/// Change streaming must be enabled on the table.
#[prost(string, tag = "1")]
pub table_name: ::prost::alloc::string::String,
/// This value specifies routing for replication. If not specified, the
/// "default" application profile will be used.
/// Single cluster routing must be configured on the profile.
#[prost(string, tag = "2")]
pub app_profile_id: ::prost::alloc::string::String,
/// The partition to read changes from.
#[prost(message, optional, tag = "3")]
pub partition: ::core::option::Option<StreamPartition>,
/// If specified, OK will be returned when the stream advances beyond
/// this time. Otherwise, changes will be continuously delivered on the stream.
/// This value is inclusive and will be truncated to microsecond granularity.
#[prost(message, optional, tag = "5")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// If specified, the duration between `Heartbeat` messages on the stream.
/// Otherwise, defaults to 5 seconds.
#[prost(message, optional, tag = "7")]
pub heartbeat_duration: ::core::option::Option<::prost_types::Duration>,
/// Options for describing where we want to start reading from the stream.
#[prost(oneof = "read_change_stream_request::StartFrom", tags = "4, 6")]
pub start_from: ::core::option::Option<read_change_stream_request::StartFrom>,
}
/// Nested message and enum types in `ReadChangeStreamRequest`.
pub mod read_change_stream_request {
/// Options for describing where we want to start reading from the stream.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum StartFrom {
/// Start reading the stream at the specified timestamp. This timestamp must
/// be within the change stream retention period, less than or equal to the
/// current time, and after change stream creation, whichever is greater.
/// This value is inclusive and will be truncated to microsecond granularity.
#[prost(message, tag = "4")]
StartTime(::prost_types::Timestamp),
/// Tokens that describe how to resume reading a stream where reading
/// previously left off. If specified, changes will be read starting at the
/// the position. Tokens are delivered on the stream as part of `Heartbeat`
/// and `CloseStream` messages.
///
/// If a single token is provided, the token’s partition must exactly match
/// the request’s partition. If multiple tokens are provided, as in the case
/// of a partition merge, the union of the token partitions must exactly
/// cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
/// returned.
#[prost(message, tag = "6")]
ContinuationTokens(super::StreamContinuationTokens),
}
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// Response message for Bigtable.ReadChangeStream.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadChangeStreamResponse {
/// The data or control message on the stream.
#[prost(oneof = "read_change_stream_response::StreamRecord", tags = "1, 2, 3")]
pub stream_record: ::core::option::Option<read_change_stream_response::StreamRecord>,
}
/// Nested message and enum types in `ReadChangeStreamResponse`.
pub mod read_change_stream_response {
/// A partial or complete mutation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutationChunk {
/// If set, then the mutation is a `SetCell` with a chunked value across
/// multiple messages.
#[prost(message, optional, tag = "1")]
pub chunk_info: ::core::option::Option<mutation_chunk::ChunkInfo>,
/// If this is a continuation of a chunked message (`chunked_value_offset` >
/// 0), ignore all fields except the `SetCell`'s value and merge it with
/// the previous message by concatenating the value fields.
#[prost(message, optional, tag = "2")]
pub mutation: ::core::option::Option<super::Mutation>,
}
/// Nested message and enum types in `MutationChunk`.
pub mod mutation_chunk {
/// Information about the chunking of this mutation.
/// Only `SetCell` mutations can be chunked, and all chunks for a `SetCell`
/// will be delivered contiguously with no other mutation types interleaved.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ChunkInfo {
/// The total value size of all the chunks that make up the `SetCell`.
#[prost(int32, tag = "1")]
pub chunked_value_size: i32,
/// The byte offset of this chunk into the total value size of the
/// mutation.
#[prost(int32, tag = "2")]
pub chunked_value_offset: i32,
/// When true, this is the last chunk of a chunked `SetCell`.
#[prost(bool, tag = "3")]
pub last_chunk: bool,
}
}
/// A message corresponding to one or more mutations to the partition
/// being streamed. A single logical `DataChange` message may also be split
/// across a sequence of multiple individual messages. Messages other than
/// the first in a sequence will only have the `type` and `chunks` fields
/// populated, with the final message in the sequence also containing `done`
/// set to true.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataChange {
/// The type of the mutation.
#[prost(enumeration = "data_change::Type", tag = "1")]
pub r#type: i32,
/// The cluster where the mutation was applied.
/// Not set when `type` is `GARBAGE_COLLECTION`.
#[prost(string, tag = "2")]
pub source_cluster_id: ::prost::alloc::string::String,
/// The row key for all mutations that are part of this `DataChange`.
/// If the `DataChange` is chunked across multiple messages, then this field
/// will only be set for the first message.
#[prost(bytes = "bytes", tag = "3")]
pub row_key: ::prost::bytes::Bytes,
/// The timestamp at which the mutation was applied on the Bigtable server.
#[prost(message, optional, tag = "4")]
pub commit_timestamp: ::core::option::Option<::prost_types::Timestamp>,
/// A value that lets stream consumers reconstruct Bigtable's
/// conflict resolution semantics.
/// <https://cloud.google.com/bigtable/docs/writes#conflict-resolution>
/// In the event that the same row key, column family, column qualifier,
/// timestamp are modified on different clusters at the same
/// `commit_timestamp`, the mutation with the larger `tiebreaker` will be the
/// one chosen for the eventually consistent state of the system.
#[prost(int32, tag = "5")]
pub tiebreaker: i32,
/// The mutations associated with this change to the partition.
/// May contain complete mutations or chunks of a multi-message chunked
/// `DataChange` record.
#[prost(message, repeated, tag = "6")]
pub chunks: ::prost::alloc::vec::Vec<MutationChunk>,
/// When true, indicates that the entire `DataChange` has been read
/// and the client can safely process the message.
#[prost(bool, tag = "8")]
pub done: bool,
/// An encoded position for this stream's partition to restart reading from.
/// This token is for the StreamPartition from the request.
#[prost(string, tag = "9")]
pub token: ::prost::alloc::string::String,
/// An estimate of the commit timestamp that is usually lower than or equal
/// to any timestamp for a record that will be delivered in the future on the
/// stream. It is possible that, under particular circumstances that a future
/// record has a timestamp is is lower than a previously seen timestamp. For
/// an example usage see
/// <https://beam.apache.org/documentation/basics/#watermarks>
#[prost(message, optional, tag = "10")]
pub estimated_low_watermark: ::core::option::Option<::prost_types::Timestamp>,
}
/// Nested message and enum types in `DataChange`.
pub mod data_change {
/// The type of mutation.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// The type is unspecified.
Unspecified = 0,
/// A user-initiated mutation.
User = 1,
/// A system-initiated mutation as part of garbage collection.
/// <https://cloud.google.com/bigtable/docs/garbage-collection>
GarbageCollection = 2,
/// This is a continuation of a multi-message change.
Continuation = 3,
}
impl Type {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::User => "USER",
Type::GarbageCollection => "GARBAGE_COLLECTION",
Type::Continuation => "CONTINUATION",
}
}
/// 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),
"USER" => Some(Self::User),
"GARBAGE_COLLECTION" => Some(Self::GarbageCollection),
"CONTINUATION" => Some(Self::Continuation),
_ => None,
}
}
}
}
/// A periodic message with information that can be used to checkpoint
/// the state of a stream.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Heartbeat {
/// A token that can be provided to a subsequent `ReadChangeStream` call
/// to pick up reading at the current stream position.
#[prost(message, optional, tag = "1")]
pub continuation_token: ::core::option::Option<super::StreamContinuationToken>,
/// An estimate of the commit timestamp that is usually lower than or equal
/// to any timestamp for a record that will be delivered in the future on the
/// stream. It is possible that, under particular circumstances that a future
/// record has a timestamp is is lower than a previously seen timestamp. For
/// an example usage see
/// <https://beam.apache.org/documentation/basics/#watermarks>
#[prost(message, optional, tag = "2")]
pub estimated_low_watermark: ::core::option::Option<::prost_types::Timestamp>,
}
/// A message indicating that the client should stop reading from the stream.
/// If status is OK and `continuation_tokens` & `new_partitions` are empty, the
/// stream has finished (for example if there was an `end_time` specified).
/// If `continuation_tokens` & `new_partitions` are present, then a change in
/// partitioning requires the client to open a new stream for each token to
/// resume reading. Example:
/// [B, D) ends
/// |
/// v
/// new_partitions: [A, C) [C, E)
/// continuation_tokens.partitions: [B,C) [C,D)
/// ^---^ ^---^
/// ^ ^
/// | |
/// | StreamContinuationToken 2
/// |
/// StreamContinuationToken 1
/// To read the new partition [A,C), supply the continuation tokens whose
/// ranges cover the new partition, for example ContinuationToken[A,B) &
/// ContinuationToken[B,C).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CloseStream {
/// The status of the stream.
#[prost(message, optional, tag = "1")]
pub status: ::core::option::Option<super::super::super::rpc::Status>,
/// If non-empty, contains the information needed to resume reading their
/// associated partitions.
#[prost(message, repeated, tag = "2")]
pub continuation_tokens: ::prost::alloc::vec::Vec<
super::StreamContinuationToken,
>,
/// If non-empty, contains the new partitions to start reading from, which
/// are related to but not necessarily identical to the partitions for the
/// above `continuation_tokens`.
#[prost(message, repeated, tag = "3")]
pub new_partitions: ::prost::alloc::vec::Vec<super::StreamPartition>,
}
/// The data or control message on the stream.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum StreamRecord {
/// A mutation to the partition.
#[prost(message, tag = "1")]
DataChange(DataChange),
/// A periodic heartbeat message.
#[prost(message, tag = "2")]
Heartbeat(Heartbeat),
/// An indication that the stream should be closed.
#[prost(message, tag = "3")]
CloseStream(CloseStream),
}
}
/// Request message for Bigtable.ExecuteQuery
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecuteQueryRequest {
/// Required. The unique name of the instance against which the query should be
/// executed.
/// Values are of the form `projects/<project>/instances/<instance>`
#[prost(string, tag = "1")]
pub instance_name: ::prost::alloc::string::String,
/// Optional. This value specifies routing for replication. If not specified,
/// the `default` application profile will be used.
#[prost(string, tag = "2")]
pub app_profile_id: ::prost::alloc::string::String,
/// Required. The query string.
#[prost(string, tag = "3")]
pub query: ::prost::alloc::string::String,
/// Optional. If this request is resuming a previously interrupted query
/// execution, `resume_token` should be copied from the last
/// PartialResultSet yielded before the interruption. Doing this
/// enables the query execution to resume where the last one left
/// off.
/// The rest of the request parameters must exactly match the
/// request that yielded this token. Otherwise the request will fail.
#[prost(bytes = "bytes", tag = "8")]
pub resume_token: ::prost::bytes::Bytes,
/// Required. params contains string type keys and Bigtable type values that
/// bind to placeholders in the query string. In query string, a parameter
/// placeholder consists of the
/// `@` character followed by the parameter name (for example, `@firstName`) in
/// the query string.
///
/// For example, if
/// `params\["firstName"\] = bytes_value: "foo" type {bytes_type {}}`
/// then `@firstName` will be replaced with googlesql bytes value "foo" in the
/// query string during query evaluation.
///
/// In case of Value.kind is not set, it will be set to corresponding null
/// value in googlesql.
/// `params\["firstName"\] = type {string_type {}}`
/// then `@firstName` will be replaced with googlesql null string.
///
/// Value.type should always be set and no inference of type will be made from
/// Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT
/// error.
#[prost(btree_map = "string, message", tag = "7")]
pub params: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
Value,
>,
/// Required. Requested data format for the response.
#[prost(oneof = "execute_query_request::DataFormat", tags = "4")]
pub data_format: ::core::option::Option<execute_query_request::DataFormat>,
}
/// Nested message and enum types in `ExecuteQueryRequest`.
pub mod execute_query_request {
/// Required. Requested data format for the response.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum DataFormat {
/// Protocol buffer format as described by ProtoSchema and ProtoRows
/// messages.
#[prost(message, tag = "4")]
ProtoFormat(super::ProtoFormat),
}
}
/// Response message for Bigtable.ExecuteQuery
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecuteQueryResponse {
/// The first response streamed from the server is of type `ResultSetMetadata`
/// and includes information about the columns and types of the result set.
/// From there on, we stream `PartialResultSet` messages with no additional
/// information. `PartialResultSet` will contain `resume_token` to restart the
/// response if query interrupts. In case of resumption with `resume_token`,
/// the server will not resend the ResultSetMetadata.
#[prost(oneof = "execute_query_response::Response", tags = "1, 2")]
pub response: ::core::option::Option<execute_query_response::Response>,
}
/// Nested message and enum types in `ExecuteQueryResponse`.
pub mod execute_query_response {
/// The first response streamed from the server is of type `ResultSetMetadata`
/// and includes information about the columns and types of the result set.
/// From there on, we stream `PartialResultSet` messages with no additional
/// information. `PartialResultSet` will contain `resume_token` to restart the
/// response if query interrupts. In case of resumption with `resume_token`,
/// the server will not resend the ResultSetMetadata.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Response {
/// Structure of rows in this response stream. The first (and only the first)
/// response streamed from the server will be of this type.
#[prost(message, tag = "1")]
Metadata(super::ResultSetMetadata),
/// A partial result set with row data potentially including additional
/// instructions on how recent past and future partial responses should be
/// interpreted.
#[prost(message, tag = "2")]
Results(super::PartialResultSet),
}
}
/// Generated client implementations.
pub mod bigtable_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Service for reading from and writing to existing Bigtable tables.
#[derive(Debug, Clone)]
pub struct BigtableClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> BigtableClient<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,
) -> BigtableClient<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,
{
BigtableClient::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
}
/// Streams back the contents of all requested rows in key order, optionally
/// applying the same Reader filter to each. Depending on their size,
/// rows and cells may be broken up across multiple responses, but
/// atomicity of each row will still be preserved. See the
/// ReadRowsResponse documentation for details.
pub async fn read_rows(
&mut self,
request: impl tonic::IntoRequest<super::ReadRowsRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::ReadRowsResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/ReadRows",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.bigtable.v2.Bigtable", "ReadRows"));
self.inner.server_streaming(req, path, codec).await
}
/// Returns a sample of row keys in the table. The returned row keys will
/// delimit contiguous sections of the table of approximately equal size,
/// which can be used to break up the data for distributed tasks like
/// mapreduces.
pub async fn sample_row_keys(
&mut self,
request: impl tonic::IntoRequest<super::SampleRowKeysRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::SampleRowKeysResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/SampleRowKeys",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.bigtable.v2.Bigtable", "SampleRowKeys"));
self.inner.server_streaming(req, path, codec).await
}
/// Mutates a row atomically. Cells already present in the row are left
/// unchanged unless explicitly changed by `mutation`.
pub async fn mutate_row(
&mut self,
request: impl tonic::IntoRequest<super::MutateRowRequest>,
) -> std::result::Result<
tonic::Response<super::MutateRowResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/MutateRow",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.bigtable.v2.Bigtable", "MutateRow"));
self.inner.unary(req, path, codec).await
}
/// Mutates multiple rows in a batch. Each individual row is mutated
/// atomically as in MutateRow, but the entire batch is not executed
/// atomically.
pub async fn mutate_rows(
&mut self,
request: impl tonic::IntoRequest<super::MutateRowsRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::MutateRowsResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/MutateRows",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.bigtable.v2.Bigtable", "MutateRows"));
self.inner.server_streaming(req, path, codec).await
}
/// Mutates a row atomically based on the output of a predicate Reader filter.
pub async fn check_and_mutate_row(
&mut self,
request: impl tonic::IntoRequest<super::CheckAndMutateRowRequest>,
) -> std::result::Result<
tonic::Response<super::CheckAndMutateRowResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/CheckAndMutateRow",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.bigtable.v2.Bigtable", "CheckAndMutateRow"),
);
self.inner.unary(req, path, codec).await
}
/// Warm up associated instance metadata for this connection.
/// This call is not required but may be useful for connection keep-alive.
pub async fn ping_and_warm(
&mut self,
request: impl tonic::IntoRequest<super::PingAndWarmRequest>,
) -> std::result::Result<
tonic::Response<super::PingAndWarmResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/PingAndWarm",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.bigtable.v2.Bigtable", "PingAndWarm"));
self.inner.unary(req, path, codec).await
}
/// Modifies a row atomically on the server. The method reads the latest
/// existing timestamp and value from the specified columns and writes a new
/// entry based on pre-defined read/modify/write rules. The new value for the
/// timestamp is the greater of the existing timestamp or the current server
/// time. The method returns the new contents of all modified cells.
pub async fn read_modify_write_row(
&mut self,
request: impl tonic::IntoRequest<super::ReadModifyWriteRowRequest>,
) -> std::result::Result<
tonic::Response<super::ReadModifyWriteRowResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/ReadModifyWriteRow",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.bigtable.v2.Bigtable", "ReadModifyWriteRow"),
);
self.inner.unary(req, path, codec).await
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// Returns the current list of partitions that make up the table's
/// change stream. The union of partitions will cover the entire keyspace.
/// Partitions can be read with `ReadChangeStream`.
pub async fn generate_initial_change_stream_partitions(
&mut self,
request: impl tonic::IntoRequest<
super::GenerateInitialChangeStreamPartitionsRequest,
>,
) -> std::result::Result<
tonic::Response<
tonic::codec::Streaming<
super::GenerateInitialChangeStreamPartitionsResponse,
>,
>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/GenerateInitialChangeStreamPartitions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.bigtable.v2.Bigtable",
"GenerateInitialChangeStreamPartitions",
),
);
self.inner.server_streaming(req, path, codec).await
}
/// NOTE: This API is intended to be used by Apache Beam BigtableIO.
/// Reads changes from a table's change stream. Changes will
/// reflect both user-initiated mutations and mutations that are caused by
/// garbage collection.
pub async fn read_change_stream(
&mut self,
request: impl tonic::IntoRequest<super::ReadChangeStreamRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::ReadChangeStreamResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/ReadChangeStream",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.bigtable.v2.Bigtable", "ReadChangeStream"),
);
self.inner.server_streaming(req, path, codec).await
}
/// Executes a BTQL query against a particular Cloud Bigtable instance.
pub async fn execute_query(
&mut self,
request: impl tonic::IntoRequest<super::ExecuteQueryRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::ExecuteQueryResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.bigtable.v2.Bigtable/ExecuteQuery",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.bigtable.v2.Bigtable", "ExecuteQuery"));
self.inner.server_streaming(req, path, codec).await
}
}
}
/// Feature flags supported or enabled by a client.
/// This is intended to be sent as part of request metadata to assure the server
/// that certain behaviors are safe to enable. This proto is meant to be
/// serialized and websafe-base64 encoded under the `bigtable-features` metadata
/// key. The value will remain constant for the lifetime of a client and due to
/// HTTP2's HPACK compression, the request overhead will be tiny.
/// This is an internal implementation detail and should not be used by end users
/// directly.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FeatureFlags {
/// Notify the server that the client supports reverse scans. The server will
/// reject ReadRowsRequests with the reverse bit set when this is absent.
#[prost(bool, tag = "1")]
pub reverse_scans: bool,
/// Notify the server that the client enables batch write flow control by
/// requesting RateLimitInfo from MutateRowsResponse. Due to technical reasons,
/// this disables partial retries.
#[prost(bool, tag = "3")]
pub mutate_rows_rate_limit: bool,
/// Notify the server that the client enables batch write flow control by
/// requesting RateLimitInfo from MutateRowsResponse. With partial retries
/// enabled.
#[prost(bool, tag = "5")]
pub mutate_rows_rate_limit2: bool,
/// Notify the server that the client supports the last_scanned_row field
/// in ReadRowsResponse for long-running scans.
#[prost(bool, tag = "4")]
pub last_scanned_row_responses: bool,
/// Notify the server that the client supports using encoded routing cookie
/// strings to retry requests with.
#[prost(bool, tag = "6")]
pub routing_cookie: bool,
/// Notify the server that the client supports using retry info back off
/// durations to retry requests with.
#[prost(bool, tag = "7")]
pub retry_info: bool,
/// Notify the server that the client has client side metrics enabled.
#[prost(bool, tag = "8")]
pub client_side_metrics_enabled: bool,
}