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
// This file is @generated by prost-build.
/// A partition ID identifies a grouping of entities. The grouping is always
/// by project and namespace, however the namespace ID may be empty.
///
/// A partition ID contains several dimensions:
/// project ID and namespace ID.
///
/// Partition dimensions:
///
/// - May be `""`.
/// - Must be valid UTF-8 bytes.
/// - Must have values that match regex `\[A-Za-z\d\.\-_\]{1,100}`
/// If the value of any dimension matches regex `__.*__`, the partition is
/// reserved/read-only.
/// A reserved/read-only partition ID is forbidden in certain documented
/// contexts.
///
/// Foreign partition IDs (in which the project ID does
/// not match the context project ID ) are discouraged.
/// Reads and writes of foreign partition IDs may fail if the project is not in
/// an active state.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PartitionId {
/// The ID of the project to which the entities belong.
#[prost(string, tag = "2")]
pub project_id: ::prost::alloc::string::String,
/// If not empty, the ID of the database to which the entities
/// belong.
#[prost(string, tag = "3")]
pub database_id: ::prost::alloc::string::String,
/// If not empty, the ID of the namespace to which the entities belong.
#[prost(string, tag = "4")]
pub namespace_id: ::prost::alloc::string::String,
}
/// A unique identifier for an entity.
/// If a key's partition ID or any of its path kinds or names are
/// reserved/read-only, the key is reserved/read-only.
/// A reserved/read-only key is forbidden in certain documented contexts.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Key {
/// Entities are partitioned into subsets, currently identified by a project
/// ID and namespace ID.
/// Queries are scoped to a single partition.
#[prost(message, optional, tag = "1")]
pub partition_id: ::core::option::Option<PartitionId>,
/// The entity path.
/// An entity path consists of one or more elements composed of a kind and a
/// string or numerical identifier, which identify entities. The first
/// element identifies a _root entity_, the second element identifies
/// a _child_ of the root entity, the third element identifies a child of the
/// second entity, and so forth. The entities identified by all prefixes of
/// the path are called the element's _ancestors_.
///
/// An entity path is always fully complete: *all* of the entity's ancestors
/// are required to be in the path along with the entity identifier itself.
/// The only exception is that in some documented cases, the identifier in the
/// last path element (for the entity) itself may be omitted. For example,
/// the last path element of the key of `Mutation.insert` may have no
/// identifier.
///
/// A path can never be empty, and a path can have at most 100 elements.
#[prost(message, repeated, tag = "2")]
pub path: ::prost::alloc::vec::Vec<key::PathElement>,
}
/// Nested message and enum types in `Key`.
pub mod key {
/// A (kind, ID/name) pair used to construct a key path.
///
/// If either name or ID is set, the element is complete.
/// If neither is set, the element is incomplete.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PathElement {
/// The kind of the entity.
///
/// A kind matching regex `__.*__` is reserved/read-only.
/// A kind must not contain more than 1500 bytes when UTF-8 encoded.
/// Cannot be `""`.
///
/// Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
/// encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
/// bytes.
#[prost(string, tag = "1")]
pub kind: ::prost::alloc::string::String,
/// The type of ID.
#[prost(oneof = "path_element::IdType", tags = "2, 3")]
pub id_type: ::core::option::Option<path_element::IdType>,
}
/// Nested message and enum types in `PathElement`.
pub mod path_element {
/// The type of ID.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum IdType {
/// The auto-allocated ID of the entity.
///
/// Never equal to zero. Values less than zero are discouraged and may not
/// be supported in the future.
#[prost(int64, tag = "2")]
Id(i64),
/// The name of the entity.
///
/// A name matching regex `__.*__` is reserved/read-only.
/// A name must not be more than 1500 bytes when UTF-8 encoded.
/// Cannot be `""`.
///
/// Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
/// encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
/// bytes.
#[prost(string, tag = "3")]
Name(::prost::alloc::string::String),
}
}
}
/// An array value.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ArrayValue {
/// Values in the array.
/// The order of values in an array is preserved as long as all values have
/// identical settings for 'exclude_from_indexes'.
#[prost(message, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<Value>,
}
/// A message that can hold any of the supported value types and associated
/// metadata.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Value {
/// The `meaning` field should only be populated for backwards compatibility.
#[prost(int32, tag = "14")]
pub meaning: i32,
/// If the value should be excluded from all indexes including those defined
/// explicitly.
#[prost(bool, tag = "19")]
pub exclude_from_indexes: bool,
/// Must have a value set.
#[prost(oneof = "value::ValueType", tags = "11, 1, 2, 3, 10, 5, 17, 18, 8, 6, 9")]
pub value_type: ::core::option::Option<value::ValueType>,
}
/// Nested message and enum types in `Value`.
pub mod value {
/// Must have a value set.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ValueType {
/// A null value.
#[prost(enumeration = "::prost_types::NullValue", tag = "11")]
NullValue(i32),
/// A boolean value.
#[prost(bool, tag = "1")]
BooleanValue(bool),
/// An integer value.
#[prost(int64, tag = "2")]
IntegerValue(i64),
/// A double value.
#[prost(double, tag = "3")]
DoubleValue(f64),
/// A timestamp value.
/// When stored in the Datastore, precise only to microseconds;
/// any additional precision is rounded down.
#[prost(message, tag = "10")]
TimestampValue(::prost_types::Timestamp),
/// A key value.
#[prost(message, tag = "5")]
KeyValue(super::Key),
/// A UTF-8 encoded string value.
/// When `exclude_from_indexes` is false (it is indexed) , may have at most
/// 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
#[prost(string, tag = "17")]
StringValue(::prost::alloc::string::String),
/// A blob value.
/// May have at most 1,000,000 bytes.
/// When `exclude_from_indexes` is false, may have at most 1500 bytes.
/// In JSON requests, must be base64-encoded.
#[prost(bytes, tag = "18")]
BlobValue(::prost::bytes::Bytes),
/// A geo point value representing a point on the surface of Earth.
#[prost(message, tag = "8")]
GeoPointValue(super::super::super::r#type::LatLng),
/// An entity value.
///
/// - May have no key.
/// - May have a key with an incomplete key path.
/// - May have a reserved/read-only key.
#[prost(message, tag = "6")]
EntityValue(super::Entity),
/// An array value.
/// Cannot contain another array value.
/// A `Value` instance that sets field `array_value` must not set fields
/// `meaning` or `exclude_from_indexes`.
#[prost(message, tag = "9")]
ArrayValue(super::ArrayValue),
}
}
/// A Datastore data object.
///
/// Must not exceed 1 MiB - 4 bytes.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Entity {
/// The entity's key.
///
/// An entity must have a key, unless otherwise documented (for example,
/// an entity in `Value.entity_value` may have no key).
/// An entity's kind is its key path's last element's kind,
/// or null if it has no key.
#[prost(message, optional, tag = "1")]
pub key: ::core::option::Option<Key>,
/// The entity's properties.
/// The map's keys are property names.
/// A property name matching regex `__.*__` is reserved.
/// A reserved property name is forbidden in certain documented contexts.
/// The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot
/// be empty.
#[prost(btree_map = "string, message", tag = "3")]
pub properties: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
Value,
>,
}
/// The result of fetching an entity from Datastore.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EntityResult {
/// The resulting entity.
#[prost(message, optional, tag = "1")]
pub entity: ::core::option::Option<Entity>,
/// The version of the entity, a strictly positive number that monotonically
/// increases with changes to the entity.
///
/// This field is set for
/// [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results.
///
/// For [missing][google.datastore.v1.LookupResponse.missing] entities in
/// `LookupResponse`, this is the version of the snapshot that was used to look
/// up the entity, and it is always set except for eventually consistent reads.
#[prost(int64, tag = "4")]
pub version: i64,
/// The time at which the entity was created.
/// This field is set for
/// [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results.
/// If this entity is missing, this field will not be set.
#[prost(message, optional, tag = "6")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which the entity was last changed.
/// This field is set for
/// [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results.
/// If this entity is missing, this field will not be set.
#[prost(message, optional, tag = "5")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// A cursor that points to the position after the result entity.
/// Set only when the `EntityResult` is part of a `QueryResultBatch` message.
#[prost(bytes = "bytes", tag = "3")]
pub cursor: ::prost::bytes::Bytes,
}
/// Nested message and enum types in `EntityResult`.
pub mod entity_result {
/// Specifies what data the 'entity' field contains.
/// A `ResultType` is either implied (for example, in `LookupResponse.missing`
/// from `datastore.proto`, it is always `KEY_ONLY`) or specified by context
/// (for example, in message `QueryResultBatch`, field `entity_result_type`
/// specifies a `ResultType` for all the values in field `entity_results`).
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ResultType {
/// Unspecified. This value is never used.
Unspecified = 0,
/// The key and properties.
Full = 1,
/// A projected subset of properties. The entity may have no key.
Projection = 2,
/// Only the key.
KeyOnly = 3,
}
impl ResultType {
/// 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 {
ResultType::Unspecified => "RESULT_TYPE_UNSPECIFIED",
ResultType::Full => "FULL",
ResultType::Projection => "PROJECTION",
ResultType::KeyOnly => "KEY_ONLY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RESULT_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"FULL" => Some(Self::Full),
"PROJECTION" => Some(Self::Projection),
"KEY_ONLY" => Some(Self::KeyOnly),
_ => None,
}
}
}
}
/// A query for entities.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Query {
/// The projection to return. Defaults to returning all properties.
#[prost(message, repeated, tag = "2")]
pub projection: ::prost::alloc::vec::Vec<Projection>,
/// The kinds to query (if empty, returns entities of all kinds).
/// Currently at most 1 kind may be specified.
#[prost(message, repeated, tag = "3")]
pub kind: ::prost::alloc::vec::Vec<KindExpression>,
/// The filter to apply.
#[prost(message, optional, tag = "4")]
pub filter: ::core::option::Option<Filter>,
/// The order to apply to the query results (if empty, order is unspecified).
#[prost(message, repeated, tag = "5")]
pub order: ::prost::alloc::vec::Vec<PropertyOrder>,
/// The properties to make distinct. The query results will contain the first
/// result for each distinct combination of values for the given properties
/// (if empty, all results are returned).
///
/// Requires:
///
/// * If `order` is specified, the set of distinct on properties must appear
/// before the non-distinct on properties in `order`.
#[prost(message, repeated, tag = "6")]
pub distinct_on: ::prost::alloc::vec::Vec<PropertyReference>,
/// A starting point for the query results. Query cursors are
/// returned in query result batches and
/// [can only be used to continue the same
/// query](<https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets>).
#[prost(bytes = "bytes", tag = "7")]
pub start_cursor: ::prost::bytes::Bytes,
/// An ending point for the query results. Query cursors are
/// returned in query result batches and
/// [can only be used to limit the same
/// query](<https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets>).
#[prost(bytes = "bytes", tag = "8")]
pub end_cursor: ::prost::bytes::Bytes,
/// The number of results to skip. Applies before limit, but after all other
/// constraints. Optional. Must be >= 0 if specified.
#[prost(int32, tag = "10")]
pub offset: i32,
/// The maximum number of results to return. Applies after all other
/// constraints. Optional.
/// Unspecified is interpreted as no limit.
/// Must be >= 0 if specified.
#[prost(message, optional, tag = "12")]
pub limit: ::core::option::Option<i32>,
}
/// Datastore query for running an aggregation over a
/// [Query][google.datastore.v1.Query].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AggregationQuery {
/// Optional. Series of aggregations to apply over the results of the
/// `nested_query`.
///
/// Requires:
///
/// * A minimum of one and maximum of five aggregations per query.
#[prost(message, repeated, tag = "3")]
pub aggregations: ::prost::alloc::vec::Vec<aggregation_query::Aggregation>,
/// The base query to aggregate over.
#[prost(oneof = "aggregation_query::QueryType", tags = "1")]
pub query_type: ::core::option::Option<aggregation_query::QueryType>,
}
/// Nested message and enum types in `AggregationQuery`.
pub mod aggregation_query {
/// Defines an aggregation that produces a single result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Aggregation {
/// Optional. Optional name of the property to store the result of the
/// aggregation.
///
/// If not provided, Datastore will pick a default name following the format
/// `property_<incremental_id++>`. For example:
///
/// ```
/// AGGREGATE
/// COUNT_UP_TO(1) AS count_up_to_1,
/// COUNT_UP_TO(2),
/// COUNT_UP_TO(3) AS count_up_to_3,
/// COUNT(*)
/// OVER (
/// ...
/// );
/// ```
///
/// becomes:
///
/// ```
/// AGGREGATE
/// COUNT_UP_TO(1) AS count_up_to_1,
/// COUNT_UP_TO(2) AS property_1,
/// COUNT_UP_TO(3) AS count_up_to_3,
/// COUNT(*) AS property_2
/// OVER (
/// ...
/// );
/// ```
///
/// Requires:
///
/// * Must be unique across all aggregation aliases.
/// * Conform to [entity property
/// name][google.datastore.v1.Entity.properties] limitations.
#[prost(string, tag = "7")]
pub alias: ::prost::alloc::string::String,
/// The type of aggregation to perform, required.
#[prost(oneof = "aggregation::Operator", tags = "1, 2, 3")]
pub operator: ::core::option::Option<aggregation::Operator>,
}
/// Nested message and enum types in `Aggregation`.
pub mod aggregation {
/// Count of entities that match the query.
///
/// The `COUNT(*)` aggregation function operates on the entire entity
/// so it does not require a field reference.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Count {
/// Optional. Optional constraint on the maximum number of entities to
/// count.
///
/// This provides a way to set an upper bound on the number of entities
/// to scan, limiting latency, and cost.
///
/// Unspecified is interpreted as no bound.
///
/// If a zero value is provided, a count result of zero should always be
/// expected.
///
/// High-Level Example:
///
/// ```
/// AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
/// ```
///
/// Requires:
///
/// * Must be non-negative when present.
#[prost(message, optional, tag = "1")]
pub up_to: ::core::option::Option<i64>,
}
/// Sum of the values of the requested property.
///
/// * Only numeric values will be aggregated. All non-numeric values
/// including `NULL` are skipped.
///
/// * If the aggregated values contain `NaN`, returns `NaN`. Infinity math
/// follows IEEE-754 standards.
///
/// * If the aggregated value set is empty, returns 0.
///
/// * Returns a 64-bit integer if all aggregated numbers are integers and the
/// sum result does not overflow. Otherwise, the result is returned as a
/// double. Note that even if all the aggregated values are integers, the
/// result is returned as a double if it cannot fit within a 64-bit signed
/// integer. When this occurs, the returned value will lose precision.
///
/// * When underflow occurs, floating-point aggregation is non-deterministic.
/// This means that running the same query repeatedly without any changes to
/// the underlying values could produce slightly different results each
/// time. In those cases, values should be stored as integers over
/// floating-point numbers.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Sum {
/// The property to aggregate on.
#[prost(message, optional, tag = "1")]
pub property: ::core::option::Option<super::super::PropertyReference>,
}
/// Average of the values of the requested property.
///
/// * Only numeric values will be aggregated. All non-numeric values
/// including `NULL` are skipped.
///
/// * If the aggregated values contain `NaN`, returns `NaN`. Infinity math
/// follows IEEE-754 standards.
///
/// * If the aggregated value set is empty, returns `NULL`.
///
/// * Always returns the result as a double.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Avg {
/// The property to aggregate on.
#[prost(message, optional, tag = "1")]
pub property: ::core::option::Option<super::super::PropertyReference>,
}
/// The type of aggregation to perform, required.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Operator {
/// Count aggregator.
#[prost(message, tag = "1")]
Count(Count),
/// Sum aggregator.
#[prost(message, tag = "2")]
Sum(Sum),
/// Average aggregator.
#[prost(message, tag = "3")]
Avg(Avg),
}
}
/// The base query to aggregate over.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum QueryType {
/// Nested query for aggregation
#[prost(message, tag = "1")]
NestedQuery(super::Query),
}
}
/// A representation of a kind.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct KindExpression {
/// The name of the kind.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// A reference to a property relative to the kind expressions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PropertyReference {
/// A reference to a property.
///
/// Requires:
///
/// * MUST be a dot-delimited (`.`) string of segments, where each segment
/// conforms to [entity property name][google.datastore.v1.Entity.properties]
/// limitations.
#[prost(string, tag = "2")]
pub name: ::prost::alloc::string::String,
}
/// A representation of a property in a projection.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Projection {
/// The property to project.
#[prost(message, optional, tag = "1")]
pub property: ::core::option::Option<PropertyReference>,
}
/// The desired order for a specific property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PropertyOrder {
/// The property to order by.
#[prost(message, optional, tag = "1")]
pub property: ::core::option::Option<PropertyReference>,
/// The direction to order by. Defaults to `ASCENDING`.
#[prost(enumeration = "property_order::Direction", tag = "2")]
pub direction: i32,
}
/// Nested message and enum types in `PropertyOrder`.
pub mod property_order {
/// The sort direction.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Direction {
/// Unspecified. This value must not be used.
Unspecified = 0,
/// Ascending.
Ascending = 1,
/// Descending.
Descending = 2,
}
impl Direction {
/// 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 {
Direction::Unspecified => "DIRECTION_UNSPECIFIED",
Direction::Ascending => "ASCENDING",
Direction::Descending => "DESCENDING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DIRECTION_UNSPECIFIED" => Some(Self::Unspecified),
"ASCENDING" => Some(Self::Ascending),
"DESCENDING" => Some(Self::Descending),
_ => None,
}
}
}
}
/// A holder for any type of filter.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Filter {
/// The type of filter.
#[prost(oneof = "filter::FilterType", tags = "1, 2")]
pub filter_type: ::core::option::Option<filter::FilterType>,
}
/// Nested message and enum types in `Filter`.
pub mod filter {
/// The type of filter.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum FilterType {
/// A composite filter.
#[prost(message, tag = "1")]
CompositeFilter(super::CompositeFilter),
/// A filter on a property.
#[prost(message, tag = "2")]
PropertyFilter(super::PropertyFilter),
}
}
/// A filter that merges multiple other filters using the given operator.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CompositeFilter {
/// The operator for combining multiple filters.
#[prost(enumeration = "composite_filter::Operator", tag = "1")]
pub op: i32,
/// The list of filters to combine.
///
/// Requires:
///
/// * At least one filter is present.
#[prost(message, repeated, tag = "2")]
pub filters: ::prost::alloc::vec::Vec<Filter>,
}
/// Nested message and enum types in `CompositeFilter`.
pub mod composite_filter {
/// A composite filter operator.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Operator {
/// Unspecified. This value must not be used.
Unspecified = 0,
/// The results are required to satisfy each of the combined filters.
And = 1,
/// Documents are required to satisfy at least one of the combined filters.
Or = 2,
}
impl Operator {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Operator::Unspecified => "OPERATOR_UNSPECIFIED",
Operator::And => "AND",
Operator::Or => "OR",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPERATOR_UNSPECIFIED" => Some(Self::Unspecified),
"AND" => Some(Self::And),
"OR" => Some(Self::Or),
_ => None,
}
}
}
}
/// A filter on a specific property.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PropertyFilter {
/// The property to filter by.
#[prost(message, optional, tag = "1")]
pub property: ::core::option::Option<PropertyReference>,
/// The operator to filter by.
#[prost(enumeration = "property_filter::Operator", tag = "2")]
pub op: i32,
/// The value to compare the property to.
#[prost(message, optional, tag = "3")]
pub value: ::core::option::Option<Value>,
}
/// Nested message and enum types in `PropertyFilter`.
pub mod property_filter {
/// A property filter operator.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Operator {
/// Unspecified. This value must not be used.
Unspecified = 0,
/// The given `property` is less than the given `value`.
///
/// Requires:
///
/// * That `property` comes first in `order_by`.
LessThan = 1,
/// The given `property` is less than or equal to the given `value`.
///
/// Requires:
///
/// * That `property` comes first in `order_by`.
LessThanOrEqual = 2,
/// The given `property` is greater than the given `value`.
///
/// Requires:
///
/// * That `property` comes first in `order_by`.
GreaterThan = 3,
/// The given `property` is greater than or equal to the given `value`.
///
/// Requires:
///
/// * That `property` comes first in `order_by`.
GreaterThanOrEqual = 4,
/// The given `property` is equal to the given `value`.
Equal = 5,
/// The given `property` is equal to at least one value in the given array.
///
/// Requires:
///
/// * That `value` is a non-empty `ArrayValue`, subject to disjunction
/// limits.
/// * No `NOT_IN` is in the same query.
In = 6,
/// The given `property` is not equal to the given `value`.
///
/// Requires:
///
/// * No other `NOT_EQUAL` or `NOT_IN` is in the same query.
/// * That `property` comes first in the `order_by`.
NotEqual = 9,
/// Limit the result set to the given entity and its descendants.
///
/// Requires:
///
/// * That `value` is an entity key.
/// * All evaluated disjunctions must have the same `HAS_ANCESTOR` filter.
HasAncestor = 11,
/// The value of the `property` is not in the given array.
///
/// Requires:
///
/// * That `value` is a non-empty `ArrayValue` with at most 10 values.
/// * No other `OR`, `IN`, `NOT_IN`, `NOT_EQUAL` is in the same query.
/// * That `field` comes first in the `order_by`.
NotIn = 13,
}
impl Operator {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Operator::Unspecified => "OPERATOR_UNSPECIFIED",
Operator::LessThan => "LESS_THAN",
Operator::LessThanOrEqual => "LESS_THAN_OR_EQUAL",
Operator::GreaterThan => "GREATER_THAN",
Operator::GreaterThanOrEqual => "GREATER_THAN_OR_EQUAL",
Operator::Equal => "EQUAL",
Operator::In => "IN",
Operator::NotEqual => "NOT_EQUAL",
Operator::HasAncestor => "HAS_ANCESTOR",
Operator::NotIn => "NOT_IN",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPERATOR_UNSPECIFIED" => Some(Self::Unspecified),
"LESS_THAN" => Some(Self::LessThan),
"LESS_THAN_OR_EQUAL" => Some(Self::LessThanOrEqual),
"GREATER_THAN" => Some(Self::GreaterThan),
"GREATER_THAN_OR_EQUAL" => Some(Self::GreaterThanOrEqual),
"EQUAL" => Some(Self::Equal),
"IN" => Some(Self::In),
"NOT_EQUAL" => Some(Self::NotEqual),
"HAS_ANCESTOR" => Some(Self::HasAncestor),
"NOT_IN" => Some(Self::NotIn),
_ => None,
}
}
}
}
/// A [GQL
/// query](<https://cloud.google.com/datastore/docs/apis/gql/gql_reference>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GqlQuery {
/// A string of the format described
/// [here](<https://cloud.google.com/datastore/docs/apis/gql/gql_reference>).
#[prost(string, tag = "1")]
pub query_string: ::prost::alloc::string::String,
/// When false, the query string must not contain any literals and instead must
/// bind all values. For example,
/// `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while
/// `SELECT * FROM Kind WHERE a = @value` is.
#[prost(bool, tag = "2")]
pub allow_literals: bool,
/// For each non-reserved named binding site in the query string, there must be
/// a named parameter with that name, but not necessarily the inverse.
///
/// Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
/// `__.*__`, and must not be `""`.
#[prost(btree_map = "string, message", tag = "5")]
pub named_bindings: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
GqlQueryParameter,
>,
/// Numbered binding site @1 references the first numbered parameter,
/// effectively using 1-based indexing, rather than the usual 0.
///
/// For each binding site numbered i in `query_string`, there must be an i-th
/// numbered parameter. The inverse must also be true.
#[prost(message, repeated, tag = "4")]
pub positional_bindings: ::prost::alloc::vec::Vec<GqlQueryParameter>,
}
/// A binding parameter for a GQL query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GqlQueryParameter {
/// The type of parameter.
#[prost(oneof = "gql_query_parameter::ParameterType", tags = "2, 3")]
pub parameter_type: ::core::option::Option<gql_query_parameter::ParameterType>,
}
/// Nested message and enum types in `GqlQueryParameter`.
pub mod gql_query_parameter {
/// The type of parameter.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ParameterType {
/// A value parameter.
#[prost(message, tag = "2")]
Value(super::Value),
/// A query cursor. Query cursors are returned in query
/// result batches.
#[prost(bytes, tag = "3")]
Cursor(::prost::bytes::Bytes),
}
}
/// A batch of results produced by a query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryResultBatch {
/// The number of results skipped, typically because of an offset.
#[prost(int32, tag = "6")]
pub skipped_results: i32,
/// A cursor that points to the position after the last skipped result.
/// Will be set when `skipped_results` != 0.
#[prost(bytes = "bytes", tag = "3")]
pub skipped_cursor: ::prost::bytes::Bytes,
/// The result type for every entity in `entity_results`.
#[prost(enumeration = "entity_result::ResultType", tag = "1")]
pub entity_result_type: i32,
/// The results for this batch.
#[prost(message, repeated, tag = "2")]
pub entity_results: ::prost::alloc::vec::Vec<EntityResult>,
/// A cursor that points to the position after the last result in the batch.
#[prost(bytes = "bytes", tag = "4")]
pub end_cursor: ::prost::bytes::Bytes,
/// The state of the query after the current batch.
#[prost(enumeration = "query_result_batch::MoreResultsType", tag = "5")]
pub more_results: i32,
/// The version number of the snapshot this batch was returned from.
/// This applies to the range of results from the query's `start_cursor` (or
/// the beginning of the query if no cursor was given) to this batch's
/// `end_cursor` (not the query's `end_cursor`).
///
/// In a single transaction, subsequent query result batches for the same query
/// can have a greater snapshot version number. Each batch's snapshot version
/// is valid for all preceding batches.
/// The value will be zero for eventually consistent queries.
#[prost(int64, tag = "7")]
pub snapshot_version: i64,
/// Read timestamp this batch was returned from.
/// This applies to the range of results from the query's `start_cursor` (or
/// the beginning of the query if no cursor was given) to this batch's
/// `end_cursor` (not the query's `end_cursor`).
///
/// In a single transaction, subsequent query result batches for the same query
/// can have a greater timestamp. Each batch's read timestamp
/// is valid for all preceding batches.
/// This value will not be set for eventually consistent queries in Cloud
/// Datastore.
#[prost(message, optional, tag = "8")]
pub read_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Nested message and enum types in `QueryResultBatch`.
pub mod query_result_batch {
/// The possible values for the `more_results` field.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum MoreResultsType {
/// Unspecified. This value is never used.
Unspecified = 0,
/// There may be additional batches to fetch from this query.
NotFinished = 1,
/// The query is finished, but there may be more results after the limit.
MoreResultsAfterLimit = 2,
/// The query is finished, but there may be more results after the end
/// cursor.
MoreResultsAfterCursor = 4,
/// The query is finished, and there are no more results.
NoMoreResults = 3,
}
impl MoreResultsType {
/// 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 {
MoreResultsType::Unspecified => "MORE_RESULTS_TYPE_UNSPECIFIED",
MoreResultsType::NotFinished => "NOT_FINISHED",
MoreResultsType::MoreResultsAfterLimit => "MORE_RESULTS_AFTER_LIMIT",
MoreResultsType::MoreResultsAfterCursor => "MORE_RESULTS_AFTER_CURSOR",
MoreResultsType::NoMoreResults => "NO_MORE_RESULTS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MORE_RESULTS_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"NOT_FINISHED" => Some(Self::NotFinished),
"MORE_RESULTS_AFTER_LIMIT" => Some(Self::MoreResultsAfterLimit),
"MORE_RESULTS_AFTER_CURSOR" => Some(Self::MoreResultsAfterCursor),
"NO_MORE_RESULTS" => Some(Self::NoMoreResults),
_ => None,
}
}
}
}
/// The result of a single bucket from a Datastore aggregation query.
///
/// The keys of `aggregate_properties` are the same for all results in an
/// aggregation query, unlike entity queries which can have different fields
/// present for each result.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AggregationResult {
/// The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.
///
/// The key is the
/// [alias][google.datastore.v1.AggregationQuery.Aggregation.alias] assigned to
/// the aggregation function on input and the size of this map equals the
/// number of aggregation functions in the query.
#[prost(btree_map = "string, message", tag = "2")]
pub aggregate_properties: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
Value,
>,
}
/// A batch of aggregation results produced by an aggregation query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AggregationResultBatch {
/// The aggregation results for this batch.
#[prost(message, repeated, tag = "1")]
pub aggregation_results: ::prost::alloc::vec::Vec<AggregationResult>,
/// The state of the query after the current batch.
/// Only COUNT(*) aggregations are supported in the initial launch. Therefore,
/// expected result type is limited to `NO_MORE_RESULTS`.
#[prost(enumeration = "query_result_batch::MoreResultsType", tag = "2")]
pub more_results: i32,
/// Read timestamp this batch was returned from.
///
/// In a single transaction, subsequent query result batches for the same query
/// can have a greater timestamp. Each batch's read timestamp
/// is valid for all preceding batches.
#[prost(message, optional, tag = "3")]
pub read_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Explain options for the query.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ExplainOptions {
/// Optional. Whether to execute this query.
///
/// When false (the default), the query will be planned, returning only
/// metrics from the planning stages.
///
/// When true, the query will be planned and executed, returning the full
/// query results along with both planning and execution stage metrics.
#[prost(bool, tag = "1")]
pub analyze: bool,
}
/// Explain metrics for the query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExplainMetrics {
/// Planning phase information for the query.
#[prost(message, optional, tag = "1")]
pub plan_summary: ::core::option::Option<PlanSummary>,
/// Aggregated stats from the execution of the query. Only present when
/// [ExplainOptions.analyze][google.datastore.v1.ExplainOptions.analyze] is set
/// to true.
#[prost(message, optional, tag = "2")]
pub execution_stats: ::core::option::Option<ExecutionStats>,
}
/// Planning phase information for the query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PlanSummary {
/// The indexes selected for the query. For example:
/// [
/// {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"},
/// {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"}
/// ]
#[prost(message, repeated, tag = "1")]
pub indexes_used: ::prost::alloc::vec::Vec<::prost_types::Struct>,
}
/// Execution statistics for the query.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecutionStats {
/// Total number of results returned, including documents, projections,
/// aggregation results, keys.
#[prost(int64, tag = "1")]
pub results_returned: i64,
/// Total time to execute the query in the backend.
#[prost(message, optional, tag = "3")]
pub execution_duration: ::core::option::Option<::prost_types::Duration>,
/// Total billable read operations.
#[prost(int64, tag = "4")]
pub read_operations: i64,
/// Debugging statistics from the execution of the query. Note that the
/// debugging stats are subject to change as Firestore evolves. It could
/// include:
/// {
/// "indexes_entries_scanned": "1000",
/// "documents_scanned": "20",
/// "billing_details" : {
/// "documents_billable": "20",
/// "index_entries_billable": "1000",
/// "min_query_cost": "0"
/// }
/// }
#[prost(message, optional, tag = "5")]
pub debug_stats: ::core::option::Option<::prost_types::Struct>,
}
/// The request for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LookupRequest {
/// Required. The ID of the project against which to make the request.
#[prost(string, tag = "8")]
pub project_id: ::prost::alloc::string::String,
/// The ID of the database against which to make the request.
///
/// '(default)' is not allowed; please use empty string '' to refer the default
/// database.
#[prost(string, tag = "9")]
pub database_id: ::prost::alloc::string::String,
/// The options for this lookup request.
#[prost(message, optional, tag = "1")]
pub read_options: ::core::option::Option<ReadOptions>,
/// Required. Keys of entities to look up.
#[prost(message, repeated, tag = "3")]
pub keys: ::prost::alloc::vec::Vec<Key>,
/// The properties to return. Defaults to returning all properties.
///
/// If this field is set and an entity has a property not referenced in the
/// mask, it will be absent from [LookupResponse.found.entity.properties][].
///
/// The entity's key is always returned.
#[prost(message, optional, tag = "5")]
pub property_mask: ::core::option::Option<PropertyMask>,
}
/// The response for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LookupResponse {
/// Entities found as `ResultType.FULL` entities. The order of results in this
/// field is undefined and has no relation to the order of the keys in the
/// input.
#[prost(message, repeated, tag = "1")]
pub found: ::prost::alloc::vec::Vec<EntityResult>,
/// Entities not found as `ResultType.KEY_ONLY` entities. The order of results
/// in this field is undefined and has no relation to the order of the keys
/// in the input.
#[prost(message, repeated, tag = "2")]
pub missing: ::prost::alloc::vec::Vec<EntityResult>,
/// A list of keys that were not looked up due to resource constraints. The
/// order of results in this field is undefined and has no relation to the
/// order of the keys in the input.
#[prost(message, repeated, tag = "3")]
pub deferred: ::prost::alloc::vec::Vec<Key>,
/// The identifier of the transaction that was started as part of this Lookup
/// request.
///
/// Set only when
/// [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
/// was set in
/// [LookupRequest.read_options][google.datastore.v1.LookupRequest.read_options].
#[prost(bytes = "bytes", tag = "5")]
pub transaction: ::prost::bytes::Bytes,
/// The time at which these entities were read or found missing.
#[prost(message, optional, tag = "7")]
pub read_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// The request for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunQueryRequest {
/// Required. The ID of the project against which to make the request.
#[prost(string, tag = "8")]
pub project_id: ::prost::alloc::string::String,
/// The ID of the database against which to make the request.
///
/// '(default)' is not allowed; please use empty string '' to refer the default
/// database.
#[prost(string, tag = "9")]
pub database_id: ::prost::alloc::string::String,
/// Entities are partitioned into subsets, identified by a partition ID.
/// Queries are scoped to a single partition.
/// This partition ID is normalized with the standard default context
/// partition ID.
#[prost(message, optional, tag = "2")]
pub partition_id: ::core::option::Option<PartitionId>,
/// The options for this query.
#[prost(message, optional, tag = "1")]
pub read_options: ::core::option::Option<ReadOptions>,
/// The properties to return.
/// This field must not be set for a projection query.
///
/// See
/// [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
#[prost(message, optional, tag = "10")]
pub property_mask: ::core::option::Option<PropertyMask>,
/// Optional. Explain options for the query. If set, additional query
/// statistics will be returned. If not, only query results will be returned.
#[prost(message, optional, tag = "12")]
pub explain_options: ::core::option::Option<ExplainOptions>,
/// The type of query.
#[prost(oneof = "run_query_request::QueryType", tags = "3, 7")]
pub query_type: ::core::option::Option<run_query_request::QueryType>,
}
/// Nested message and enum types in `RunQueryRequest`.
pub mod run_query_request {
/// The type of query.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum QueryType {
/// The query to run.
#[prost(message, tag = "3")]
Query(super::Query),
/// The GQL query to run. This query must be a non-aggregation query.
#[prost(message, tag = "7")]
GqlQuery(super::GqlQuery),
}
}
/// The response for
/// [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunQueryResponse {
/// A batch of query results (always present).
#[prost(message, optional, tag = "1")]
pub batch: ::core::option::Option<QueryResultBatch>,
/// The parsed form of the `GqlQuery` from the request, if it was set.
#[prost(message, optional, tag = "2")]
pub query: ::core::option::Option<Query>,
/// The identifier of the transaction that was started as part of this
/// RunQuery request.
///
/// Set only when
/// [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
/// was set in
/// [RunQueryRequest.read_options][google.datastore.v1.RunQueryRequest.read_options].
#[prost(bytes = "bytes", tag = "5")]
pub transaction: ::prost::bytes::Bytes,
/// Query explain metrics. This is only present when the
/// [RunQueryRequest.explain_options][google.datastore.v1.RunQueryRequest.explain_options]
/// is provided, and it is sent only once with the last response in the stream.
#[prost(message, optional, tag = "9")]
pub explain_metrics: ::core::option::Option<ExplainMetrics>,
}
/// The request for
/// [Datastore.RunAggregationQuery][google.datastore.v1.Datastore.RunAggregationQuery].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunAggregationQueryRequest {
/// Required. The ID of the project against which to make the request.
#[prost(string, tag = "8")]
pub project_id: ::prost::alloc::string::String,
/// The ID of the database against which to make the request.
///
/// '(default)' is not allowed; please use empty string '' to refer the default
/// database.
#[prost(string, tag = "9")]
pub database_id: ::prost::alloc::string::String,
/// Entities are partitioned into subsets, identified by a partition ID.
/// Queries are scoped to a single partition.
/// This partition ID is normalized with the standard default context
/// partition ID.
#[prost(message, optional, tag = "2")]
pub partition_id: ::core::option::Option<PartitionId>,
/// The options for this query.
#[prost(message, optional, tag = "1")]
pub read_options: ::core::option::Option<ReadOptions>,
/// Optional. Explain options for the query. If set, additional query
/// statistics will be returned. If not, only query results will be returned.
#[prost(message, optional, tag = "11")]
pub explain_options: ::core::option::Option<ExplainOptions>,
/// The type of query.
#[prost(oneof = "run_aggregation_query_request::QueryType", tags = "3, 7")]
pub query_type: ::core::option::Option<run_aggregation_query_request::QueryType>,
}
/// Nested message and enum types in `RunAggregationQueryRequest`.
pub mod run_aggregation_query_request {
/// The type of query.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum QueryType {
/// The query to run.
#[prost(message, tag = "3")]
AggregationQuery(super::AggregationQuery),
/// The GQL query to run. This query must be an aggregation query.
#[prost(message, tag = "7")]
GqlQuery(super::GqlQuery),
}
}
/// The response for
/// [Datastore.RunAggregationQuery][google.datastore.v1.Datastore.RunAggregationQuery].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunAggregationQueryResponse {
/// A batch of aggregation results. Always present.
#[prost(message, optional, tag = "1")]
pub batch: ::core::option::Option<AggregationResultBatch>,
/// The parsed form of the `GqlQuery` from the request, if it was set.
#[prost(message, optional, tag = "2")]
pub query: ::core::option::Option<AggregationQuery>,
/// The identifier of the transaction that was started as part of this
/// RunAggregationQuery request.
///
/// Set only when
/// [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
/// was set in
/// [RunAggregationQueryRequest.read_options][google.datastore.v1.RunAggregationQueryRequest.read_options].
#[prost(bytes = "bytes", tag = "5")]
pub transaction: ::prost::bytes::Bytes,
/// Query explain metrics. This is only present when the
/// [RunAggregationQueryRequest.explain_options][google.datastore.v1.RunAggregationQueryRequest.explain_options]
/// is provided, and it is sent only once with the last response in the stream.
#[prost(message, optional, tag = "9")]
pub explain_metrics: ::core::option::Option<ExplainMetrics>,
}
/// The request for
/// [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BeginTransactionRequest {
/// Required. The ID of the project against which to make the request.
#[prost(string, tag = "8")]
pub project_id: ::prost::alloc::string::String,
/// The ID of the database against which to make the request.
///
/// '(default)' is not allowed; please use empty string '' to refer the default
/// database.
#[prost(string, tag = "9")]
pub database_id: ::prost::alloc::string::String,
/// Options for a new transaction.
#[prost(message, optional, tag = "10")]
pub transaction_options: ::core::option::Option<TransactionOptions>,
}
/// The response for
/// [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BeginTransactionResponse {
/// The transaction identifier (always present).
#[prost(bytes = "bytes", tag = "1")]
pub transaction: ::prost::bytes::Bytes,
}
/// The request for [Datastore.Rollback][google.datastore.v1.Datastore.Rollback].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RollbackRequest {
/// Required. The ID of the project against which to make the request.
#[prost(string, tag = "8")]
pub project_id: ::prost::alloc::string::String,
/// The ID of the database against which to make the request.
///
/// '(default)' is not allowed; please use empty string '' to refer the default
/// database.
#[prost(string, tag = "9")]
pub database_id: ::prost::alloc::string::String,
/// Required. The transaction identifier, returned by a call to
/// [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
#[prost(bytes = "bytes", tag = "1")]
pub transaction: ::prost::bytes::Bytes,
}
/// The response for
/// [Datastore.Rollback][google.datastore.v1.Datastore.Rollback]. (an empty
/// message).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RollbackResponse {}
/// The request for [Datastore.Commit][google.datastore.v1.Datastore.Commit].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommitRequest {
/// Required. The ID of the project against which to make the request.
#[prost(string, tag = "8")]
pub project_id: ::prost::alloc::string::String,
/// The ID of the database against which to make the request.
///
/// '(default)' is not allowed; please use empty string '' to refer the default
/// database.
#[prost(string, tag = "9")]
pub database_id: ::prost::alloc::string::String,
/// The type of commit to perform. Defaults to `TRANSACTIONAL`.
#[prost(enumeration = "commit_request::Mode", tag = "5")]
pub mode: i32,
/// The mutations to perform.
///
/// When mode is `TRANSACTIONAL`, mutations affecting a single entity are
/// applied in order. The following sequences of mutations affecting a single
/// entity are not permitted in a single `Commit` request:
///
/// - `insert` followed by `insert`
/// - `update` followed by `insert`
/// - `upsert` followed by `insert`
/// - `delete` followed by `update`
///
/// When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
/// entity.
#[prost(message, repeated, tag = "6")]
pub mutations: ::prost::alloc::vec::Vec<Mutation>,
/// Must be set when mode is `TRANSACTIONAL`.
#[prost(oneof = "commit_request::TransactionSelector", tags = "1, 10")]
pub transaction_selector: ::core::option::Option<
commit_request::TransactionSelector,
>,
}
/// Nested message and enum types in `CommitRequest`.
pub mod commit_request {
/// The modes available for commits.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Mode {
/// Unspecified. This value must not be used.
Unspecified = 0,
/// Transactional: The mutations are either all applied, or none are applied.
/// Learn about transactions
/// [here](<https://cloud.google.com/datastore/docs/concepts/transactions>).
Transactional = 1,
/// Non-transactional: The mutations may not apply as all or none.
NonTransactional = 2,
}
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::Transactional => "TRANSACTIONAL",
Mode::NonTransactional => "NON_TRANSACTIONAL",
}
}
/// 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),
"TRANSACTIONAL" => Some(Self::Transactional),
"NON_TRANSACTIONAL" => Some(Self::NonTransactional),
_ => None,
}
}
}
/// Must be set when mode is `TRANSACTIONAL`.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TransactionSelector {
/// The identifier of the transaction associated with the commit. A
/// transaction identifier is returned by a call to
/// [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
#[prost(bytes, tag = "1")]
Transaction(::prost::bytes::Bytes),
/// Options for beginning a new transaction for this request.
/// The transaction is committed when the request completes. If specified,
/// [TransactionOptions.mode][google.datastore.v1.TransactionOptions] must be
/// [TransactionOptions.ReadWrite][google.datastore.v1.TransactionOptions.ReadWrite].
#[prost(message, tag = "10")]
SingleUseTransaction(super::TransactionOptions),
}
}
/// The response for [Datastore.Commit][google.datastore.v1.Datastore.Commit].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommitResponse {
/// The result of performing the mutations.
/// The i-th mutation result corresponds to the i-th mutation in the request.
#[prost(message, repeated, tag = "3")]
pub mutation_results: ::prost::alloc::vec::Vec<MutationResult>,
/// The number of index entries updated during the commit, or zero if none were
/// updated.
#[prost(int32, tag = "4")]
pub index_updates: i32,
/// The transaction commit timestamp. Not set for non-transactional commits.
#[prost(message, optional, tag = "8")]
pub commit_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// The request for
/// [Datastore.AllocateIds][google.datastore.v1.Datastore.AllocateIds].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AllocateIdsRequest {
/// Required. The ID of the project against which to make the request.
#[prost(string, tag = "8")]
pub project_id: ::prost::alloc::string::String,
/// The ID of the database against which to make the request.
///
/// '(default)' is not allowed; please use empty string '' to refer the default
/// database.
#[prost(string, tag = "9")]
pub database_id: ::prost::alloc::string::String,
/// Required. A list of keys with incomplete key paths for which to allocate
/// IDs. No key may be reserved/read-only.
#[prost(message, repeated, tag = "1")]
pub keys: ::prost::alloc::vec::Vec<Key>,
}
/// The response for
/// [Datastore.AllocateIds][google.datastore.v1.Datastore.AllocateIds].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AllocateIdsResponse {
/// The keys specified in the request (in the same order), each with
/// its key path completed with a newly allocated ID.
#[prost(message, repeated, tag = "1")]
pub keys: ::prost::alloc::vec::Vec<Key>,
}
/// The request for
/// [Datastore.ReserveIds][google.datastore.v1.Datastore.ReserveIds].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReserveIdsRequest {
/// Required. The ID of the project against which to make the request.
#[prost(string, tag = "8")]
pub project_id: ::prost::alloc::string::String,
/// The ID of the database against which to make the request.
///
/// '(default)' is not allowed; please use empty string '' to refer the default
/// database.
#[prost(string, tag = "9")]
pub database_id: ::prost::alloc::string::String,
/// Required. A list of keys with complete key paths whose numeric IDs should
/// not be auto-allocated.
#[prost(message, repeated, tag = "1")]
pub keys: ::prost::alloc::vec::Vec<Key>,
}
/// The response for
/// [Datastore.ReserveIds][google.datastore.v1.Datastore.ReserveIds].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ReserveIdsResponse {}
/// A mutation to apply to an entity.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Mutation {
/// The properties to write in this mutation.
/// None of the properties in the mask may have a reserved name, except for
/// `__key__`.
/// This field is ignored for `delete`.
///
/// If the entity already exists, only properties referenced in the mask are
/// updated, others are left untouched.
/// Properties referenced in the mask but not in the entity are deleted.
#[prost(message, optional, tag = "9")]
pub property_mask: ::core::option::Option<PropertyMask>,
/// The mutation operation.
///
/// For `insert`, `update`, and `upsert`:
/// - The entity's key must not be reserved/read-only.
/// - No property in the entity may have a reserved name,
/// not even a property in an entity in a value.
/// - No value in the entity may have meaning 18,
/// not even a value in an entity in another value.
#[prost(oneof = "mutation::Operation", tags = "4, 5, 6, 7")]
pub operation: ::core::option::Option<mutation::Operation>,
/// When set, the server will detect whether or not this mutation conflicts
/// with the current version of the entity on the server. Conflicting mutations
/// are not applied, and are marked as such in MutationResult.
#[prost(oneof = "mutation::ConflictDetectionStrategy", tags = "8, 11")]
pub conflict_detection_strategy: ::core::option::Option<
mutation::ConflictDetectionStrategy,
>,
}
/// Nested message and enum types in `Mutation`.
pub mod mutation {
/// The mutation operation.
///
/// For `insert`, `update`, and `upsert`:
/// - The entity's key must not be reserved/read-only.
/// - No property in the entity may have a reserved name,
/// not even a property in an entity in a value.
/// - No value in the entity may have meaning 18,
/// not even a value in an entity in another value.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Operation {
/// The entity to insert. The entity must not already exist.
/// The entity key's final path element may be incomplete.
#[prost(message, tag = "4")]
Insert(super::Entity),
/// The entity to update. The entity must already exist.
/// Must have a complete key path.
#[prost(message, tag = "5")]
Update(super::Entity),
/// The entity to upsert. The entity may or may not already exist.
/// The entity key's final path element may be incomplete.
#[prost(message, tag = "6")]
Upsert(super::Entity),
/// The key of the entity to delete. The entity may or may not already exist.
/// Must have a complete key path and must not be reserved/read-only.
#[prost(message, tag = "7")]
Delete(super::Key),
}
/// When set, the server will detect whether or not this mutation conflicts
/// with the current version of the entity on the server. Conflicting mutations
/// are not applied, and are marked as such in MutationResult.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum ConflictDetectionStrategy {
/// The version of the entity that this mutation is being applied
/// to. If this does not match the current version on the server, the
/// mutation conflicts.
#[prost(int64, tag = "8")]
BaseVersion(i64),
/// The update time of the entity that this mutation is being applied
/// to. If this does not match the current update time on the server, the
/// mutation conflicts.
#[prost(message, tag = "11")]
UpdateTime(::prost_types::Timestamp),
}
}
/// The result of applying a mutation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MutationResult {
/// The automatically allocated key.
/// Set only when the mutation allocated a key.
#[prost(message, optional, tag = "3")]
pub key: ::core::option::Option<Key>,
/// The version of the entity on the server after processing the mutation. If
/// the mutation doesn't change anything on the server, then the version will
/// be the version of the current entity or, if no entity is present, a version
/// that is strictly greater than the version of any previous entity and less
/// than the version of any possible future entity.
#[prost(int64, tag = "4")]
pub version: i64,
/// The create time of the entity. This field will not be set after a 'delete'.
#[prost(message, optional, tag = "7")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// The update time of the entity on the server after processing the mutation.
/// If the mutation doesn't change anything on the server, then the timestamp
/// will be the update timestamp of the current entity. This field will not be
/// set after a 'delete'.
#[prost(message, optional, tag = "6")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Whether a conflict was detected for this mutation. Always false when a
/// conflict detection strategy field is not set in the mutation.
#[prost(bool, tag = "5")]
pub conflict_detected: bool,
}
/// The set of arbitrarily nested property paths used to restrict an operation to
/// only a subset of properties in an entity.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PropertyMask {
/// The paths to the properties covered by this mask.
///
/// A path is a list of property names separated by dots (`.`), for example
/// `foo.bar` means the property `bar` inside the entity property `foo` inside
/// the entity associated with this path.
///
/// If a property name contains a dot `.` or a backslash `\`, then that
/// name must be escaped.
///
/// A path must not be empty, and may not reference a value inside an
/// [array value][google.datastore.v1.Value.array_value].
#[prost(string, repeated, tag = "1")]
pub paths: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// The options shared by read requests.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadOptions {
/// For Cloud Datastore, if read_consistency is not specified, then lookups and
/// ancestor queries default to `read_consistency`=`STRONG`, global queries
/// default to `read_consistency`=`EVENTUAL`.
///
/// For Cloud Firestore in Datastore mode, if read_consistency is not specified
/// then lookups and all queries default to `read_consistency`=`STRONG`.
///
/// Explicitly setting `read_consistency`=`EVENTUAL` will result in eventually
/// consistent lookups & queries in both Cloud Datastore & Cloud Firestore in
/// Datastore mode.
#[prost(oneof = "read_options::ConsistencyType", tags = "1, 2, 3, 4")]
pub consistency_type: ::core::option::Option<read_options::ConsistencyType>,
}
/// Nested message and enum types in `ReadOptions`.
pub mod read_options {
/// The possible values for read consistencies.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ReadConsistency {
/// Unspecified. This value must not be used.
Unspecified = 0,
/// Strong consistency.
Strong = 1,
/// Eventual consistency.
Eventual = 2,
}
impl ReadConsistency {
/// 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 {
ReadConsistency::Unspecified => "READ_CONSISTENCY_UNSPECIFIED",
ReadConsistency::Strong => "STRONG",
ReadConsistency::Eventual => "EVENTUAL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"READ_CONSISTENCY_UNSPECIFIED" => Some(Self::Unspecified),
"STRONG" => Some(Self::Strong),
"EVENTUAL" => Some(Self::Eventual),
_ => None,
}
}
}
/// For Cloud Datastore, if read_consistency is not specified, then lookups and
/// ancestor queries default to `read_consistency`=`STRONG`, global queries
/// default to `read_consistency`=`EVENTUAL`.
///
/// For Cloud Firestore in Datastore mode, if read_consistency is not specified
/// then lookups and all queries default to `read_consistency`=`STRONG`.
///
/// Explicitly setting `read_consistency`=`EVENTUAL` will result in eventually
/// consistent lookups & queries in both Cloud Datastore & Cloud Firestore in
/// Datastore mode.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConsistencyType {
/// The non-transactional read consistency to use.
#[prost(enumeration = "ReadConsistency", tag = "1")]
ReadConsistency(i32),
/// The identifier of the transaction in which to read. A
/// transaction identifier is returned by a call to
/// [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
#[prost(bytes, tag = "2")]
Transaction(::prost::bytes::Bytes),
/// Options for beginning a new transaction for this request.
///
/// The new transaction identifier will be returned in the corresponding
/// response as either
/// [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction]
/// or
/// [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].
#[prost(message, tag = "3")]
NewTransaction(super::TransactionOptions),
/// Reads entities as they were at the given time. This value is only
/// supported for Cloud Firestore in Datastore mode.
///
/// This must be a microsecond precision timestamp within the past one hour,
/// or if Point-in-Time Recovery is enabled, can additionally be a whole
/// minute timestamp within the past 7 days.
#[prost(message, tag = "4")]
ReadTime(::prost_types::Timestamp),
}
}
/// Options for beginning a new transaction.
///
/// Transactions can be created explicitly with calls to
/// [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction]
/// or implicitly by setting
/// [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
/// in read requests.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TransactionOptions {
/// The `mode` of the transaction, indicating whether write operations are
/// supported.
#[prost(oneof = "transaction_options::Mode", tags = "1, 2")]
pub mode: ::core::option::Option<transaction_options::Mode>,
}
/// Nested message and enum types in `TransactionOptions`.
pub mod transaction_options {
/// Options specific to read / write transactions.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadWrite {
/// The transaction identifier of the transaction being retried.
#[prost(bytes = "bytes", tag = "1")]
pub previous_transaction: ::prost::bytes::Bytes,
}
/// Options specific to read-only transactions.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ReadOnly {
/// Reads entities at the given time.
///
/// This must be a microsecond precision timestamp within the past one hour,
/// or if Point-in-Time Recovery is enabled, can additionally be a whole
/// minute timestamp within the past 7 days.
#[prost(message, optional, tag = "1")]
pub read_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// The `mode` of the transaction, indicating whether write operations are
/// supported.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Mode {
/// The transaction should allow both reads and writes.
#[prost(message, tag = "1")]
ReadWrite(ReadWrite),
/// The transaction should only allow reads.
#[prost(message, tag = "2")]
ReadOnly(ReadOnly),
}
}
/// Generated client implementations.
pub mod datastore_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Each RPC normalizes the partition IDs of the keys in its input entities,
/// and always returns entities with keys with normalized partition IDs.
/// This applies to all keys and entities, including those in values, except keys
/// with both an empty path and an empty or unset partition ID. Normalization of
/// input keys sets the project ID (if not already set) to the project ID from
/// the request.
///
#[derive(Debug, Clone)]
pub struct DatastoreClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> DatastoreClient<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,
) -> DatastoreClient<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,
{
DatastoreClient::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
}
/// Looks up entities by key.
pub async fn lookup(
&mut self,
request: impl tonic::IntoRequest<super::LookupRequest>,
) -> std::result::Result<tonic::Response<super::LookupResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.datastore.v1.Datastore/Lookup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.datastore.v1.Datastore", "Lookup"));
self.inner.unary(req, path, codec).await
}
/// Queries for entities.
pub async fn run_query(
&mut self,
request: impl tonic::IntoRequest<super::RunQueryRequest>,
) -> std::result::Result<
tonic::Response<super::RunQueryResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.datastore.v1.Datastore/RunQuery",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.datastore.v1.Datastore", "RunQuery"));
self.inner.unary(req, path, codec).await
}
/// Runs an aggregation query.
pub async fn run_aggregation_query(
&mut self,
request: impl tonic::IntoRequest<super::RunAggregationQueryRequest>,
) -> std::result::Result<
tonic::Response<super::RunAggregationQueryResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.datastore.v1.Datastore/RunAggregationQuery",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.datastore.v1.Datastore",
"RunAggregationQuery",
),
);
self.inner.unary(req, path, codec).await
}
/// Begins a new transaction.
pub async fn begin_transaction(
&mut self,
request: impl tonic::IntoRequest<super::BeginTransactionRequest>,
) -> std::result::Result<
tonic::Response<super::BeginTransactionResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.datastore.v1.Datastore/BeginTransaction",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.datastore.v1.Datastore", "BeginTransaction"),
);
self.inner.unary(req, path, codec).await
}
/// Commits a transaction, optionally creating, deleting or modifying some
/// entities.
pub async fn commit(
&mut self,
request: impl tonic::IntoRequest<super::CommitRequest>,
) -> std::result::Result<tonic::Response<super::CommitResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.datastore.v1.Datastore/Commit",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.datastore.v1.Datastore", "Commit"));
self.inner.unary(req, path, codec).await
}
/// Rolls back a transaction.
pub async fn rollback(
&mut self,
request: impl tonic::IntoRequest<super::RollbackRequest>,
) -> std::result::Result<
tonic::Response<super::RollbackResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.datastore.v1.Datastore/Rollback",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.datastore.v1.Datastore", "Rollback"));
self.inner.unary(req, path, codec).await
}
/// Allocates IDs for the given keys, which is useful for referencing an entity
/// before it is inserted.
pub async fn allocate_ids(
&mut self,
request: impl tonic::IntoRequest<super::AllocateIdsRequest>,
) -> std::result::Result<
tonic::Response<super::AllocateIdsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.datastore.v1.Datastore/AllocateIds",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.datastore.v1.Datastore", "AllocateIds"));
self.inner.unary(req, path, codec).await
}
/// Prevents the supplied keys' IDs from being auto-allocated by Cloud
/// Datastore.
pub async fn reserve_ids(
&mut self,
request: impl tonic::IntoRequest<super::ReserveIdsRequest>,
) -> std::result::Result<
tonic::Response<super::ReserveIdsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.datastore.v1.Datastore/ReserveIds",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.datastore.v1.Datastore", "ReserveIds"));
self.inner.unary(req, path, codec).await
}
}
}