1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
// This file is @generated by prost-build.
/// Encapsulates progress related information for a Cloud Spanner long
/// running instance operations.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct OperationProgress {
/// Percent completion of the operation.
/// Values are between 0 and 100 inclusive.
#[prost(int32, tag = "1")]
pub progress_percent: i32,
/// Time the request was received.
#[prost(message, optional, tag = "2")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// If set, the time at which this operation failed or was completed
/// successfully.
#[prost(message, optional, tag = "3")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Indicates the expected fulfillment period of an operation.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum FulfillmentPeriod {
/// Not specified.
Unspecified = 0,
/// Normal fulfillment period. The operation is expected to complete within
/// minutes.
Normal = 1,
/// Extended fulfillment period. It can take up to an hour for the operation
/// to complete.
Extended = 2,
}
impl FulfillmentPeriod {
/// 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 {
FulfillmentPeriod::Unspecified => "FULFILLMENT_PERIOD_UNSPECIFIED",
FulfillmentPeriod::Normal => "FULFILLMENT_PERIOD_NORMAL",
FulfillmentPeriod::Extended => "FULFILLMENT_PERIOD_EXTENDED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"FULFILLMENT_PERIOD_UNSPECIFIED" => Some(Self::Unspecified),
"FULFILLMENT_PERIOD_NORMAL" => Some(Self::Normal),
"FULFILLMENT_PERIOD_EXTENDED" => Some(Self::Extended),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReplicaInfo {
/// The location of the serving resources, e.g. "us-central1".
#[prost(string, tag = "1")]
pub location: ::prost::alloc::string::String,
/// The type of replica.
#[prost(enumeration = "replica_info::ReplicaType", tag = "2")]
pub r#type: i32,
/// If true, this location is designated as the default leader location where
/// leader replicas are placed. See the [region types
/// documentation](<https://cloud.google.com/spanner/docs/instances#region_types>)
/// for more details.
#[prost(bool, tag = "3")]
pub default_leader_location: bool,
}
/// Nested message and enum types in `ReplicaInfo`.
pub mod replica_info {
/// Indicates the type of replica. See the [replica types
/// documentation](<https://cloud.google.com/spanner/docs/replication#replica_types>)
/// for more details.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ReplicaType {
/// Not specified.
TypeUnspecified = 0,
/// Read-write replicas support both reads and writes. These replicas:
///
/// * Maintain a full copy of your data.
/// * Serve reads.
/// * Can vote whether to commit a write.
/// * Participate in leadership election.
/// * Are eligible to become a leader.
ReadWrite = 1,
/// Read-only replicas only support reads (not writes). Read-only replicas:
///
/// * Maintain a full copy of your data.
/// * Serve reads.
/// * Do not participate in voting to commit writes.
/// * Are not eligible to become a leader.
ReadOnly = 2,
/// Witness replicas don't support reads but do participate in voting to
/// commit writes. Witness replicas:
///
/// * Do not maintain a full copy of data.
/// * Do not serve reads.
/// * Vote whether to commit writes.
/// * Participate in leader election but are not eligible to become leader.
Witness = 3,
}
impl ReplicaType {
/// 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 {
ReplicaType::TypeUnspecified => "TYPE_UNSPECIFIED",
ReplicaType::ReadWrite => "READ_WRITE",
ReplicaType::ReadOnly => "READ_ONLY",
ReplicaType::Witness => "WITNESS",
}
}
/// 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::TypeUnspecified),
"READ_WRITE" => Some(Self::ReadWrite),
"READ_ONLY" => Some(Self::ReadOnly),
"WITNESS" => Some(Self::Witness),
_ => None,
}
}
}
}
/// A possible configuration for a Cloud Spanner instance. Configurations
/// define the geographic placement of nodes and their replication.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InstanceConfig {
/// A unique identifier for the instance configuration. Values
/// are of the form
/// `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`.
///
/// User instance configuration must start with `custom-`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The name of this instance configuration as it appears in UIs.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Output only. Whether this instance configuration is a Google-managed or
/// user-managed configuration.
#[prost(enumeration = "instance_config::Type", tag = "5")]
pub config_type: i32,
/// The geographic placement of nodes in this instance configuration and their
/// replication properties.
#[prost(message, repeated, tag = "3")]
pub replicas: ::prost::alloc::vec::Vec<ReplicaInfo>,
/// Output only. The available optional replicas to choose from for user
/// managed configurations. Populated for Google managed configurations.
#[prost(message, repeated, tag = "6")]
pub optional_replicas: ::prost::alloc::vec::Vec<ReplicaInfo>,
/// Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3,
/// based on which this configuration is created. Only set for user managed
/// configurations. `base_config` must refer to a configuration of type
/// GOOGLE_MANAGED in the same project as this configuration.
#[prost(string, tag = "7")]
pub base_config: ::prost::alloc::string::String,
/// Cloud Labels are a flexible and lightweight mechanism for organizing cloud
/// resources into groups that reflect a customer's organizational needs and
/// deployment strategies. Cloud Labels can be used to filter collections of
/// resources. They can be used to control how resource metrics are aggregated.
/// And they can be used as arguments to policy management rules (e.g. route,
/// firewall, load balancing, etc.).
///
/// * Label keys must be between 1 and 63 characters long and must conform to
/// the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
/// * Label values must be between 0 and 63 characters long and must conform
/// to the regular expression `\[a-z0-9_-\]{0,63}`.
/// * No more than 64 labels can be associated with a given resource.
///
/// See <https://goo.gl/xmQnxf> for more information on and examples of labels.
///
/// If you plan to use labels in your own code, please note that additional
/// characters may be allowed in the future. Therefore, you are advised to use
/// an internal label representation, such as JSON, which doesn't rely upon
/// specific characters being disallowed. For example, representing labels
/// as the string: name + "_" + value would prove problematic if we were to
/// allow "_" in a future release.
#[prost(btree_map = "string, string", tag = "8")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// etag is used for optimistic concurrency control as a way
/// to help prevent simultaneous updates of a instance configuration from
/// overwriting each other. It is strongly suggested that systems make use of
/// the etag in the read-modify-write cycle to perform instance configuration
/// updates in order to avoid race conditions: An etag is returned in the
/// response which contains instance configurations, and systems are expected
/// to put that etag in the request to update instance configuration to ensure
/// that their change is applied to the same version of the instance
/// configuration. If no etag is provided in the call to update the instance
/// configuration, then the existing instance configuration is overwritten
/// blindly.
#[prost(string, tag = "9")]
pub etag: ::prost::alloc::string::String,
/// Allowed values of the "default_leader" schema option for databases in
/// instances that use this instance configuration.
#[prost(string, repeated, tag = "4")]
pub leader_options: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Output only. If true, the instance configuration is being created or
/// updated. If false, there are no ongoing operations for the instance
/// configuration.
#[prost(bool, tag = "10")]
pub reconciling: bool,
/// Output only. The current instance configuration state. Applicable only for
/// `USER_MANAGED` configurations.
#[prost(enumeration = "instance_config::State", tag = "11")]
pub state: i32,
}
/// Nested message and enum types in `InstanceConfig`.
pub mod instance_config {
/// The type of this configuration.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// Unspecified.
Unspecified = 0,
/// Google managed configuration.
GoogleManaged = 1,
/// User managed configuration.
UserManaged = 2,
}
impl Type {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::GoogleManaged => "GOOGLE_MANAGED",
Type::UserManaged => "USER_MANAGED",
}
}
/// 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),
"GOOGLE_MANAGED" => Some(Self::GoogleManaged),
"USER_MANAGED" => Some(Self::UserManaged),
_ => None,
}
}
}
/// Indicates the current state of the instance configuration.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Not specified.
Unspecified = 0,
/// The instance configuration is still being created.
Creating = 1,
/// The instance configuration is fully created and ready to be used to
/// create instances.
Ready = 2,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Creating => "CREATING",
State::Ready => "READY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATING" => Some(Self::Creating),
"READY" => Some(Self::Ready),
_ => None,
}
}
}
}
/// Autoscaling configuration for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AutoscalingConfig {
/// Required. Autoscaling limits for an instance.
#[prost(message, optional, tag = "1")]
pub autoscaling_limits: ::core::option::Option<
autoscaling_config::AutoscalingLimits,
>,
/// Required. The autoscaling targets for an instance.
#[prost(message, optional, tag = "2")]
pub autoscaling_targets: ::core::option::Option<
autoscaling_config::AutoscalingTargets,
>,
}
/// Nested message and enum types in `AutoscalingConfig`.
pub mod autoscaling_config {
/// The autoscaling limits for the instance. Users can define the minimum and
/// maximum compute capacity allocated to the instance, and the autoscaler will
/// only scale within that range. Users can either use nodes or processing
/// units to specify the limits, but should use the same unit to set both the
/// min_limit and max_limit.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AutoscalingLimits {
/// The minimum compute capacity for the instance.
#[prost(oneof = "autoscaling_limits::MinLimit", tags = "1, 2")]
pub min_limit: ::core::option::Option<autoscaling_limits::MinLimit>,
/// The maximum compute capacity for the instance. The maximum compute
/// capacity should be less than or equal to 10X the minimum compute
/// capacity.
#[prost(oneof = "autoscaling_limits::MaxLimit", tags = "3, 4")]
pub max_limit: ::core::option::Option<autoscaling_limits::MaxLimit>,
}
/// Nested message and enum types in `AutoscalingLimits`.
pub mod autoscaling_limits {
/// The minimum compute capacity for the instance.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum MinLimit {
/// Minimum number of nodes allocated to the instance. If set, this number
/// should be greater than or equal to 1.
#[prost(int32, tag = "1")]
MinNodes(i32),
/// Minimum number of processing units allocated to the instance. If set,
/// this number should be multiples of 1000.
#[prost(int32, tag = "2")]
MinProcessingUnits(i32),
}
/// The maximum compute capacity for the instance. The maximum compute
/// capacity should be less than or equal to 10X the minimum compute
/// capacity.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum MaxLimit {
/// Maximum number of nodes allocated to the instance. If set, this number
/// should be greater than or equal to min_nodes.
#[prost(int32, tag = "3")]
MaxNodes(i32),
/// Maximum number of processing units allocated to the instance. If set,
/// this number should be multiples of 1000 and be greater than or equal to
/// min_processing_units.
#[prost(int32, tag = "4")]
MaxProcessingUnits(i32),
}
}
/// The autoscaling targets for an instance.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AutoscalingTargets {
/// Required. The target high priority cpu utilization percentage that the
/// autoscaler should be trying to achieve for the instance. This number is
/// on a scale from 0 (no utilization) to 100 (full utilization). The valid
/// range is \[10, 90\] inclusive.
#[prost(int32, tag = "1")]
pub high_priority_cpu_utilization_percent: i32,
/// Required. The target storage utilization percentage that the autoscaler
/// should be trying to achieve for the instance. This number is on a scale
/// from 0 (no utilization) to 100 (full utilization). The valid range is
/// \[10, 100\] inclusive.
#[prost(int32, tag = "2")]
pub storage_utilization_percent: i32,
}
}
/// An isolated set of Cloud Spanner resources on which databases can be hosted.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Instance {
/// Required. A unique identifier for the instance, which cannot be changed
/// after the instance is created. Values are of the form
/// `projects/<project>/instances/[a-z][-a-z0-9]*\[a-z0-9\]`. The final
/// segment of the name must be between 2 and 64 characters in length.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The name of the instance's configuration. Values are of the form
/// `projects/<project>/instanceConfigs/<configuration>`. See
/// also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
/// [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
#[prost(string, tag = "2")]
pub config: ::prost::alloc::string::String,
/// Required. The descriptive name for this instance as it appears in UIs.
/// Must be unique per project and between 4 and 30 characters in length.
#[prost(string, tag = "3")]
pub display_name: ::prost::alloc::string::String,
/// The number of nodes allocated to this instance. At most one of either
/// node_count or processing_units should be present in the message.
///
/// Users can set the node_count field to specify the target number of nodes
/// allocated to the instance.
///
/// This may be zero in API responses for instances that are not yet in state
/// `READY`.
///
/// See [the
/// documentation](<https://cloud.google.com/spanner/docs/compute-capacity>)
/// for more information about nodes and processing units.
#[prost(int32, tag = "5")]
pub node_count: i32,
/// The number of processing units allocated to this instance. At most one of
/// processing_units or node_count should be present in the message.
///
/// Users can set the processing_units field to specify the target number of
/// processing units allocated to the instance.
///
/// This may be zero in API responses for instances that are not yet in state
/// `READY`.
///
/// See [the
/// documentation](<https://cloud.google.com/spanner/docs/compute-capacity>)
/// for more information about nodes and processing units.
#[prost(int32, tag = "9")]
pub processing_units: i32,
/// Optional. The autoscaling configuration. Autoscaling is enabled if this
/// field is set. When autoscaling is enabled, node_count and processing_units
/// are treated as OUTPUT_ONLY fields and reflect the current compute capacity
/// allocated to the instance.
#[prost(message, optional, tag = "17")]
pub autoscaling_config: ::core::option::Option<AutoscalingConfig>,
/// Output only. The current instance state. For
/// [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance],
/// the state must be either omitted or set to `CREATING`. For
/// [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance],
/// the state must be either omitted or set to `READY`.
#[prost(enumeration = "instance::State", tag = "6")]
pub state: i32,
/// Cloud Labels are a flexible and lightweight mechanism for organizing cloud
/// resources into groups that reflect a customer's organizational needs and
/// deployment strategies. Cloud Labels can be used to filter collections of
/// resources. They can be used to control how resource metrics are aggregated.
/// And they can be used as arguments to policy management rules (e.g. route,
/// firewall, load balancing, etc.).
///
/// * Label keys must be between 1 and 63 characters long and must conform to
/// the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
/// * Label values must be between 0 and 63 characters long and must conform
/// to the regular expression `\[a-z0-9_-\]{0,63}`.
/// * No more than 64 labels can be associated with a given resource.
///
/// See <https://goo.gl/xmQnxf> for more information on and examples of labels.
///
/// If you plan to use labels in your own code, please note that additional
/// characters may be allowed in the future. And so you are advised to use an
/// internal label representation, such as JSON, which doesn't rely upon
/// specific characters being disallowed. For example, representing labels
/// as the string: name + "_" + value would prove problematic if we were to
/// allow "_" in a future release.
#[prost(btree_map = "string, string", tag = "7")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Deprecated. This field is not populated.
#[prost(string, repeated, tag = "8")]
pub endpoint_uris: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Output only. The time at which the instance was created.
#[prost(message, optional, tag = "11")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The time at which the instance was most recently updated.
#[prost(message, optional, tag = "12")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. The `Edition` of the current instance.
#[prost(enumeration = "instance::Edition", tag = "20")]
pub edition: i32,
}
/// Nested message and enum types in `Instance`.
pub mod instance {
/// Indicates the current state of the instance.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Not specified.
Unspecified = 0,
/// The instance is still being created. Resources may not be
/// available yet, and operations such as database creation may not
/// work.
Creating = 1,
/// The instance is fully created and ready to do work such as
/// creating databases.
Ready = 2,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Creating => "CREATING",
State::Ready => "READY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATING" => Some(Self::Creating),
"READY" => Some(Self::Ready),
_ => None,
}
}
}
/// The edition selected for this instance. Different editions provide
/// different capabilities at different price points.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Edition {
/// Edition not specified.
Unspecified = 0,
/// Standard edition.
Standard = 1,
/// Enterprise edition.
Enterprise = 2,
/// Enterprise Plus edition.
EnterprisePlus = 3,
}
impl Edition {
/// 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 {
Edition::Unspecified => "EDITION_UNSPECIFIED",
Edition::Standard => "STANDARD",
Edition::Enterprise => "ENTERPRISE",
Edition::EnterprisePlus => "ENTERPRISE_PLUS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"EDITION_UNSPECIFIED" => Some(Self::Unspecified),
"STANDARD" => Some(Self::Standard),
"ENTERPRISE" => Some(Self::Enterprise),
"ENTERPRISE_PLUS" => Some(Self::EnterprisePlus),
_ => None,
}
}
}
}
/// The request for
/// [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstanceConfigsRequest {
/// Required. The name of the project for which a list of supported instance
/// configurations is requested. Values are of the form
/// `projects/<project>`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Number of instance configurations to be returned in the response. If 0 or
/// less, defaults to the server's maximum allowed page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// If non-empty, `page_token` should contain a
/// [next_page_token][google.spanner.admin.instance.v1.ListInstanceConfigsResponse.next_page_token]
/// from a previous
/// [ListInstanceConfigsResponse][google.spanner.admin.instance.v1.ListInstanceConfigsResponse].
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// The response for
/// [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstanceConfigsResponse {
/// The list of requested instance configurations.
#[prost(message, repeated, tag = "1")]
pub instance_configs: ::prost::alloc::vec::Vec<InstanceConfig>,
/// `next_page_token` can be sent in a subsequent
/// [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs]
/// call to fetch more of the matching instance configurations.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// The request for
/// [GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetInstanceConfigRequest {
/// Required. The name of the requested instance configuration. Values are of
/// the form `projects/<project>/instanceConfigs/<config>`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request for
/// [CreateInstanceConfigRequest][InstanceAdmin.CreateInstanceConfigRequest].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateInstanceConfigRequest {
/// Required. The name of the project in which to create the instance
/// configuration. Values are of the form `projects/<project>`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ID of the instance configuration to create. Valid identifiers
/// are of the form `custom-\[-a-z0-9\]*[a-z0-9]` and must be between 2 and 64
/// characters in length. The `custom-` prefix is required to avoid name
/// conflicts with Google-managed configurations.
#[prost(string, tag = "2")]
pub instance_config_id: ::prost::alloc::string::String,
/// Required. The InstanceConfig proto of the configuration to create.
/// instance_config.name must be
/// `<parent>/instanceConfigs/<instance_config_id>`.
/// instance_config.base_config must be a Google managed configuration name,
/// e.g. <parent>/instanceConfigs/us-east1, <parent>/instanceConfigs/nam3.
#[prost(message, optional, tag = "3")]
pub instance_config: ::core::option::Option<InstanceConfig>,
/// An option to validate, but not actually execute, a request,
/// and provide the same response.
#[prost(bool, tag = "4")]
pub validate_only: bool,
}
/// The request for
/// [UpdateInstanceConfigRequest][InstanceAdmin.UpdateInstanceConfigRequest].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateInstanceConfigRequest {
/// Required. The user instance configuration to update, which must always
/// include the instance configuration name. Otherwise, only fields mentioned
/// in
/// [update_mask][google.spanner.admin.instance.v1.UpdateInstanceConfigRequest.update_mask]
/// need be included. To prevent conflicts of concurrent updates,
/// [etag][google.spanner.admin.instance.v1.InstanceConfig.reconciling] can
/// be used.
#[prost(message, optional, tag = "1")]
pub instance_config: ::core::option::Option<InstanceConfig>,
/// Required. A mask specifying which fields in
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] should be
/// updated. The field mask must always be specified; this prevents any future
/// fields in [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig]
/// from being erased accidentally by clients that do not know about them. Only
/// display_name and labels can be updated.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// An option to validate, but not actually execute, a request,
/// and provide the same response.
#[prost(bool, tag = "3")]
pub validate_only: bool,
}
/// The request for
/// [DeleteInstanceConfigRequest][InstanceAdmin.DeleteInstanceConfigRequest].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteInstanceConfigRequest {
/// Required. The name of the instance configuration to be deleted.
/// Values are of the form
/// `projects/<project>/instanceConfigs/<instance_config>`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Used for optimistic concurrency control as a way to help prevent
/// simultaneous deletes of an instance configuration from overwriting each
/// other. If not empty, the API
/// only deletes the instance configuration when the etag provided matches the
/// current status of the requested instance configuration. Otherwise, deletes
/// the instance configuration without checking the current status of the
/// requested instance configuration.
#[prost(string, tag = "2")]
pub etag: ::prost::alloc::string::String,
/// An option to validate, but not actually execute, a request,
/// and provide the same response.
#[prost(bool, tag = "3")]
pub validate_only: bool,
}
/// The request for
/// [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstanceConfigOperationsRequest {
/// Required. The project of the instance configuration operations.
/// Values are of the form `projects/<project>`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// An expression that filters the list of returned operations.
///
/// A filter expression consists of a field name, a
/// comparison operator, and a value for filtering.
/// The value must be a string, a number, or a boolean. The comparison operator
/// must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
/// Colon `:` is the contains operator. Filter rules are not case sensitive.
///
/// The following fields in the [Operation][google.longrunning.Operation]
/// are eligible for filtering:
///
/// * `name` - The name of the long-running operation
/// * `done` - False if the operation is in progress, else true.
/// * `metadata.@type` - the type of metadata. For example, the type string
/// for
/// [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata]
/// is
/// `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`.
/// * `metadata.<field_name>` - any field in metadata.value.
/// `metadata.@type` must be specified first, if filtering on metadata
/// fields.
/// * `error` - Error associated with the long-running operation.
/// * `response.@type` - the type of response.
/// * `response.<field_name>` - any field in response.value.
///
/// You can combine multiple expressions by enclosing each expression in
/// parentheses. By default, expressions are combined with AND logic. However,
/// you can specify AND, OR, and NOT logic explicitly.
///
/// Here are a few examples:
///
/// * `done:true` - The operation is complete.
/// * `(metadata.@type=` \
/// `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata)
/// AND` \
/// `(metadata.instance_config.name:custom-config) AND` \
/// `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \
/// `(error:*)` - Return operations where:
/// * The operation's metadata type is
/// [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
/// * The instance configuration name contains "custom-config".
/// * The operation started before 2021-03-28T14:50:00Z.
/// * The operation resulted in an error.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Number of operations to be returned in the response. If 0 or
/// less, defaults to the server's maximum allowed page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// If non-empty, `page_token` should contain a
/// [next_page_token][google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse.next_page_token]
/// from a previous
/// [ListInstanceConfigOperationsResponse][google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse]
/// to the same `parent` and with the same `filter`.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// The response for
/// [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstanceConfigOperationsResponse {
/// The list of matching instance configuration [long-running
/// operations][google.longrunning.Operation]. Each operation's name will be
/// prefixed by the name of the instance configuration. The operation's
/// [metadata][google.longrunning.Operation.metadata] field type
/// `metadata.type_url` describes the type of the metadata.
#[prost(message, repeated, tag = "1")]
pub operations: ::prost::alloc::vec::Vec<
super::super::super::super::longrunning::Operation,
>,
/// `next_page_token` can be sent in a subsequent
/// [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations]
/// call to fetch more of the matching metadata.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// The request for
/// [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetInstanceRequest {
/// Required. The name of the requested instance. Values are of the form
/// `projects/<project>/instances/<instance>`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// If field_mask is present, specifies the subset of
/// [Instance][google.spanner.admin.instance.v1.Instance] fields that should be
/// returned. If absent, all
/// [Instance][google.spanner.admin.instance.v1.Instance] fields are returned.
#[prost(message, optional, tag = "2")]
pub field_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// The request for
/// [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateInstanceRequest {
/// Required. The name of the project in which to create the instance. Values
/// are of the form `projects/<project>`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ID of the instance to create. Valid identifiers are of the
/// form `[a-z][-a-z0-9]*\[a-z0-9\]` and must be between 2 and 64 characters in
/// length.
#[prost(string, tag = "2")]
pub instance_id: ::prost::alloc::string::String,
/// Required. The instance to create. The name may be omitted, but if
/// specified must be `<parent>/instances/<instance_id>`.
#[prost(message, optional, tag = "3")]
pub instance: ::core::option::Option<Instance>,
}
/// The request for
/// [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstancesRequest {
/// Required. The name of the project for which a list of instances is
/// requested. Values are of the form `projects/<project>`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Number of instances to be returned in the response. If 0 or less, defaults
/// to the server's maximum allowed page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// If non-empty, `page_token` should contain a
/// [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token]
/// from a previous
/// [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// An expression for filtering the results of the request. Filter rules are
/// case insensitive. The fields eligible for filtering are:
///
/// * `name`
/// * `display_name`
/// * `labels.key` where key is the name of a label
///
/// Some examples of using filters are:
///
/// * `name:*` --> The instance has a name.
/// * `name:Howl` --> The instance's name contains the string "howl".
/// * `name:HOWL` --> Equivalent to above.
/// * `NAME:howl` --> Equivalent to above.
/// * `labels.env:*` --> The instance has the label "env".
/// * `labels.env:dev` --> The instance has the label "env" and the value of
/// the label contains the string "dev".
/// * `name:howl labels.env:dev` --> The instance's name contains "howl" and
/// it has the label "env" with its value
/// containing "dev".
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
/// Deadline used while retrieving metadata for instances.
/// Instances whose metadata cannot be retrieved within this deadline will be
/// added to
/// [unreachable][google.spanner.admin.instance.v1.ListInstancesResponse.unreachable]
/// in
/// [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
#[prost(message, optional, tag = "5")]
pub instance_deadline: ::core::option::Option<::prost_types::Timestamp>,
}
/// The response for
/// [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstancesResponse {
/// The list of requested instances.
#[prost(message, repeated, tag = "1")]
pub instances: ::prost::alloc::vec::Vec<Instance>,
/// `next_page_token` can be sent in a subsequent
/// [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances]
/// call to fetch more of the matching instances.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
/// The list of unreachable instances.
/// It includes the names of instances whose metadata could not be retrieved
/// within
/// [instance_deadline][google.spanner.admin.instance.v1.ListInstancesRequest.instance_deadline].
#[prost(string, repeated, tag = "3")]
pub unreachable: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// The request for
/// [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateInstanceRequest {
/// Required. The instance to update, which must always include the instance
/// name. Otherwise, only fields mentioned in
/// [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask]
/// need be included.
#[prost(message, optional, tag = "1")]
pub instance: ::core::option::Option<Instance>,
/// Required. A mask specifying which fields in
/// [Instance][google.spanner.admin.instance.v1.Instance] should be updated.
/// The field mask must always be specified; this prevents any future fields in
/// [Instance][google.spanner.admin.instance.v1.Instance] from being erased
/// accidentally by clients that do not know about them.
#[prost(message, optional, tag = "2")]
pub field_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// The request for
/// [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteInstanceRequest {
/// Required. The name of the instance to be deleted. Values are of the form
/// `projects/<project>/instances/<instance>`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Metadata type for the operation returned by
/// [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateInstanceMetadata {
/// The instance being created.
#[prost(message, optional, tag = "1")]
pub instance: ::core::option::Option<Instance>,
/// The time at which the
/// [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance]
/// request was received.
#[prost(message, optional, tag = "2")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which this operation was cancelled. If set, this operation is
/// in the process of undoing itself (which is guaranteed to succeed) and
/// cannot be cancelled again.
#[prost(message, optional, tag = "3")]
pub cancel_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which this operation failed or was completed successfully.
#[prost(message, optional, tag = "4")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// The expected fulfillment period of this create operation.
#[prost(enumeration = "FulfillmentPeriod", tag = "5")]
pub expected_fulfillment_period: i32,
}
/// Metadata type for the operation returned by
/// [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateInstanceMetadata {
/// The desired end state of the update.
#[prost(message, optional, tag = "1")]
pub instance: ::core::option::Option<Instance>,
/// The time at which
/// [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance]
/// request was received.
#[prost(message, optional, tag = "2")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which this operation was cancelled. If set, this operation is
/// in the process of undoing itself (which is guaranteed to succeed) and
/// cannot be cancelled again.
#[prost(message, optional, tag = "3")]
pub cancel_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which this operation failed or was completed successfully.
#[prost(message, optional, tag = "4")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// The expected fulfillment period of this update operation.
#[prost(enumeration = "FulfillmentPeriod", tag = "5")]
pub expected_fulfillment_period: i32,
}
/// Metadata type for the operation returned by
/// [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateInstanceConfigMetadata {
/// The target instance configuration end state.
#[prost(message, optional, tag = "1")]
pub instance_config: ::core::option::Option<InstanceConfig>,
/// The progress of the
/// [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig]
/// operation.
#[prost(message, optional, tag = "2")]
pub progress: ::core::option::Option<OperationProgress>,
/// The time at which this operation was cancelled.
#[prost(message, optional, tag = "3")]
pub cancel_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Metadata type for the operation returned by
/// [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateInstanceConfigMetadata {
/// The desired instance configuration after updating.
#[prost(message, optional, tag = "1")]
pub instance_config: ::core::option::Option<InstanceConfig>,
/// The progress of the
/// [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig]
/// operation.
#[prost(message, optional, tag = "2")]
pub progress: ::core::option::Option<OperationProgress>,
/// The time at which this operation was cancelled.
#[prost(message, optional, tag = "3")]
pub cancel_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// An isolated set of Cloud Spanner resources that databases can define
/// placements on.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InstancePartition {
/// Required. A unique identifier for the instance partition. Values are of the
/// form
/// `projects/<project>/instances/<instance>/instancePartitions/[a-z][-a-z0-9]*\[a-z0-9\]`.
/// The final segment of the name must be between 2 and 64 characters in
/// length. An instance partition's name cannot be changed after the instance
/// partition is created.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The name of the instance partition's configuration. Values are of
/// the form `projects/<project>/instanceConfigs/<configuration>`. See also
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
/// [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
#[prost(string, tag = "2")]
pub config: ::prost::alloc::string::String,
/// Required. The descriptive name for this instance partition as it appears in
/// UIs. Must be unique per project and between 4 and 30 characters in length.
#[prost(string, tag = "3")]
pub display_name: ::prost::alloc::string::String,
/// Output only. The current instance partition state.
#[prost(enumeration = "instance_partition::State", tag = "7")]
pub state: i32,
/// Output only. The time at which the instance partition was created.
#[prost(message, optional, tag = "8")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The time at which the instance partition was most recently
/// updated.
#[prost(message, optional, tag = "9")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The names of the databases that reference this
/// instance partition. Referencing databases should share the parent instance.
/// The existence of any referencing database prevents the instance partition
/// from being deleted.
#[prost(string, repeated, tag = "10")]
pub referencing_databases: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Output only. The names of the backups that reference this instance
/// partition. Referencing backups should share the parent instance. The
/// existence of any referencing backup prevents the instance partition from
/// being deleted.
#[prost(string, repeated, tag = "11")]
pub referencing_backups: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Used for optimistic concurrency control as a way
/// to help prevent simultaneous updates of a instance partition from
/// overwriting each other. It is strongly suggested that systems make use of
/// the etag in the read-modify-write cycle to perform instance partition
/// updates in order to avoid race conditions: An etag is returned in the
/// response which contains instance partitions, and systems are expected to
/// put that etag in the request to update instance partitions to ensure that
/// their change will be applied to the same version of the instance partition.
/// If no etag is provided in the call to update instance partition, then the
/// existing instance partition is overwritten blindly.
#[prost(string, tag = "12")]
pub etag: ::prost::alloc::string::String,
/// Compute capacity defines amount of server and storage resources that are
/// available to the databases in an instance partition. At most one of either
/// node_count or processing_units should be present in the message. See [the
/// documentation](<https://cloud.google.com/spanner/docs/compute-capacity>)
/// for more information about nodes and processing units.
#[prost(oneof = "instance_partition::ComputeCapacity", tags = "5, 6")]
pub compute_capacity: ::core::option::Option<instance_partition::ComputeCapacity>,
}
/// Nested message and enum types in `InstancePartition`.
pub mod instance_partition {
/// Indicates the current state of the instance partition.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Not specified.
Unspecified = 0,
/// The instance partition is still being created. Resources may not be
/// available yet, and operations such as creating placements using this
/// instance partition may not work.
Creating = 1,
/// The instance partition is fully created and ready to do work such as
/// creating placements and using in databases.
Ready = 2,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Creating => "CREATING",
State::Ready => "READY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATING" => Some(Self::Creating),
"READY" => Some(Self::Ready),
_ => None,
}
}
}
/// Compute capacity defines amount of server and storage resources that are
/// available to the databases in an instance partition. At most one of either
/// node_count or processing_units should be present in the message. See [the
/// documentation](<https://cloud.google.com/spanner/docs/compute-capacity>)
/// for more information about nodes and processing units.
#[derive(Clone, Copy, PartialEq, ::prost::Oneof)]
pub enum ComputeCapacity {
/// The number of nodes allocated to this instance partition.
///
/// Users can set the node_count field to specify the target number of nodes
/// allocated to the instance partition.
///
/// This may be zero in API responses for instance partitions that are not
/// yet in state `READY`.
#[prost(int32, tag = "5")]
NodeCount(i32),
/// The number of processing units allocated to this instance partition.
///
/// Users can set the processing_units field to specify the target number of
/// processing units allocated to the instance partition.
///
/// This may be zero in API responses for instance partitions that are not
/// yet in state `READY`.
#[prost(int32, tag = "6")]
ProcessingUnits(i32),
}
}
/// Metadata type for the operation returned by
/// [CreateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstancePartition].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateInstancePartitionMetadata {
/// The instance partition being created.
#[prost(message, optional, tag = "1")]
pub instance_partition: ::core::option::Option<InstancePartition>,
/// The time at which the
/// [CreateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstancePartition]
/// request was received.
#[prost(message, optional, tag = "2")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which this operation was cancelled. If set, this operation is
/// in the process of undoing itself (which is guaranteed to succeed) and
/// cannot be cancelled again.
#[prost(message, optional, tag = "3")]
pub cancel_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which this operation failed or was completed successfully.
#[prost(message, optional, tag = "4")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// The request for
/// [CreateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstancePartition].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateInstancePartitionRequest {
/// Required. The name of the instance in which to create the instance
/// partition. Values are of the form
/// `projects/<project>/instances/<instance>`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The ID of the instance partition to create. Valid identifiers are
/// of the form `[a-z][-a-z0-9]*\[a-z0-9\]` and must be between 2 and 64
/// characters in length.
#[prost(string, tag = "2")]
pub instance_partition_id: ::prost::alloc::string::String,
/// Required. The instance partition to create. The instance_partition.name may
/// be omitted, but if specified must be
/// `<parent>/instancePartitions/<instance_partition_id>`.
#[prost(message, optional, tag = "3")]
pub instance_partition: ::core::option::Option<InstancePartition>,
}
/// The request for
/// [DeleteInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstancePartition].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteInstancePartitionRequest {
/// Required. The name of the instance partition to be deleted.
/// Values are of the form
/// `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. If not empty, the API only deletes the instance partition when
/// the etag provided matches the current status of the requested instance
/// partition. Otherwise, deletes the instance partition without checking the
/// current status of the requested instance partition.
#[prost(string, tag = "2")]
pub etag: ::prost::alloc::string::String,
}
/// The request for
/// [GetInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.GetInstancePartition].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetInstancePartitionRequest {
/// Required. The name of the requested instance partition. Values are of
/// the form
/// `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request for
/// [UpdateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstancePartition].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateInstancePartitionRequest {
/// Required. The instance partition to update, which must always include the
/// instance partition name. Otherwise, only fields mentioned in
/// [field_mask][google.spanner.admin.instance.v1.UpdateInstancePartitionRequest.field_mask]
/// need be included.
#[prost(message, optional, tag = "1")]
pub instance_partition: ::core::option::Option<InstancePartition>,
/// Required. A mask specifying which fields in
/// [InstancePartition][google.spanner.admin.instance.v1.InstancePartition]
/// should be updated. The field mask must always be specified; this prevents
/// any future fields in
/// [InstancePartition][google.spanner.admin.instance.v1.InstancePartition]
/// from being erased accidentally by clients that do not know about them.
#[prost(message, optional, tag = "2")]
pub field_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Metadata type for the operation returned by
/// [UpdateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstancePartition].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateInstancePartitionMetadata {
/// The desired end state of the update.
#[prost(message, optional, tag = "1")]
pub instance_partition: ::core::option::Option<InstancePartition>,
/// The time at which
/// [UpdateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstancePartition]
/// request was received.
#[prost(message, optional, tag = "2")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which this operation was cancelled. If set, this operation is
/// in the process of undoing itself (which is guaranteed to succeed) and
/// cannot be cancelled again.
#[prost(message, optional, tag = "3")]
pub cancel_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time at which this operation failed or was completed successfully.
#[prost(message, optional, tag = "4")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// The request for
/// [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstancePartitionsRequest {
/// Required. The instance whose instance partitions should be listed. Values
/// are of the form `projects/<project>/instances/<instance>`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Number of instance partitions to be returned in the response. If 0 or less,
/// defaults to the server's maximum allowed page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// If non-empty, `page_token` should contain a
/// [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.next_page_token]
/// from a previous
/// [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Optional. Deadline used while retrieving metadata for instance partitions.
/// Instance partitions whose metadata cannot be retrieved within this deadline
/// will be added to
/// [unreachable][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.unreachable]
/// in
/// [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
#[prost(message, optional, tag = "4")]
pub instance_partition_deadline: ::core::option::Option<::prost_types::Timestamp>,
}
/// The response for
/// [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstancePartitionsResponse {
/// The list of requested instancePartitions.
#[prost(message, repeated, tag = "1")]
pub instance_partitions: ::prost::alloc::vec::Vec<InstancePartition>,
/// `next_page_token` can be sent in a subsequent
/// [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions]
/// call to fetch more of the matching instance partitions.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
/// The list of unreachable instance partitions.
/// It includes the names of instance partitions whose metadata could
/// not be retrieved within
/// [instance_partition_deadline][google.spanner.admin.instance.v1.ListInstancePartitionsRequest.instance_partition_deadline].
#[prost(string, repeated, tag = "3")]
pub unreachable: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// The request for
/// [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstancePartitionOperationsRequest {
/// Required. The parent instance of the instance partition operations.
/// Values are of the form `projects/<project>/instances/<instance>`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. An expression that filters the list of returned operations.
///
/// A filter expression consists of a field name, a
/// comparison operator, and a value for filtering.
/// The value must be a string, a number, or a boolean. The comparison operator
/// must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
/// Colon `:` is the contains operator. Filter rules are not case sensitive.
///
/// The following fields in the [Operation][google.longrunning.Operation]
/// are eligible for filtering:
///
/// * `name` - The name of the long-running operation
/// * `done` - False if the operation is in progress, else true.
/// * `metadata.@type` - the type of metadata. For example, the type string
/// for
/// [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata]
/// is
/// `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`.
/// * `metadata.<field_name>` - any field in metadata.value.
/// `metadata.@type` must be specified first, if filtering on metadata
/// fields.
/// * `error` - Error associated with the long-running operation.
/// * `response.@type` - the type of response.
/// * `response.<field_name>` - any field in response.value.
///
/// You can combine multiple expressions by enclosing each expression in
/// parentheses. By default, expressions are combined with AND logic. However,
/// you can specify AND, OR, and NOT logic explicitly.
///
/// Here are a few examples:
///
/// * `done:true` - The operation is complete.
/// * `(metadata.@type=` \
/// `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata)
/// AND` \
/// `(metadata.instance_partition.name:custom-instance-partition) AND` \
/// `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \
/// `(error:*)` - Return operations where:
/// * The operation's metadata type is
/// [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
/// * The instance partition name contains "custom-instance-partition".
/// * The operation started before 2021-03-28T14:50:00Z.
/// * The operation resulted in an error.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Optional. Number of operations to be returned in the response. If 0 or
/// less, defaults to the server's maximum allowed page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Optional. If non-empty, `page_token` should contain a
/// [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.next_page_token]
/// from a previous
/// [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse]
/// to the same `parent` and with the same `filter`.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Optional. Deadline used while retrieving metadata for instance partition
/// operations. Instance partitions whose operation metadata cannot be
/// retrieved within this deadline will be added to
/// [unreachable][ListInstancePartitionOperationsResponse.unreachable] in
/// [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse].
#[prost(message, optional, tag = "5")]
pub instance_partition_deadline: ::core::option::Option<::prost_types::Timestamp>,
}
/// The response for
/// [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInstancePartitionOperationsResponse {
/// The list of matching instance partition [long-running
/// operations][google.longrunning.Operation]. Each operation's name will be
/// prefixed by the instance partition's name. The operation's
/// [metadata][google.longrunning.Operation.metadata] field type
/// `metadata.type_url` describes the type of the metadata.
#[prost(message, repeated, tag = "1")]
pub operations: ::prost::alloc::vec::Vec<
super::super::super::super::longrunning::Operation,
>,
/// `next_page_token` can be sent in a subsequent
/// [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations]
/// call to fetch more of the matching metadata.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
/// The list of unreachable instance partitions.
/// It includes the names of instance partitions whose operation metadata could
/// not be retrieved within
/// [instance_partition_deadline][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.instance_partition_deadline].
#[prost(string, repeated, tag = "3")]
pub unreachable_instance_partitions: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
}
/// The request for
/// [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MoveInstanceRequest {
/// Required. The instance to move.
/// Values are of the form `projects/<project>/instances/<instance>`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The target instance configuration where to move the instance.
/// Values are of the form `projects/<project>/instanceConfigs/<config>`.
#[prost(string, tag = "2")]
pub target_config: ::prost::alloc::string::String,
}
/// The response for
/// [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct MoveInstanceResponse {}
/// Metadata type for the operation returned by
/// [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MoveInstanceMetadata {
/// The target instance configuration where to move the instance.
/// Values are of the form `projects/<project>/instanceConfigs/<config>`.
#[prost(string, tag = "1")]
pub target_config: ::prost::alloc::string::String,
/// The progress of the
/// [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance]
/// operation.
/// [progress_percent][google.spanner.admin.instance.v1.OperationProgress.progress_percent]
/// is reset when cancellation is requested.
#[prost(message, optional, tag = "2")]
pub progress: ::core::option::Option<OperationProgress>,
/// The time at which this operation was cancelled.
#[prost(message, optional, tag = "3")]
pub cancel_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Generated client implementations.
pub mod instance_admin_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Cloud Spanner Instance Admin API
///
/// The Cloud Spanner Instance Admin API can be used to create, delete,
/// modify and list instances. Instances are dedicated Cloud Spanner serving
/// and storage resources to be used by Cloud Spanner databases.
///
/// Each instance has a "configuration", which dictates where the
/// serving resources for the Cloud Spanner instance are located (e.g.,
/// US-central, Europe). Configurations are created by Google based on
/// resource availability.
///
/// Cloud Spanner billing is based on the instances that exist and their
/// sizes. After an instance exists, there are no additional
/// per-database or per-operation charges for use of the instance
/// (though there may be additional network bandwidth charges).
/// Instances offer isolation: problems with databases in one instance
/// will not affect other instances. However, within an instance
/// databases can affect each other. For example, if one database in an
/// instance receives a lot of requests and consumes most of the
/// instance resources, fewer resources are available for other
/// databases in that instance, and their performance may suffer.
#[derive(Debug, Clone)]
pub struct InstanceAdminClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> InstanceAdminClient<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,
) -> InstanceAdminClient<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,
{
InstanceAdminClient::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
}
/// Lists the supported instance configurations for a given project.
pub async fn list_instance_configs(
&mut self,
request: impl tonic::IntoRequest<super::ListInstanceConfigsRequest>,
) -> std::result::Result<
tonic::Response<super::ListInstanceConfigsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/ListInstanceConfigs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"ListInstanceConfigs",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets information about a particular instance configuration.
pub async fn get_instance_config(
&mut self,
request: impl tonic::IntoRequest<super::GetInstanceConfigRequest>,
) -> std::result::Result<tonic::Response<super::InstanceConfig>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/GetInstanceConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"GetInstanceConfig",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an instance configuration and begins preparing it to be used. The
/// returned [long-running operation][google.longrunning.Operation]
/// can be used to track the progress of preparing the new
/// instance configuration. The instance configuration name is assigned by the
/// caller. If the named instance configuration already exists,
/// `CreateInstanceConfig` returns `ALREADY_EXISTS`.
///
/// Immediately after the request returns:
///
/// * The instance configuration is readable via the API, with all requested
/// attributes. The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field is set to true. Its state is `CREATING`.
///
/// While the operation is pending:
///
/// * Cancelling the operation renders the instance configuration immediately
/// unreadable via the API.
/// * Except for deleting the creating resource, all other attempts to modify
/// the instance configuration are rejected.
///
/// Upon completion of the returned operation:
///
/// * Instances can be created using the instance configuration.
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field becomes false. Its state becomes `READY`.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format
/// `<instance_config_name>/operations/<operation_id>` and can be used to track
/// creation of the instance configuration. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
/// successful.
///
/// Authorization requires `spanner.instanceConfigs.create` permission on
/// the resource
/// [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
pub async fn create_instance_config(
&mut self,
request: impl tonic::IntoRequest<super::CreateInstanceConfigRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/CreateInstanceConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"CreateInstanceConfig",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an instance configuration. The returned
/// [long-running operation][google.longrunning.Operation] can be used to track
/// the progress of updating the instance. If the named instance configuration
/// does not exist, returns `NOT_FOUND`.
///
/// Only user-managed configurations can be updated.
///
/// Immediately after the request returns:
///
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field is set to true.
///
/// While the operation is pending:
///
/// * Cancelling the operation sets its metadata's
/// [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time].
/// The operation is guaranteed to succeed at undoing all changes, after
/// which point it terminates with a `CANCELLED` status.
/// * All other attempts to modify the instance configuration are rejected.
/// * Reading the instance configuration via the API continues to give the
/// pre-request values.
///
/// Upon completion of the returned operation:
///
/// * Creating instances using the instance configuration uses the new
/// values.
/// * The new values of the instance configuration are readable via the API.
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field becomes false.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format
/// `<instance_config_name>/operations/<operation_id>` and can be used to track
/// the instance configuration modification. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
/// successful.
///
/// Authorization requires `spanner.instanceConfigs.update` permission on
/// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
pub async fn update_instance_config(
&mut self,
request: impl tonic::IntoRequest<super::UpdateInstanceConfigRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/UpdateInstanceConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"UpdateInstanceConfig",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes the instance configuration. Deletion is only allowed when no
/// instances are using the configuration. If any instances are using
/// the configuration, returns `FAILED_PRECONDITION`.
///
/// Only user-managed configurations can be deleted.
///
/// Authorization requires `spanner.instanceConfigs.delete` permission on
/// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
pub async fn delete_instance_config(
&mut self,
request: impl tonic::IntoRequest<super::DeleteInstanceConfigRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/DeleteInstanceConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"DeleteInstanceConfig",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists the user-managed instance configuration [long-running
/// operations][google.longrunning.Operation] in the given project. An instance
/// configuration operation has a name of the form
/// `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
/// The long-running operation
/// [metadata][google.longrunning.Operation.metadata] field type
/// `metadata.type_url` describes the type of the metadata. Operations returned
/// include those that have completed/failed/canceled within the last 7 days,
/// and pending operations. Operations returned are ordered by
/// `operation.metadata.value.start_time` in descending order starting
/// from the most recently started operation.
pub async fn list_instance_config_operations(
&mut self,
request: impl tonic::IntoRequest<super::ListInstanceConfigOperationsRequest>,
) -> std::result::Result<
tonic::Response<super::ListInstanceConfigOperationsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/ListInstanceConfigOperations",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"ListInstanceConfigOperations",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all instances in the given project.
pub async fn list_instances(
&mut self,
request: impl tonic::IntoRequest<super::ListInstancesRequest>,
) -> std::result::Result<
tonic::Response<super::ListInstancesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/ListInstances",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"ListInstances",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists all instance partitions for the given instance.
pub async fn list_instance_partitions(
&mut self,
request: impl tonic::IntoRequest<super::ListInstancePartitionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListInstancePartitionsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/ListInstancePartitions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"ListInstancePartitions",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets information about a particular instance.
pub async fn get_instance(
&mut self,
request: impl tonic::IntoRequest<super::GetInstanceRequest>,
) -> std::result::Result<tonic::Response<super::Instance>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/GetInstance",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"GetInstance",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an instance and begins preparing it to begin serving. The
/// returned [long-running operation][google.longrunning.Operation]
/// can be used to track the progress of preparing the new
/// instance. The instance name is assigned by the caller. If the
/// named instance already exists, `CreateInstance` returns
/// `ALREADY_EXISTS`.
///
/// Immediately upon completion of this request:
///
/// * The instance is readable via the API, with all requested attributes
/// but no allocated resources. Its state is `CREATING`.
///
/// Until completion of the returned operation:
///
/// * Cancelling the operation renders the instance immediately unreadable
/// via the API.
/// * The instance can be deleted.
/// * All other attempts to modify the instance are rejected.
///
/// Upon completion of the returned operation:
///
/// * Billing for all successfully-allocated resources begins (some types
/// may have lower than the requested levels).
/// * Databases can be created in the instance.
/// * The instance's allocated resource levels are readable via the API.
/// * The instance's state becomes `READY`.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format `<instance_name>/operations/<operation_id>` and
/// can be used to track creation of the instance. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [Instance][google.spanner.admin.instance.v1.Instance], if successful.
pub async fn create_instance(
&mut self,
request: impl tonic::IntoRequest<super::CreateInstanceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/CreateInstance",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"CreateInstance",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an instance, and begins allocating or releasing resources
/// as requested. The returned [long-running
/// operation][google.longrunning.Operation] can be used to track the
/// progress of updating the instance. If the named instance does not
/// exist, returns `NOT_FOUND`.
///
/// Immediately upon completion of this request:
///
/// * For resource types for which a decrease in the instance's allocation
/// has been requested, billing is based on the newly-requested level.
///
/// Until completion of the returned operation:
///
/// * Cancelling the operation sets its metadata's
/// [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time],
/// and begins restoring resources to their pre-request values. The
/// operation is guaranteed to succeed at undoing all resource changes,
/// after which point it terminates with a `CANCELLED` status.
/// * All other attempts to modify the instance are rejected.
/// * Reading the instance via the API continues to give the pre-request
/// resource levels.
///
/// Upon completion of the returned operation:
///
/// * Billing begins for all successfully-allocated resources (some types
/// may have lower than the requested levels).
/// * All newly-reserved resources are available for serving the instance's
/// tables.
/// * The instance's new resource levels are readable via the API.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format `<instance_name>/operations/<operation_id>` and
/// can be used to track the instance modification. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [Instance][google.spanner.admin.instance.v1.Instance], if successful.
///
/// Authorization requires `spanner.instances.update` permission on
/// the resource [name][google.spanner.admin.instance.v1.Instance.name].
pub async fn update_instance(
&mut self,
request: impl tonic::IntoRequest<super::UpdateInstanceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/UpdateInstance",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"UpdateInstance",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an instance.
///
/// Immediately upon completion of the request:
///
/// * Billing ceases for all of the instance's reserved resources.
///
/// Soon afterward:
///
/// * The instance and *all of its databases* immediately and
/// irrevocably disappear from the API. All data in the databases
/// is permanently deleted.
pub async fn delete_instance(
&mut self,
request: impl tonic::IntoRequest<super::DeleteInstanceRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/DeleteInstance",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"DeleteInstance",
),
);
self.inner.unary(req, path, codec).await
}
/// Sets the access control policy on an instance resource. Replaces any
/// existing policy.
///
/// Authorization requires `spanner.instances.setIamPolicy` on
/// [resource][google.iam.v1.SetIamPolicyRequest.resource].
pub async fn set_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::super::iam::v1::SetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::iam::v1::Policy>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/SetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"SetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the access control policy for an instance resource. Returns an empty
/// policy if an instance exists but does not have a policy set.
///
/// Authorization requires `spanner.instances.getIamPolicy` on
/// [resource][google.iam.v1.GetIamPolicyRequest.resource].
pub async fn get_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::super::iam::v1::GetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::iam::v1::Policy>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/GetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"GetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns permissions that the caller has on the specified instance resource.
///
/// Attempting this RPC on a non-existent Cloud Spanner instance resource will
/// result in a NOT_FOUND error if the user has `spanner.instances.list`
/// permission on the containing Google Cloud Project. Otherwise returns an
/// empty set of permissions.
pub async fn test_iam_permissions(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::super::iam::v1::TestIamPermissionsRequest,
>,
) -> std::result::Result<
tonic::Response<
super::super::super::super::super::iam::v1::TestIamPermissionsResponse,
>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/TestIamPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"TestIamPermissions",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets information about a particular instance partition.
pub async fn get_instance_partition(
&mut self,
request: impl tonic::IntoRequest<super::GetInstancePartitionRequest>,
) -> std::result::Result<
tonic::Response<super::InstancePartition>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/GetInstancePartition",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"GetInstancePartition",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates an instance partition and begins preparing it to be used. The
/// returned [long-running operation][google.longrunning.Operation]
/// can be used to track the progress of preparing the new instance partition.
/// The instance partition name is assigned by the caller. If the named
/// instance partition already exists, `CreateInstancePartition` returns
/// `ALREADY_EXISTS`.
///
/// Immediately upon completion of this request:
///
/// * The instance partition is readable via the API, with all requested
/// attributes but no allocated resources. Its state is `CREATING`.
///
/// Until completion of the returned operation:
///
/// * Cancelling the operation renders the instance partition immediately
/// unreadable via the API.
/// * The instance partition can be deleted.
/// * All other attempts to modify the instance partition are rejected.
///
/// Upon completion of the returned operation:
///
/// * Billing for all successfully-allocated resources begins (some types
/// may have lower than the requested levels).
/// * Databases can start using this instance partition.
/// * The instance partition's allocated resource levels are readable via the
/// API.
/// * The instance partition's state becomes `READY`.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format
/// `<instance_partition_name>/operations/<operation_id>` and can be used to
/// track creation of the instance partition. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if
/// successful.
pub async fn create_instance_partition(
&mut self,
request: impl tonic::IntoRequest<super::CreateInstancePartitionRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/CreateInstancePartition",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"CreateInstancePartition",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes an existing instance partition. Requires that the
/// instance partition is not used by any database or backup and is not the
/// default instance partition of an instance.
///
/// Authorization requires `spanner.instancePartitions.delete` permission on
/// the resource
/// [name][google.spanner.admin.instance.v1.InstancePartition.name].
pub async fn delete_instance_partition(
&mut self,
request: impl tonic::IntoRequest<super::DeleteInstancePartitionRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/DeleteInstancePartition",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"DeleteInstancePartition",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates an instance partition, and begins allocating or releasing resources
/// as requested. The returned [long-running
/// operation][google.longrunning.Operation] can be used to track the
/// progress of updating the instance partition. If the named instance
/// partition does not exist, returns `NOT_FOUND`.
///
/// Immediately upon completion of this request:
///
/// * For resource types for which a decrease in the instance partition's
/// allocation has been requested, billing is based on the newly-requested
/// level.
///
/// Until completion of the returned operation:
///
/// * Cancelling the operation sets its metadata's
/// [cancel_time][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata.cancel_time],
/// and begins restoring resources to their pre-request values. The
/// operation is guaranteed to succeed at undoing all resource changes,
/// after which point it terminates with a `CANCELLED` status.
/// * All other attempts to modify the instance partition are rejected.
/// * Reading the instance partition via the API continues to give the
/// pre-request resource levels.
///
/// Upon completion of the returned operation:
///
/// * Billing begins for all successfully-allocated resources (some types
/// may have lower than the requested levels).
/// * All newly-reserved resources are available for serving the instance
/// partition's tables.
/// * The instance partition's new resource levels are readable via the API.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format
/// `<instance_partition_name>/operations/<operation_id>` and can be used to
/// track the instance partition modification. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if
/// successful.
///
/// Authorization requires `spanner.instancePartitions.update` permission on
/// the resource
/// [name][google.spanner.admin.instance.v1.InstancePartition.name].
pub async fn update_instance_partition(
&mut self,
request: impl tonic::IntoRequest<super::UpdateInstancePartitionRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/UpdateInstancePartition",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"UpdateInstancePartition",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists instance partition [long-running
/// operations][google.longrunning.Operation] in the given instance.
/// An instance partition operation has a name of the form
/// `projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/operations/<operation>`.
/// The long-running operation
/// [metadata][google.longrunning.Operation.metadata] field type
/// `metadata.type_url` describes the type of the metadata. Operations returned
/// include those that have completed/failed/canceled within the last 7 days,
/// and pending operations. Operations returned are ordered by
/// `operation.metadata.value.start_time` in descending order starting from the
/// most recently started operation.
///
/// Authorization requires `spanner.instancePartitionOperations.list`
/// permission on the resource
/// [parent][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.parent].
pub async fn list_instance_partition_operations(
&mut self,
request: impl tonic::IntoRequest<
super::ListInstancePartitionOperationsRequest,
>,
) -> std::result::Result<
tonic::Response<super::ListInstancePartitionOperationsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/ListInstancePartitionOperations",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"ListInstancePartitionOperations",
),
);
self.inner.unary(req, path, codec).await
}
/// Moves an instance to the target instance configuration. You can use the
/// returned [long-running operation][google.longrunning.Operation] to track
/// the progress of moving the instance.
///
/// `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of
/// the following criteria:
///
/// * Is undergoing a move to a different instance configuration
/// * Has backups
/// * Has an ongoing update
/// * Contains any CMEK-enabled databases
/// * Is a free trial instance
///
/// While the operation is pending:
///
/// * All other attempts to modify the instance, including changes to its
/// compute capacity, are rejected.
/// * The following database and backup admin operations are rejected:
///
/// * `DatabaseAdmin.CreateDatabase`
/// * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is
/// specified in the request.)
/// * `DatabaseAdmin.RestoreDatabase`
/// * `DatabaseAdmin.CreateBackup`
/// * `DatabaseAdmin.CopyBackup`
///
/// * Both the source and target instance configurations are subject to
/// hourly compute and storage charges.
/// * The instance might experience higher read-write latencies and a higher
/// transaction abort rate. However, moving an instance doesn't cause any
/// downtime.
///
/// The returned [long-running operation][google.longrunning.Operation] has
/// a name of the format
/// `<instance_name>/operations/<operation_id>` and can be used to track
/// the move instance operation. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [MoveInstanceMetadata][google.spanner.admin.instance.v1.MoveInstanceMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [Instance][google.spanner.admin.instance.v1.Instance],
/// if successful.
/// Cancelling the operation sets its metadata's
/// [cancel_time][google.spanner.admin.instance.v1.MoveInstanceMetadata.cancel_time].
/// Cancellation is not immediate because it involves moving any data
/// previously moved to the target instance configuration back to the original
/// instance configuration. You can use this operation to track the progress of
/// the cancellation. Upon successful completion of the cancellation, the
/// operation terminates with `CANCELLED` status.
///
/// If not cancelled, upon completion of the returned operation:
///
/// * The instance successfully moves to the target instance
/// configuration.
/// * You are billed for compute and storage in target instance
/// configuration.
///
/// Authorization requires the `spanner.instances.update` permission on
/// the resource [instance][google.spanner.admin.instance.v1.Instance].
///
/// For more details, see
/// [Move an instance](https://cloud.google.com/spanner/docs/move-instance).
pub async fn move_instance(
&mut self,
request: impl tonic::IntoRequest<super::MoveInstanceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.spanner.admin.instance.v1.InstanceAdmin/MoveInstance",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.spanner.admin.instance.v1.InstanceAdmin",
"MoveInstance",
),
);
self.inner.unary(req, path, codec).await
}
}
}