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
// This file is @generated by prost-build.
/// Arrow schema as specified in
/// <https://arrow.apache.org/docs/python/api/datatypes.html>
/// and serialized to bytes using IPC:
/// <https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc>
///
/// See code samples on how this message can be deserialized.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ArrowSchema {
/// IPC serialized Arrow schema.
#[prost(bytes = "bytes", tag = "1")]
pub serialized_schema: ::prost::bytes::Bytes,
}
/// Arrow RecordBatch.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ArrowRecordBatch {
/// IPC-serialized Arrow RecordBatch.
#[prost(bytes = "bytes", tag = "1")]
pub serialized_record_batch: ::prost::bytes::Bytes,
/// \[Deprecated\] The count of rows in `serialized_record_batch`.
/// Please use the format-independent ReadRowsResponse.row_count instead.
#[deprecated]
#[prost(int64, tag = "2")]
pub row_count: i64,
}
/// Contains options specific to Arrow Serialization.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ArrowSerializationOptions {
/// The compression codec to use for Arrow buffers in serialized record
/// batches.
#[prost(enumeration = "arrow_serialization_options::CompressionCodec", tag = "2")]
pub buffer_compression: i32,
}
/// Nested message and enum types in `ArrowSerializationOptions`.
pub mod arrow_serialization_options {
/// Compression codec's supported by Arrow.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum CompressionCodec {
/// If unspecified no compression will be used.
CompressionUnspecified = 0,
/// LZ4 Frame (<https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md>)
Lz4Frame = 1,
/// Zstandard compression.
Zstd = 2,
}
impl CompressionCodec {
/// 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 {
CompressionCodec::CompressionUnspecified => "COMPRESSION_UNSPECIFIED",
CompressionCodec::Lz4Frame => "LZ4_FRAME",
CompressionCodec::Zstd => "ZSTD",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"COMPRESSION_UNSPECIFIED" => Some(Self::CompressionUnspecified),
"LZ4_FRAME" => Some(Self::Lz4Frame),
"ZSTD" => Some(Self::Zstd),
_ => None,
}
}
}
}
/// Schema of a table. This schema is a subset of
/// google.cloud.bigquery.v2.TableSchema containing information necessary to
/// generate valid message to write to BigQuery.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TableSchema {
/// Describes the fields in a table.
#[prost(message, repeated, tag = "1")]
pub fields: ::prost::alloc::vec::Vec<TableFieldSchema>,
}
/// TableFieldSchema defines a single field/column within a table schema.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TableFieldSchema {
/// Required. The field name. The name must contain only letters (a-z, A-Z),
/// numbers (0-9), or underscores (_), and must start with a letter or
/// underscore. The maximum length is 128 characters.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The field data type.
#[prost(enumeration = "table_field_schema::Type", tag = "2")]
pub r#type: i32,
/// Optional. The field mode. The default value is NULLABLE.
#[prost(enumeration = "table_field_schema::Mode", tag = "3")]
pub mode: i32,
/// Optional. Describes the nested schema fields if the type property is set to
/// STRUCT.
#[prost(message, repeated, tag = "4")]
pub fields: ::prost::alloc::vec::Vec<TableFieldSchema>,
/// Optional. The field description. The maximum length is 1,024 characters.
#[prost(string, tag = "6")]
pub description: ::prost::alloc::string::String,
/// Optional. Maximum length of values of this field for STRINGS or BYTES.
///
/// If max_length is not specified, no maximum length constraint is imposed
/// on this field.
///
/// If type = "STRING", then max_length represents the maximum UTF-8
/// length of strings in this field.
///
/// If type = "BYTES", then max_length represents the maximum number of
/// bytes in this field.
///
/// It is invalid to set this field if type is not "STRING" or "BYTES".
#[prost(int64, tag = "7")]
pub max_length: i64,
/// Optional. Precision (maximum number of total digits in base 10) and scale
/// (maximum number of digits in the fractional part in base 10) constraints
/// for values of this field for NUMERIC or BIGNUMERIC.
///
/// It is invalid to set precision or scale if type is not "NUMERIC" or
/// "BIGNUMERIC".
///
/// If precision and scale are not specified, no value range constraint is
/// imposed on this field insofar as values are permitted by the type.
///
/// Values of this NUMERIC or BIGNUMERIC field must be in this range when:
///
/// * Precision (P) and scale (S) are specified:
/// \[-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)\]
/// * Precision (P) is specified but not scale (and thus scale is
/// interpreted to be equal to zero):
/// \[-10^P + 1, 10^P - 1\].
///
/// Acceptable values for precision and scale if both are specified:
///
/// * If type = "NUMERIC":
/// 1 <= precision - scale <= 29 and 0 <= scale <= 9.
/// * If type = "BIGNUMERIC":
/// 1 <= precision - scale <= 38 and 0 <= scale <= 38.
///
/// Acceptable values for precision if only precision is specified but not
/// scale (and thus scale is interpreted to be equal to zero):
///
/// * If type = "NUMERIC": 1 <= precision <= 29.
/// * If type = "BIGNUMERIC": 1 <= precision <= 38.
///
/// If scale is specified but not precision, then it is invalid.
#[prost(int64, tag = "8")]
pub precision: i64,
/// Optional. See documentation for precision.
#[prost(int64, tag = "9")]
pub scale: i64,
/// Optional. A SQL expression to specify the \[default value\]
/// (<https://cloud.google.com/bigquery/docs/default-values>) for this field.
#[prost(string, tag = "10")]
pub default_value_expression: ::prost::alloc::string::String,
/// Optional. The subtype of the RANGE, if the type of this field is RANGE. If
/// the type is RANGE, this field is required. Possible values for the field
/// element type of a RANGE include:
/// * DATE
/// * DATETIME
/// * TIMESTAMP
#[prost(message, optional, tag = "11")]
pub range_element_type: ::core::option::Option<table_field_schema::FieldElementType>,
}
/// Nested message and enum types in `TableFieldSchema`.
pub mod table_field_schema {
/// Represents the type of a field element.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FieldElementType {
/// Required. The type of a field element.
#[prost(enumeration = "Type", tag = "1")]
pub r#type: i32,
}
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// Illegal value
Unspecified = 0,
/// 64K, UTF8
String = 1,
/// 64-bit signed
Int64 = 2,
/// 64-bit IEEE floating point
Double = 3,
/// Aggregate type
Struct = 4,
/// 64K, Binary
Bytes = 5,
/// 2-valued
Bool = 6,
/// 64-bit signed usec since UTC epoch
Timestamp = 7,
/// Civil date - Year, Month, Day
Date = 8,
/// Civil time - Hour, Minute, Second, Microseconds
Time = 9,
/// Combination of civil date and civil time
Datetime = 10,
/// Geography object
Geography = 11,
/// Numeric value
Numeric = 12,
/// BigNumeric value
Bignumeric = 13,
/// Interval
Interval = 14,
/// JSON, String
Json = 15,
/// RANGE
Range = 16,
}
impl Type {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::String => "STRING",
Type::Int64 => "INT64",
Type::Double => "DOUBLE",
Type::Struct => "STRUCT",
Type::Bytes => "BYTES",
Type::Bool => "BOOL",
Type::Timestamp => "TIMESTAMP",
Type::Date => "DATE",
Type::Time => "TIME",
Type::Datetime => "DATETIME",
Type::Geography => "GEOGRAPHY",
Type::Numeric => "NUMERIC",
Type::Bignumeric => "BIGNUMERIC",
Type::Interval => "INTERVAL",
Type::Json => "JSON",
Type::Range => "RANGE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"STRING" => Some(Self::String),
"INT64" => Some(Self::Int64),
"DOUBLE" => Some(Self::Double),
"STRUCT" => Some(Self::Struct),
"BYTES" => Some(Self::Bytes),
"BOOL" => Some(Self::Bool),
"TIMESTAMP" => Some(Self::Timestamp),
"DATE" => Some(Self::Date),
"TIME" => Some(Self::Time),
"DATETIME" => Some(Self::Datetime),
"GEOGRAPHY" => Some(Self::Geography),
"NUMERIC" => Some(Self::Numeric),
"BIGNUMERIC" => Some(Self::Bignumeric),
"INTERVAL" => Some(Self::Interval),
"JSON" => Some(Self::Json),
"RANGE" => Some(Self::Range),
_ => None,
}
}
}
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Mode {
/// Illegal value
Unspecified = 0,
Nullable = 1,
Required = 2,
Repeated = 3,
}
impl Mode {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Mode::Unspecified => "MODE_UNSPECIFIED",
Mode::Nullable => "NULLABLE",
Mode::Required => "REQUIRED",
Mode::Repeated => "REPEATED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MODE_UNSPECIFIED" => Some(Self::Unspecified),
"NULLABLE" => Some(Self::Nullable),
"REQUIRED" => Some(Self::Required),
"REPEATED" => Some(Self::Repeated),
_ => None,
}
}
}
}
/// Avro schema.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AvroSchema {
/// Json serialized schema, as described at
/// <https://avro.apache.org/docs/1.8.1/spec.html.>
#[prost(string, tag = "1")]
pub schema: ::prost::alloc::string::String,
}
/// Avro rows.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AvroRows {
/// Binary serialized rows in a block.
#[prost(bytes = "bytes", tag = "1")]
pub serialized_binary_rows: ::prost::bytes::Bytes,
/// \[Deprecated\] The count of rows in the returning block.
/// Please use the format-independent ReadRowsResponse.row_count instead.
#[deprecated]
#[prost(int64, tag = "2")]
pub row_count: i64,
}
/// Contains options specific to Avro Serialization.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AvroSerializationOptions {
/// Enable displayName attribute in Avro schema.
///
/// The Avro specification requires field names to be alphanumeric. By
/// default, in cases when column names do not conform to these requirements
/// (e.g. non-ascii unicode codepoints) and Avro is requested as an output
/// format, the CreateReadSession call will fail.
///
/// Setting this field to true, populates avro field names with a placeholder
/// value and populates a "displayName" attribute for every avro field with the
/// original column name.
#[prost(bool, tag = "1")]
pub enable_display_name_attribute: bool,
}
/// Information about the ReadSession.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadSession {
/// Output only. Unique identifier for the session, in the form
/// `projects/{project_id}/locations/{location}/sessions/{session_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Time at which the session becomes invalid. After this time,
/// subsequent requests to read this Session will return errors. The
/// expire_time is automatically assigned and currently cannot be specified or
/// updated.
#[prost(message, optional, tag = "2")]
pub expire_time: ::core::option::Option<::prost_types::Timestamp>,
/// Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not
/// supported.
#[prost(enumeration = "DataFormat", tag = "3")]
pub data_format: i32,
/// Immutable. Table that this ReadSession is reading from, in the form
/// `projects/{project_id}/datasets/{dataset_id}/tables/{table_id}`
#[prost(string, tag = "6")]
pub table: ::prost::alloc::string::String,
/// Optional. Any modifiers which are applied when reading from the specified
/// table.
#[prost(message, optional, tag = "7")]
pub table_modifiers: ::core::option::Option<read_session::TableModifiers>,
/// Optional. Read options for this session (e.g. column selection, filters).
#[prost(message, optional, tag = "8")]
pub read_options: ::core::option::Option<read_session::TableReadOptions>,
/// Output only. A list of streams created with the session.
///
/// At least one stream is created with the session. In the future, larger
/// request_stream_count values *may* result in this list being unpopulated,
/// in that case, the user will need to use a List method to get the streams
/// instead, which is not yet available.
#[prost(message, repeated, tag = "10")]
pub streams: ::prost::alloc::vec::Vec<ReadStream>,
/// Output only. An estimate on the number of bytes this session will scan when
/// all streams are completely consumed. This estimate is based on
/// metadata from the table which might be incomplete or stale.
#[prost(int64, tag = "12")]
pub estimated_total_bytes_scanned: i64,
/// Output only. A pre-projected estimate of the total physical size of files
/// (in bytes) that this session will scan when all streams are consumed. This
/// estimate is independent of the selected columns and can be based on
/// incomplete or stale metadata from the table. This field is only set for
/// BigLake tables.
#[prost(int64, tag = "15")]
pub estimated_total_physical_file_size: i64,
/// Output only. An estimate on the number of rows present in this session's
/// streams. This estimate is based on metadata from the table which might be
/// incomplete or stale.
#[prost(int64, tag = "14")]
pub estimated_row_count: i64,
/// Optional. ID set by client to annotate a session identity. This does not
/// need to be strictly unique, but instead the same ID should be used to group
/// logically connected sessions (e.g. All using the same ID for all sessions
/// needed to complete a Spark SQL query is reasonable).
///
/// Maximum length is 256 bytes.
#[prost(string, tag = "13")]
pub trace_id: ::prost::alloc::string::String,
/// The schema for the read. If read_options.selected_fields is set, the
/// schema may be different from the table schema as it will only contain
/// the selected fields.
#[prost(oneof = "read_session::Schema", tags = "4, 5")]
pub schema: ::core::option::Option<read_session::Schema>,
}
/// Nested message and enum types in `ReadSession`.
pub mod read_session {
/// Additional attributes when reading a table.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TableModifiers {
/// The snapshot time of the table. If not set, interpreted as now.
#[prost(message, optional, tag = "1")]
pub snapshot_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Options dictating how we read a table.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TableReadOptions {
/// Optional. The names of the fields in the table to be returned. If no
/// field names are specified, then all fields in the table are returned.
///
/// Nested fields -- the child elements of a STRUCT field -- can be selected
/// individually using their fully-qualified names, and will be returned as
/// record fields containing only the selected nested fields. If a STRUCT
/// field is specified in the selected fields list, all of the child elements
/// will be returned.
///
/// As an example, consider a table with the following schema:
///
/// {
/// "name": "struct_field",
/// "type": "RECORD",
/// "mode": "NULLABLE",
/// "fields": [
/// {
/// "name": "string_field1",
/// "type": "STRING",
/// . "mode": "NULLABLE"
/// },
/// {
/// "name": "string_field2",
/// "type": "STRING",
/// "mode": "NULLABLE"
/// }
/// ]
/// }
///
/// Specifying "struct_field" in the selected fields list will result in a
/// read session schema with the following logical structure:
///
/// struct_field {
/// string_field1
/// string_field2
/// }
///
/// Specifying "struct_field.string_field1" in the selected fields list will
/// result in a read session schema with the following logical structure:
///
/// struct_field {
/// string_field1
/// }
///
/// The order of the fields in the read session schema is derived from the
/// table schema and does not correspond to the order in which the fields are
/// specified in this list.
#[prost(string, repeated, tag = "1")]
pub selected_fields: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// SQL text filtering statement, similar to a WHERE clause in a query.
/// Aggregates are not supported.
///
/// Examples: "int_field > 5"
/// "date_field = CAST('2014-9-27' as DATE)"
/// "nullable_field is not NULL"
/// "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))"
/// "numeric_field BETWEEN 1.0 AND 5.0"
///
/// Restricted to a maximum length for 1 MB.
#[prost(string, tag = "2")]
pub row_restriction: ::prost::alloc::string::String,
/// Optional. Specifies a table sampling percentage. Specifically, the query
/// planner will use TABLESAMPLE SYSTEM (sample_percentage PERCENT). The
/// sampling percentage is applied at the data block granularity. It will
/// randomly choose for each data block whether to read the rows in that data
/// block. For more details, see
/// <https://cloud.google.com/bigquery/docs/table-sampling>)
#[prost(double, optional, tag = "5")]
pub sample_percentage: ::core::option::Option<f64>,
/// Optional. Set response_compression_codec when creating a read session to
/// enable application-level compression of ReadRows responses.
#[prost(
enumeration = "table_read_options::ResponseCompressionCodec",
optional,
tag = "6"
)]
pub response_compression_codec: ::core::option::Option<i32>,
#[prost(
oneof = "table_read_options::OutputFormatSerializationOptions",
tags = "3, 4"
)]
pub output_format_serialization_options: ::core::option::Option<
table_read_options::OutputFormatSerializationOptions,
>,
}
/// Nested message and enum types in `TableReadOptions`.
pub mod table_read_options {
/// Specifies which compression codec to attempt on the entire serialized
/// response payload (either Arrow record batch or Avro rows). This is
/// not to be confused with the Apache Arrow native compression codecs
/// specified in ArrowSerializationOptions. For performance reasons, when
/// creating a read session requesting Arrow responses, setting both native
/// Arrow compression and application-level response compression will not be
/// allowed - choose, at most, one kind of compression.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ResponseCompressionCodec {
/// Default is no compression.
Unspecified = 0,
/// Use raw LZ4 compression.
Lz4 = 2,
}
impl ResponseCompressionCodec {
/// 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 {
ResponseCompressionCodec::Unspecified => {
"RESPONSE_COMPRESSION_CODEC_UNSPECIFIED"
}
ResponseCompressionCodec::Lz4 => "RESPONSE_COMPRESSION_CODEC_LZ4",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RESPONSE_COMPRESSION_CODEC_UNSPECIFIED" => Some(Self::Unspecified),
"RESPONSE_COMPRESSION_CODEC_LZ4" => Some(Self::Lz4),
_ => None,
}
}
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum OutputFormatSerializationOptions {
/// Optional. Options specific to the Apache Arrow output format.
#[prost(message, tag = "3")]
ArrowSerializationOptions(super::super::ArrowSerializationOptions),
/// Optional. Options specific to the Apache Avro output format
#[prost(message, tag = "4")]
AvroSerializationOptions(super::super::AvroSerializationOptions),
}
}
/// The schema for the read. If read_options.selected_fields is set, the
/// schema may be different from the table schema as it will only contain
/// the selected fields.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Schema {
/// Output only. Avro schema.
#[prost(message, tag = "4")]
AvroSchema(super::AvroSchema),
/// Output only. Arrow schema.
#[prost(message, tag = "5")]
ArrowSchema(super::ArrowSchema),
}
}
/// Information about a single stream that gets data out of the storage system.
/// Most of the information about `ReadStream` instances is aggregated, making
/// `ReadStream` lightweight.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadStream {
/// Output only. Name of the stream, in the form
/// `projects/{project_id}/locations/{location}/sessions/{session_id}/streams/{stream_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Information about a single stream that gets data inside the storage system.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WriteStream {
/// Output only. Name of the stream, in the form
/// `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Immutable. Type of the stream.
#[prost(enumeration = "write_stream::Type", tag = "2")]
pub r#type: i32,
/// Output only. Create time of the stream. For the _default stream, this is
/// the creation_time of the table.
#[prost(message, optional, tag = "3")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Commit time of the stream.
/// If a stream is of `COMMITTED` type, then it will have a commit_time same as
/// `create_time`. If the stream is of `PENDING` type, empty commit_time
/// means it is not committed.
#[prost(message, optional, tag = "4")]
pub commit_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The schema of the destination table. It is only returned in
/// `CreateWriteStream` response. Caller should generate data that's
/// compatible with this schema to send in initial `AppendRowsRequest`.
/// The table schema could go out of date during the life time of the stream.
#[prost(message, optional, tag = "5")]
pub table_schema: ::core::option::Option<TableSchema>,
/// Immutable. Mode of the stream.
#[prost(enumeration = "write_stream::WriteMode", tag = "7")]
pub write_mode: i32,
/// Immutable. The geographic location where the stream's dataset resides. See
/// <https://cloud.google.com/bigquery/docs/locations> for supported
/// locations.
#[prost(string, tag = "8")]
pub location: ::prost::alloc::string::String,
}
/// Nested message and enum types in `WriteStream`.
pub mod write_stream {
/// Type enum of the stream.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// Unknown type.
Unspecified = 0,
/// Data will commit automatically and appear as soon as the write is
/// acknowledged.
Committed = 1,
/// Data is invisible until the stream is committed.
Pending = 2,
/// Data is only visible up to the offset to which it was flushed.
Buffered = 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::Committed => "COMMITTED",
Type::Pending => "PENDING",
Type::Buffered => "BUFFERED",
}
}
/// 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),
"COMMITTED" => Some(Self::Committed),
"PENDING" => Some(Self::Pending),
"BUFFERED" => Some(Self::Buffered),
_ => None,
}
}
}
/// Mode enum of the stream.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum WriteMode {
/// Unknown type.
Unspecified = 0,
/// Insert new records into the table.
/// It is the default value if customers do not specify it.
Insert = 1,
}
impl WriteMode {
/// 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 {
WriteMode::Unspecified => "WRITE_MODE_UNSPECIFIED",
WriteMode::Insert => "INSERT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"WRITE_MODE_UNSPECIFIED" => Some(Self::Unspecified),
"INSERT" => Some(Self::Insert),
_ => None,
}
}
}
}
/// Data format for input or output data.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum DataFormat {
/// Data format is unspecified.
Unspecified = 0,
/// Avro is a standard open source row based file format.
/// See <https://avro.apache.org/> for more details.
Avro = 1,
/// Arrow is a standard open source column-based message format.
/// See <https://arrow.apache.org/> for more details.
Arrow = 2,
}
impl DataFormat {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
DataFormat::Unspecified => "DATA_FORMAT_UNSPECIFIED",
DataFormat::Avro => "AVRO",
DataFormat::Arrow => "ARROW",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DATA_FORMAT_UNSPECIFIED" => Some(Self::Unspecified),
"AVRO" => Some(Self::Avro),
"ARROW" => Some(Self::Arrow),
_ => None,
}
}
}
/// WriteStreamView is a view enum that controls what details about a write
/// stream should be returned.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum WriteStreamView {
/// The default / unset value.
Unspecified = 0,
/// The BASIC projection returns basic metadata about a write stream. The
/// basic view does not include schema information. This is the default view
/// returned by GetWriteStream.
Basic = 1,
/// The FULL projection returns all available write stream metadata, including
/// the schema. CreateWriteStream returns the full projection of write stream
/// metadata.
Full = 2,
}
impl WriteStreamView {
/// 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 {
WriteStreamView::Unspecified => "WRITE_STREAM_VIEW_UNSPECIFIED",
WriteStreamView::Basic => "BASIC",
WriteStreamView::Full => "FULL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"WRITE_STREAM_VIEW_UNSPECIFIED" => Some(Self::Unspecified),
"BASIC" => Some(Self::Basic),
"FULL" => Some(Self::Full),
_ => None,
}
}
}
/// ProtoSchema describes the schema of the serialized protocol buffer data rows.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProtoSchema {
/// Descriptor for input message. The provided descriptor must be self
/// contained, such that data rows sent can be fully decoded using only the
/// single descriptor. For data rows that are compositions of multiple
/// independent messages, this means the descriptor may need to be transformed
/// to only use nested types:
/// <https://developers.google.com/protocol-buffers/docs/proto#nested>
///
/// For additional information for how proto types and values map onto BigQuery
/// see: <https://cloud.google.com/bigquery/docs/write-api#data_type_conversions>
#[prost(message, optional, tag = "1")]
pub proto_descriptor: ::core::option::Option<::prost_types::DescriptorProto>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProtoRows {
/// A sequence of rows serialized as a Protocol Buffer.
///
/// See <https://developers.google.com/protocol-buffers/docs/overview> for more
/// information on deserializing this field.
#[prost(bytes = "bytes", repeated, tag = "1")]
pub serialized_rows: ::prost::alloc::vec::Vec<::prost::bytes::Bytes>,
}
/// Request message for `CreateReadSession`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateReadSessionRequest {
/// Required. The request project that owns the session, in the form of
/// `projects/{project_id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Session to be created.
#[prost(message, optional, tag = "2")]
pub read_session: ::core::option::Option<ReadSession>,
/// Max initial number of streams. If unset or zero, the server will
/// provide a value of streams so as to produce reasonable throughput. Must be
/// non-negative. The number of streams may be lower than the requested number,
/// depending on the amount parallelism that is reasonable for the table.
/// There is a default system max limit of 1,000.
///
/// This must be greater than or equal to preferred_min_stream_count.
/// Typically, clients should either leave this unset to let the system to
/// determine an upper bound OR set this a size for the maximum "units of work"
/// it can gracefully handle.
#[prost(int32, tag = "3")]
pub max_stream_count: i32,
/// The minimum preferred stream count. This parameter can be used to inform
/// the service that there is a desired lower bound on the number of streams.
/// This is typically a target parallelism of the client (e.g. a Spark
/// cluster with N-workers would set this to a low multiple of N to ensure
/// good cluster utilization).
///
/// The system will make a best effort to provide at least this number of
/// streams, but in some cases might provide less.
#[prost(int32, tag = "4")]
pub preferred_min_stream_count: i32,
}
/// Request message for `ReadRows`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadRowsRequest {
/// Required. Stream to read rows from.
#[prost(string, tag = "1")]
pub read_stream: ::prost::alloc::string::String,
/// The offset requested must be less than the last row read from Read.
/// Requesting a larger offset is undefined. If not specified, start reading
/// from offset zero.
#[prost(int64, tag = "2")]
pub offset: i64,
}
/// Information on if the current connection is being throttled.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ThrottleState {
/// How much this connection is being throttled. Zero means no throttling,
/// 100 means fully throttled.
#[prost(int32, tag = "1")]
pub throttle_percent: i32,
}
/// Estimated stream statistics for a given read Stream.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamStats {
/// Represents the progress of the current stream.
#[prost(message, optional, tag = "2")]
pub progress: ::core::option::Option<stream_stats::Progress>,
}
/// Nested message and enum types in `StreamStats`.
pub mod stream_stats {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Progress {
/// The fraction of rows assigned to the stream that have been processed by
/// the server so far, not including the rows in the current response
/// message.
///
/// This value, along with `at_response_end`, can be used to interpolate
/// the progress made as the rows in the message are being processed using
/// the following formula: `at_response_start + (at_response_end -
/// at_response_start) * rows_processed_from_response / rows_in_response`.
///
/// Note that if a filter is provided, the `at_response_end` value of the
/// previous response may not necessarily be equal to the
/// `at_response_start` value of the current response.
#[prost(double, tag = "1")]
pub at_response_start: f64,
/// Similar to `at_response_start`, except that this value includes the
/// rows in the current response.
#[prost(double, tag = "2")]
pub at_response_end: f64,
}
}
/// Response from calling `ReadRows` may include row data, progress and
/// throttling information.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadRowsResponse {
/// Number of serialized rows in the rows block.
#[prost(int64, tag = "6")]
pub row_count: i64,
/// Statistics for the stream.
#[prost(message, optional, tag = "2")]
pub stats: ::core::option::Option<StreamStats>,
/// Throttling state. If unset, the latest response still describes
/// the current throttling status.
#[prost(message, optional, tag = "5")]
pub throttle_state: ::core::option::Option<ThrottleState>,
/// Optional. If the row data in this ReadRowsResponse is compressed, then
/// uncompressed byte size is the original size of the uncompressed row data.
/// If it is set to a value greater than 0, then decompress into a buffer of
/// size uncompressed_byte_size using the compression codec that was requested
/// during session creation time and which is specified in
/// TableReadOptions.response_compression_codec in ReadSession.
/// This value is not set if no response_compression_codec was not requested
/// and it is -1 if the requested compression would not have reduced the size
/// of this ReadRowsResponse's row data. This attempts to match Apache Arrow's
/// behavior described here <https://github.com/apache/arrow/issues/15102> where
/// the uncompressed length may be set to -1 to indicate that the data that
/// follows is not compressed, which can be useful for cases where compression
/// does not yield appreciable savings. When uncompressed_byte_size is not
/// greater than 0, the client should skip decompression.
#[prost(int64, optional, tag = "9")]
pub uncompressed_byte_size: ::core::option::Option<i64>,
/// Row data is returned in format specified during session creation.
#[prost(oneof = "read_rows_response::Rows", tags = "3, 4")]
pub rows: ::core::option::Option<read_rows_response::Rows>,
/// The schema for the read. If read_options.selected_fields is set, the
/// schema may be different from the table schema as it will only contain
/// the selected fields. This schema is equivalent to the one returned by
/// CreateSession. This field is only populated in the first ReadRowsResponse
/// RPC.
#[prost(oneof = "read_rows_response::Schema", tags = "7, 8")]
pub schema: ::core::option::Option<read_rows_response::Schema>,
}
/// Nested message and enum types in `ReadRowsResponse`.
pub mod read_rows_response {
/// Row data is returned in format specified during session creation.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Rows {
/// Serialized row data in AVRO format.
#[prost(message, tag = "3")]
AvroRows(super::AvroRows),
/// Serialized row data in Arrow RecordBatch format.
#[prost(message, tag = "4")]
ArrowRecordBatch(super::ArrowRecordBatch),
}
/// The schema for the read. If read_options.selected_fields is set, the
/// schema may be different from the table schema as it will only contain
/// the selected fields. This schema is equivalent to the one returned by
/// CreateSession. This field is only populated in the first ReadRowsResponse
/// RPC.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Schema {
/// Output only. Avro schema.
#[prost(message, tag = "7")]
AvroSchema(super::AvroSchema),
/// Output only. Arrow schema.
#[prost(message, tag = "8")]
ArrowSchema(super::ArrowSchema),
}
}
/// Request message for `SplitReadStream`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SplitReadStreamRequest {
/// Required. Name of the stream to split.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// A value in the range (0.0, 1.0) that specifies the fractional point at
/// which the original stream should be split. The actual split point is
/// evaluated on pre-filtered rows, so if a filter is provided, then there is
/// no guarantee that the division of the rows between the new child streams
/// will be proportional to this fractional value. Additionally, because the
/// server-side unit for assigning data is collections of rows, this fraction
/// will always map to a data storage boundary on the server side.
#[prost(double, tag = "2")]
pub fraction: f64,
}
/// Response message for `SplitReadStream`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SplitReadStreamResponse {
/// Primary stream, which contains the beginning portion of
/// |original_stream|. An empty value indicates that the original stream can no
/// longer be split.
#[prost(message, optional, tag = "1")]
pub primary_stream: ::core::option::Option<ReadStream>,
/// Remainder stream, which contains the tail of |original_stream|. An empty
/// value indicates that the original stream can no longer be split.
#[prost(message, optional, tag = "2")]
pub remainder_stream: ::core::option::Option<ReadStream>,
}
/// Request message for `CreateWriteStream`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateWriteStreamRequest {
/// Required. Reference to the table to which the stream belongs, in the format
/// of `projects/{project}/datasets/{dataset}/tables/{table}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Stream to be created.
#[prost(message, optional, tag = "2")]
pub write_stream: ::core::option::Option<WriteStream>,
}
/// Request message for `AppendRows`.
///
/// Because AppendRows is a bidirectional streaming RPC, certain parts of the
/// AppendRowsRequest need only be specified for the first request before
/// switching table destinations. You can also switch table destinations within
/// the same connection for the default stream.
///
/// The size of a single AppendRowsRequest must be less than 10 MB in size.
/// Requests larger than this return an error, typically `INVALID_ARGUMENT`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AppendRowsRequest {
/// Required. The write_stream identifies the append operation. It must be
/// provided in the following scenarios:
///
/// * In the first request to an AppendRows connection.
///
/// * In all subsequent requests to an AppendRows connection, if you use the
/// same connection to write to multiple tables or change the input schema for
/// default streams.
///
/// For explicitly created write streams, the format is:
///
/// * `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`
///
/// For the special default stream, the format is:
///
/// * `projects/{project}/datasets/{dataset}/tables/{table}/streams/_default`.
///
/// An example of a possible sequence of requests with write_stream fields
/// within a single connection:
///
/// * r1: {write_stream: stream_name_1}
///
/// * r2: {write_stream: /*omit*/}
///
/// * r3: {write_stream: /*omit*/}
///
/// * r4: {write_stream: stream_name_2}
///
/// * r5: {write_stream: stream_name_2}
///
/// The destination changed in request_4, so the write_stream field must be
/// populated in all subsequent requests in this stream.
#[prost(string, tag = "1")]
pub write_stream: ::prost::alloc::string::String,
/// If present, the write is only performed if the next append offset is same
/// as the provided value. If not present, the write is performed at the
/// current end of stream. Specifying a value for this field is not allowed
/// when calling AppendRows for the '_default' stream.
#[prost(message, optional, tag = "2")]
pub offset: ::core::option::Option<i64>,
/// Id set by client to annotate its identity. Only initial request setting is
/// respected.
#[prost(string, tag = "6")]
pub trace_id: ::prost::alloc::string::String,
/// A map to indicate how to interpret missing value for some fields. Missing
/// values are fields present in user schema but missing in rows. The key is
/// the field name. The value is the interpretation of missing values for the
/// field.
///
/// For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
/// missing values in field foo are interpreted as NULL, all missing values in
/// field bar are interpreted as the default value of field bar in table
/// schema.
///
/// If a field is not in this map and has missing values, the missing values
/// in this field are interpreted as NULL.
///
/// This field only applies to the current request, it won't affect other
/// requests on the connection.
///
/// Currently, field name can only be top-level column name, can't be a struct
/// field path like 'foo.bar'.
#[prost(
btree_map = "string, enumeration(append_rows_request::MissingValueInterpretation)",
tag = "7"
)]
pub missing_value_interpretations: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
i32,
>,
/// Optional. Default missing value interpretation for all columns in the
/// table. When a value is specified on an `AppendRowsRequest`, it is applied
/// to all requests on the connection from that point forward, until a
/// subsequent `AppendRowsRequest` sets it to a different value.
/// `missing_value_interpretation` can override
/// `default_missing_value_interpretation`. For example, if you want to write
/// `NULL` instead of using default values for some columns, you can set
/// `default_missing_value_interpretation` to `DEFAULT_VALUE` and at the same
/// time, set `missing_value_interpretations` to `NULL_VALUE` on those columns.
#[prost(enumeration = "append_rows_request::MissingValueInterpretation", tag = "8")]
pub default_missing_value_interpretation: i32,
/// Input rows. The `writer_schema` field must be specified at the initial
/// request and currently, it will be ignored if specified in following
/// requests. Following requests must have data in the same format as the
/// initial request.
#[prost(oneof = "append_rows_request::Rows", tags = "4")]
pub rows: ::core::option::Option<append_rows_request::Rows>,
}
/// Nested message and enum types in `AppendRowsRequest`.
pub mod append_rows_request {
/// ProtoData contains the data rows and schema when constructing append
/// requests.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProtoData {
/// The protocol buffer schema used to serialize the data. Provide this value
/// whenever:
///
/// * You send the first request of an RPC connection.
///
/// * You change the input schema.
///
/// * You specify a new destination table.
#[prost(message, optional, tag = "1")]
pub writer_schema: ::core::option::Option<super::ProtoSchema>,
/// Serialized row data in protobuf message format.
/// Currently, the backend expects the serialized rows to adhere to
/// proto2 semantics when appending rows, particularly with respect to
/// how default values are encoded.
#[prost(message, optional, tag = "2")]
pub rows: ::core::option::Option<super::ProtoRows>,
}
/// An enum to indicate how to interpret missing values of fields that are
/// present in user schema but missing in rows. A missing value can represent a
/// NULL or a column default value defined in BigQuery table schema.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum MissingValueInterpretation {
/// Invalid missing value interpretation. Requests with this value will be
/// rejected.
Unspecified = 0,
/// Missing value is interpreted as NULL.
NullValue = 1,
/// Missing value is interpreted as column default value if declared in the
/// table schema, NULL otherwise.
DefaultValue = 2,
}
impl MissingValueInterpretation {
/// 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 {
MissingValueInterpretation::Unspecified => {
"MISSING_VALUE_INTERPRETATION_UNSPECIFIED"
}
MissingValueInterpretation::NullValue => "NULL_VALUE",
MissingValueInterpretation::DefaultValue => "DEFAULT_VALUE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MISSING_VALUE_INTERPRETATION_UNSPECIFIED" => Some(Self::Unspecified),
"NULL_VALUE" => Some(Self::NullValue),
"DEFAULT_VALUE" => Some(Self::DefaultValue),
_ => None,
}
}
}
/// Input rows. The `writer_schema` field must be specified at the initial
/// request and currently, it will be ignored if specified in following
/// requests. Following requests must have data in the same format as the
/// initial request.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Rows {
/// Rows in proto format.
#[prost(message, tag = "4")]
ProtoRows(ProtoData),
}
}
/// Response message for `AppendRows`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AppendRowsResponse {
/// If backend detects a schema update, pass it to user so that user can
/// use it to input new type of message. It will be empty when no schema
/// updates have occurred.
#[prost(message, optional, tag = "3")]
pub updated_schema: ::core::option::Option<TableSchema>,
/// If a request failed due to corrupted rows, no rows in the batch will be
/// appended. The API will return row level error info, so that the caller can
/// remove the bad rows and retry the request.
#[prost(message, repeated, tag = "4")]
pub row_errors: ::prost::alloc::vec::Vec<RowError>,
/// The target of the append operation. Matches the write_stream in the
/// corresponding request.
#[prost(string, tag = "5")]
pub write_stream: ::prost::alloc::string::String,
#[prost(oneof = "append_rows_response::Response", tags = "1, 2")]
pub response: ::core::option::Option<append_rows_response::Response>,
}
/// Nested message and enum types in `AppendRowsResponse`.
pub mod append_rows_response {
/// AppendResult is returned for successful append requests.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AppendResult {
/// The row offset at which the last append occurred. The offset will not be
/// set if appending using default streams.
#[prost(message, optional, tag = "1")]
pub offset: ::core::option::Option<i64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Response {
/// Result if the append is successful.
#[prost(message, tag = "1")]
AppendResult(AppendResult),
/// Error returned when problems were encountered. If present,
/// it indicates rows were not accepted into the system.
/// Users can retry or continue with other append requests within the
/// same connection.
///
/// Additional information about error signalling:
///
/// ALREADY_EXISTS: Happens when an append specified an offset, and the
/// backend already has received data at this offset. Typically encountered
/// in retry scenarios, and can be ignored.
///
/// OUT_OF_RANGE: Returned when the specified offset in the stream is beyond
/// the current end of the stream.
///
/// INVALID_ARGUMENT: Indicates a malformed request or data.
///
/// ABORTED: Request processing is aborted because of prior failures. The
/// request can be retried if previous failure is addressed.
///
/// INTERNAL: Indicates server side error(s) that can be retried.
#[prost(message, tag = "2")]
Error(super::super::super::super::super::rpc::Status),
}
}
/// Request message for `GetWriteStreamRequest`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetWriteStreamRequest {
/// Required. Name of the stream to get, in the form of
/// `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Indicates whether to get full or partial view of the WriteStream. If
/// not set, view returned will be basic.
#[prost(enumeration = "WriteStreamView", tag = "3")]
pub view: i32,
}
/// Request message for `BatchCommitWriteStreams`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCommitWriteStreamsRequest {
/// Required. Parent table that all the streams should belong to, in the form
/// of `projects/{project}/datasets/{dataset}/tables/{table}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The group of streams that will be committed atomically.
#[prost(string, repeated, tag = "2")]
pub write_streams: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for `BatchCommitWriteStreams`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCommitWriteStreamsResponse {
/// The time at which streams were committed in microseconds granularity.
/// This field will only exist when there are no stream errors.
/// **Note** if this field is not set, it means the commit was not successful.
#[prost(message, optional, tag = "1")]
pub commit_time: ::core::option::Option<::prost_types::Timestamp>,
/// Stream level error if commit failed. Only streams with error will be in
/// the list.
/// If empty, there is no error and all streams are committed successfully.
/// If non empty, certain streams have errors and ZERO stream is committed due
/// to atomicity guarantee.
#[prost(message, repeated, tag = "2")]
pub stream_errors: ::prost::alloc::vec::Vec<StorageError>,
}
/// Request message for invoking `FinalizeWriteStream`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FinalizeWriteStreamRequest {
/// Required. Name of the stream to finalize, in the form of
/// `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Response message for `FinalizeWriteStream`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FinalizeWriteStreamResponse {
/// Number of rows in the finalized stream.
#[prost(int64, tag = "1")]
pub row_count: i64,
}
/// Request message for `FlushRows`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FlushRowsRequest {
/// Required. The stream that is the target of the flush operation.
#[prost(string, tag = "1")]
pub write_stream: ::prost::alloc::string::String,
/// Ending offset of the flush operation. Rows before this offset(including
/// this offset) will be flushed.
#[prost(message, optional, tag = "2")]
pub offset: ::core::option::Option<i64>,
}
/// Respond message for `FlushRows`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FlushRowsResponse {
/// The rows before this offset (including this offset) are flushed.
#[prost(int64, tag = "1")]
pub offset: i64,
}
/// Structured custom BigQuery Storage error message. The error can be attached
/// as error details in the returned rpc Status. In particular, the use of error
/// codes allows more structured error handling, and reduces the need to evaluate
/// unstructured error text strings.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StorageError {
/// BigQuery Storage specific error code.
#[prost(enumeration = "storage_error::StorageErrorCode", tag = "1")]
pub code: i32,
/// Name of the failed entity.
#[prost(string, tag = "2")]
pub entity: ::prost::alloc::string::String,
/// Message that describes the error.
#[prost(string, tag = "3")]
pub error_message: ::prost::alloc::string::String,
}
/// Nested message and enum types in `StorageError`.
pub mod storage_error {
/// Error code for `StorageError`.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum StorageErrorCode {
/// Default error.
Unspecified = 0,
/// Table is not found in the system.
TableNotFound = 1,
/// Stream is already committed.
StreamAlreadyCommitted = 2,
/// Stream is not found.
StreamNotFound = 3,
/// Invalid Stream type.
/// For example, you try to commit a stream that is not pending.
InvalidStreamType = 4,
/// Invalid Stream state.
/// For example, you try to commit a stream that is not finalized or is
/// garbaged.
InvalidStreamState = 5,
/// Stream is finalized.
StreamFinalized = 6,
/// There is a schema mismatch and it is caused by user schema has extra
/// field than bigquery schema.
SchemaMismatchExtraFields = 7,
/// Offset already exists.
OffsetAlreadyExists = 8,
/// Offset out of range.
OffsetOutOfRange = 9,
/// Customer-managed encryption key (CMEK) not provided for CMEK-enabled
/// data.
CmekNotProvided = 10,
/// Customer-managed encryption key (CMEK) was incorrectly provided.
InvalidCmekProvided = 11,
/// There is an encryption error while using customer-managed encryption key.
CmekEncryptionError = 12,
/// Key Management Service (KMS) service returned an error, which can be
/// retried.
KmsServiceError = 13,
/// Permission denied while using customer-managed encryption key.
KmsPermissionDenied = 14,
}
impl StorageErrorCode {
/// 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 {
StorageErrorCode::Unspecified => "STORAGE_ERROR_CODE_UNSPECIFIED",
StorageErrorCode::TableNotFound => "TABLE_NOT_FOUND",
StorageErrorCode::StreamAlreadyCommitted => "STREAM_ALREADY_COMMITTED",
StorageErrorCode::StreamNotFound => "STREAM_NOT_FOUND",
StorageErrorCode::InvalidStreamType => "INVALID_STREAM_TYPE",
StorageErrorCode::InvalidStreamState => "INVALID_STREAM_STATE",
StorageErrorCode::StreamFinalized => "STREAM_FINALIZED",
StorageErrorCode::SchemaMismatchExtraFields => {
"SCHEMA_MISMATCH_EXTRA_FIELDS"
}
StorageErrorCode::OffsetAlreadyExists => "OFFSET_ALREADY_EXISTS",
StorageErrorCode::OffsetOutOfRange => "OFFSET_OUT_OF_RANGE",
StorageErrorCode::CmekNotProvided => "CMEK_NOT_PROVIDED",
StorageErrorCode::InvalidCmekProvided => "INVALID_CMEK_PROVIDED",
StorageErrorCode::CmekEncryptionError => "CMEK_ENCRYPTION_ERROR",
StorageErrorCode::KmsServiceError => "KMS_SERVICE_ERROR",
StorageErrorCode::KmsPermissionDenied => "KMS_PERMISSION_DENIED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STORAGE_ERROR_CODE_UNSPECIFIED" => Some(Self::Unspecified),
"TABLE_NOT_FOUND" => Some(Self::TableNotFound),
"STREAM_ALREADY_COMMITTED" => Some(Self::StreamAlreadyCommitted),
"STREAM_NOT_FOUND" => Some(Self::StreamNotFound),
"INVALID_STREAM_TYPE" => Some(Self::InvalidStreamType),
"INVALID_STREAM_STATE" => Some(Self::InvalidStreamState),
"STREAM_FINALIZED" => Some(Self::StreamFinalized),
"SCHEMA_MISMATCH_EXTRA_FIELDS" => Some(Self::SchemaMismatchExtraFields),
"OFFSET_ALREADY_EXISTS" => Some(Self::OffsetAlreadyExists),
"OFFSET_OUT_OF_RANGE" => Some(Self::OffsetOutOfRange),
"CMEK_NOT_PROVIDED" => Some(Self::CmekNotProvided),
"INVALID_CMEK_PROVIDED" => Some(Self::InvalidCmekProvided),
"CMEK_ENCRYPTION_ERROR" => Some(Self::CmekEncryptionError),
"KMS_SERVICE_ERROR" => Some(Self::KmsServiceError),
"KMS_PERMISSION_DENIED" => Some(Self::KmsPermissionDenied),
_ => None,
}
}
}
}
/// The message that presents row level error info in a request.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RowError {
/// Index of the malformed row in the request.
#[prost(int64, tag = "1")]
pub index: i64,
/// Structured error reason for a row error.
#[prost(enumeration = "row_error::RowErrorCode", tag = "2")]
pub code: i32,
/// Description of the issue encountered when processing the row.
#[prost(string, tag = "3")]
pub message: ::prost::alloc::string::String,
}
/// Nested message and enum types in `RowError`.
pub mod row_error {
/// Error code for `RowError`.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum RowErrorCode {
/// Default error.
Unspecified = 0,
/// One or more fields in the row has errors.
FieldsError = 1,
}
impl RowErrorCode {
/// 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 {
RowErrorCode::Unspecified => "ROW_ERROR_CODE_UNSPECIFIED",
RowErrorCode::FieldsError => "FIELDS_ERROR",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ROW_ERROR_CODE_UNSPECIFIED" => Some(Self::Unspecified),
"FIELDS_ERROR" => Some(Self::FieldsError),
_ => None,
}
}
}
}
/// Generated client implementations.
pub mod big_query_read_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// BigQuery Read API.
///
/// The Read API can be used to read data from BigQuery.
#[derive(Debug, Clone)]
pub struct BigQueryReadClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> BigQueryReadClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + 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,
) -> BigQueryReadClient<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> + Send + Sync,
{
BigQueryReadClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Creates a new read session. A read session divides the contents of a
/// BigQuery table into one or more streams, which can then be used to read
/// data from the table. The read session also specifies properties of the
/// data to be read, such as a list of columns or a push-down filter describing
/// the rows to be returned.
///
/// A particular row can be read by at most one stream. When the caller has
/// reached the end of each stream in the session, then all the data in the
/// table has been read.
///
/// Data is assigned to each stream such that roughly the same number of
/// rows can be read from each stream. Because the server-side unit for
/// assigning data is collections of rows, the API does not guarantee that
/// each stream will return the same number or rows. Additionally, the
/// limits are enforced based on the number of pre-filtered rows, so some
/// filters can lead to lopsided assignments.
///
/// Read sessions automatically expire 6 hours after they are created and do
/// not require manual clean-up by the caller.
pub async fn create_read_session(
&mut self,
request: impl tonic::IntoRequest<super::CreateReadSessionRequest>,
) -> std::result::Result<tonic::Response<super::ReadSession>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.bigquery.storage.v1.BigQueryRead/CreateReadSession",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryRead",
"CreateReadSession",
),
);
self.inner.unary(req, path, codec).await
}
/// Reads rows from the stream in the format prescribed by the ReadSession.
/// Each response contains one or more table rows, up to a maximum of 100 MiB
/// per response; read requests which attempt to read individual rows larger
/// than 100 MiB will fail.
///
/// Each request also returns a set of stream statistics reflecting the current
/// state of the stream.
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.cloud.bigquery.storage.v1.BigQueryRead/ReadRows",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryRead",
"ReadRows",
),
);
self.inner.server_streaming(req, path, codec).await
}
/// Splits a given `ReadStream` into two `ReadStream` objects. These
/// `ReadStream` objects are referred to as the primary and the residual
/// streams of the split. The original `ReadStream` can still be read from in
/// the same manner as before. Both of the returned `ReadStream` objects can
/// also be read from, and the rows returned by both child streams will be
/// the same as the rows read from the original stream.
///
/// Moreover, the two child streams will be allocated back-to-back in the
/// original `ReadStream`. Concretely, it is guaranteed that for streams
/// original, primary, and residual, that original[0-j] = primary[0-j] and
/// original[j-n] = residual[0-m] once the streams have been read to
/// completion.
pub async fn split_read_stream(
&mut self,
request: impl tonic::IntoRequest<super::SplitReadStreamRequest>,
) -> std::result::Result<
tonic::Response<super::SplitReadStreamResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.bigquery.storage.v1.BigQueryRead/SplitReadStream",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryRead",
"SplitReadStream",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Generated client implementations.
pub mod big_query_write_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// BigQuery Write API.
///
/// The Write API can be used to write data to BigQuery.
///
/// For supplementary information about the Write API, see:
/// https://cloud.google.com/bigquery/docs/write-api
#[derive(Debug, Clone)]
pub struct BigQueryWriteClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> BigQueryWriteClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + 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,
) -> BigQueryWriteClient<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> + Send + Sync,
{
BigQueryWriteClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Creates a write stream to the given table.
/// Additionally, every table has a special stream named '_default'
/// to which data can be written. This stream doesn't need to be created using
/// CreateWriteStream. It is a stream that can be used simultaneously by any
/// number of clients. Data written to this stream is considered committed as
/// soon as an acknowledgement is received.
pub async fn create_write_stream(
&mut self,
request: impl tonic::IntoRequest<super::CreateWriteStreamRequest>,
) -> std::result::Result<tonic::Response<super::WriteStream>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.bigquery.storage.v1.BigQueryWrite/CreateWriteStream",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryWrite",
"CreateWriteStream",
),
);
self.inner.unary(req, path, codec).await
}
/// Appends data to the given stream.
///
/// If `offset` is specified, the `offset` is checked against the end of
/// stream. The server returns `OUT_OF_RANGE` in `AppendRowsResponse` if an
/// attempt is made to append to an offset beyond the current end of the stream
/// or `ALREADY_EXISTS` if user provides an `offset` that has already been
/// written to. User can retry with adjusted offset within the same RPC
/// connection. If `offset` is not specified, append happens at the end of the
/// stream.
///
/// The response contains an optional offset at which the append
/// happened. No offset information will be returned for appends to a
/// default stream.
///
/// Responses are received in the same order in which requests are sent.
/// There will be one response for each successful inserted request. Responses
/// may optionally embed error information if the originating AppendRequest was
/// not successfully processed.
///
/// The specifics of when successfully appended data is made visible to the
/// table are governed by the type of stream:
///
/// * For COMMITTED streams (which includes the default stream), data is
/// visible immediately upon successful append.
///
/// * For BUFFERED streams, data is made visible via a subsequent `FlushRows`
/// rpc which advances a cursor to a newer offset in the stream.
///
/// * For PENDING streams, data is not made visible until the stream itself is
/// finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly
/// committed via the `BatchCommitWriteStreams` rpc.
pub async fn append_rows(
&mut self,
request: impl tonic::IntoStreamingRequest<Message = super::AppendRowsRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::AppendRowsResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.bigquery.storage.v1.BigQueryWrite/AppendRows",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryWrite",
"AppendRows",
),
);
self.inner.streaming(req, path, codec).await
}
/// Gets information about a write stream.
pub async fn get_write_stream(
&mut self,
request: impl tonic::IntoRequest<super::GetWriteStreamRequest>,
) -> std::result::Result<tonic::Response<super::WriteStream>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.bigquery.storage.v1.BigQueryWrite/GetWriteStream",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryWrite",
"GetWriteStream",
),
);
self.inner.unary(req, path, codec).await
}
/// Finalize a write stream so that no new data can be appended to the
/// stream. Finalize is not supported on the '_default' stream.
pub async fn finalize_write_stream(
&mut self,
request: impl tonic::IntoRequest<super::FinalizeWriteStreamRequest>,
) -> std::result::Result<
tonic::Response<super::FinalizeWriteStreamResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.bigquery.storage.v1.BigQueryWrite/FinalizeWriteStream",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryWrite",
"FinalizeWriteStream",
),
);
self.inner.unary(req, path, codec).await
}
/// Atomically commits a group of `PENDING` streams that belong to the same
/// `parent` table.
///
/// Streams must be finalized before commit and cannot be committed multiple
/// times. Once a stream is committed, data in the stream becomes available
/// for read operations.
pub async fn batch_commit_write_streams(
&mut self,
request: impl tonic::IntoRequest<super::BatchCommitWriteStreamsRequest>,
) -> std::result::Result<
tonic::Response<super::BatchCommitWriteStreamsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.bigquery.storage.v1.BigQueryWrite/BatchCommitWriteStreams",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryWrite",
"BatchCommitWriteStreams",
),
);
self.inner.unary(req, path, codec).await
}
/// Flushes rows to a BUFFERED stream.
///
/// If users are appending rows to BUFFERED stream, flush operation is
/// required in order for the rows to become available for reading. A
/// Flush operation flushes up to any previously flushed offset in a BUFFERED
/// stream, to the offset specified in the request.
///
/// Flush is not supported on the _default stream, since it is not BUFFERED.
pub async fn flush_rows(
&mut self,
request: impl tonic::IntoRequest<super::FlushRowsRequest>,
) -> std::result::Result<
tonic::Response<super::FlushRowsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.bigquery.storage.v1.BigQueryWrite/FlushRows",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.bigquery.storage.v1.BigQueryWrite",
"FlushRows",
),
);
self.inner.unary(req, path, codec).await
}
}
}