File size: 188,468 Bytes
065fee7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 |
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://alloydb.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud AlloyDB Admin",
"description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/alloydb/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "alloydb:v1alpha",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://alloydb.mtls.googleapis.com/",
"name": "alloydb",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "alloydb.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "GoogleCloudLocationLocation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1alpha/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "alloydb.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}/locations",
"response": {
"$ref": "GoogleCloudLocationListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"backups": {
"methods": {
"create": {
"description": "Creates a new Backup in a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/backups",
"httpMethod": "POST",
"id": "alloydb.projects.locations.backups.create",
"parameterOrder": [
"parent"
],
"parameters": {
"backupId": {
"description": "Required. ID of the requesting object.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Value for parent.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+parent}/backups",
"request": {
"$ref": "Backup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a single Backup.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}",
"httpMethod": "DELETE",
"id": "alloydb.projects.locations.backups.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The current etag of the Backup. If an etag is provided and does not match the current etag of the Backup, deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. Name of the resource. For the required format, see the comment on the Backup.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of a single Backup.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}",
"httpMethod": "GET",
"id": "alloydb.projects.locations.backups.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the resource",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Backup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Backups in a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/backups",
"httpMethod": "GET",
"id": "alloydb.projects.locations.backups.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Filtering results",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Hint for how to order the results",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent value for ListBackupsRequest",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/backups",
"response": {
"$ref": "ListBackupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the parameters of a single Backup.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}",
"httpMethod": "PATCH",
"id": "alloydb.projects.locations.backups.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and `update_mask` is ignored.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/backups/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "Backup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"clusters": {
"methods": {
"create": {
"description": "Creates a new Cluster in a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.create",
"parameterOrder": [
"parent"
],
"parameters": {
"clusterId": {
"description": "Required. ID of the requesting object.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+parent}/clusters",
"request": {
"$ref": "Cluster"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"createsecondary": {
"description": "Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters:createsecondary",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.createsecondary",
"parameterOrder": [
"parent"
],
"parameters": {
"clusterId": {
"description": "Required. ID of the requesting object (the secondary cluster).",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+parent}/clusters:createsecondary",
"request": {
"$ref": "Cluster"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a single Cluster.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
"httpMethod": "DELETE",
"id": "alloydb.projects.locations.clusters.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
"type": "string"
},
"force": {
"description": "Optional. Whether to cascade delete child instances for given cluster.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Cluster.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of a single Cluster.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
"httpMethod": "GET",
"id": "alloydb.projects.locations.clusters.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Cluster.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Optional. The view of the cluster to return. Returns all default fields if not set.",
"enum": [
"CLUSTER_VIEW_UNSPECIFIED",
"CLUSTER_VIEW_BASIC",
"CLUSTER_VIEW_CONTINUOUS_BACKUP"
],
"enumDescriptions": [
"CLUSTER_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.",
"BASIC server responses include all the relevant cluster details, excluding Cluster.ContinuousBackupInfo.EarliestRestorableTime and other view-specific fields. The default value.",
"CONTINUOUS_BACKUP response returns all the fields from BASIC plus the earliest restorable time if continuous backups are enabled. May increase latency."
],
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Cluster"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Clusters in a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters",
"httpMethod": "GET",
"id": "alloydb.projects.locations.clusters.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filtering results",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Hint for how to order the results",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/clusters",
"response": {
"$ref": "ListClustersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the parameters of a single Cluster.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
"httpMethod": "PATCH",
"id": "alloydb.projects.locations.clusters.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created and `update_mask` is ignored.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "Cluster"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"promote": {
"description": "Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:promote",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.promote",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Cluster.name field",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:promote",
"request": {
"$ref": "PromoteClusterRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"restore": {
"description": "Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters:restore",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.restore",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/clusters:restore",
"request": {
"$ref": "RestoreClusterRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"switchover": {
"description": "Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:switchover",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.switchover",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Cluster.name field",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:switchover",
"request": {
"$ref": "SwitchoverClusterRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"upgrade": {
"description": "Upgrades a single Cluster. Imperative only.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade",
"httpMethod": "PATCH",
"id": "alloydb.projects.locations.clusters.upgrade",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the cluster.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:upgrade",
"request": {
"$ref": "UpgradeClusterRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"instances": {
"methods": {
"create": {
"description": "Creates a new Instance in a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.instances.create",
"parameterOrder": [
"parent"
],
"parameters": {
"instanceId": {
"description": "Required. ID of the requesting object.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+parent}/instances",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"createsecondary": {
"description": "Creates a new SECONDARY Instance in a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances:createsecondary",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.instances.createsecondary",
"parameterOrder": [
"parent"
],
"parameters": {
"instanceId": {
"description": "Required. ID of the requesting object.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+parent}/instances:createsecondary",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a single Instance.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}",
"httpMethod": "DELETE",
"id": "alloydb.projects.locations.clusters.instances.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The current etag of the Instance. If an etag is provided and does not match the current etag of the Instance, deletion will be blocked and an ABORTED error will be returned.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Instance.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"failover": {
"description": "Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:failover",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.instances.failover",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Instance.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:failover",
"request": {
"$ref": "FailoverInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of a single Instance.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}",
"httpMethod": "GET",
"id": "alloydb.projects.locations.clusters.instances.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Instance.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "The view of the instance to return.",
"enum": [
"INSTANCE_VIEW_UNSPECIFIED",
"INSTANCE_VIEW_BASIC",
"INSTANCE_VIEW_FULL"
],
"enumDescriptions": [
"INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.",
"BASIC server responses for a primary or read instance include all the relevant instance details, excluding the details of each node in the instance. The default value.",
"FULL response is equivalent to BASIC for primary instance (for now). For read pool instance, this includes details of each node in the pool."
],
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Instance"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getConnectionInfo": {
"description": "Get instance metadata used for a connection.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}/connectionInfo",
"httpMethod": "GET",
"id": "alloydb.projects.locations.clusters.instances.getConnectionInfo",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+parent}/connectionInfo",
"response": {
"$ref": "ConnectionInfo"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"injectFault": {
"description": "Injects fault in an instance. Imperative only.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:injectFault",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.instances.injectFault",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Instance.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:injectFault",
"request": {
"$ref": "InjectFaultRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Instances in a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances",
"httpMethod": "GET",
"id": "alloydb.projects.locations.clusters.instances.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filtering results",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Hint for how to order the results",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project}/locations/-/clusters/- * projects/{project}/locations/{region}/clusters/-",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/instances",
"response": {
"$ref": "ListInstancesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the parameters of a single Instance.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}",
"httpMethod": "PATCH",
"id": "alloydb.projects.locations.clusters.instances.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and `update_mask` is ignored.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"restart": {
"description": "Restart an Instance in a cluster. Imperative only.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:restart",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.instances.restart",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the Instance.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:restart",
"request": {
"$ref": "RestartInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"users": {
"methods": {
"create": {
"description": "Creates a new User in a given project, location, and cluster.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users",
"httpMethod": "POST",
"id": "alloydb.projects.locations.clusters.users.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Value for parent.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"userId": {
"description": "Required. ID of the requesting object.",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+parent}/users",
"request": {
"$ref": "User"
},
"response": {
"$ref": "User"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a single User.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}",
"httpMethod": "DELETE",
"id": "alloydb.projects.locations.clusters.users.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the User.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets details of a single User.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}",
"httpMethod": "GET",
"id": "alloydb.projects.locations.clusters.users.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the resource. For the required format, see the comment on the User.name field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "User"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Users in a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users",
"httpMethod": "GET",
"id": "alloydb.projects.locations.clusters.users.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filtering results",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Hint for how to order the results",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A token identifying a page of results the server should return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent value for ListUsersRequest",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/users",
"response": {
"$ref": "ListUsersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the parameters of a single User.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}",
"httpMethod": "PATCH",
"id": "alloydb.projects.locations.clusters.users.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. Allow missing fields in the update mask.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, the backend validates the request, but doesn't actually execute it.",
"location": "query",
"type": "boolean"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "User"
},
"response": {
"$ref": "User"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "alloydb.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "alloydb.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "alloydb.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "alloydb.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"supportedDatabaseFlags": {
"methods": {
"list": {
"description": "Lists SupportedDatabaseFlags for a given project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/supportedDatabaseFlags",
"httpMethod": "GET",
"id": "alloydb.projects.locations.supportedDatabaseFlags.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+parent}/supportedDatabaseFlags",
"response": {
"$ref": "ListSupportedDatabaseFlagsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20240806",
"rootUrl": "https://alloydb.googleapis.com/",
"schemas": {
"AuthorizedNetwork": {
"description": "AuthorizedNetwork contains metadata for an authorized network.",
"id": "AuthorizedNetwork",
"properties": {
"cidrRange": {
"description": "CIDR range for one authorzied network of the instance.",
"type": "string"
}
},
"type": "object"
},
"AutomatedBackupPolicy": {
"description": "Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.",
"id": "AutomatedBackupPolicy",
"properties": {
"backupWindow": {
"description": "The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.",
"format": "google-duration",
"type": "string"
},
"enabled": {
"description": "Whether automated automated backups are enabled. If not set, defaults to true.",
"type": "boolean"
},
"encryptionConfig": {
"$ref": "EncryptionConfig",
"description": "Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to backups created using this configuration.",
"type": "object"
},
"location": {
"description": "The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.",
"type": "string"
},
"quantityBasedRetention": {
"$ref": "QuantityBasedRetention",
"description": "Quantity-based Backup retention policy to retain recent backups."
},
"timeBasedRetention": {
"$ref": "TimeBasedRetention",
"description": "Time-based Backup retention policy."
},
"weeklySchedule": {
"$ref": "WeeklySchedule",
"description": "Weekly schedule for the Backup."
}
},
"type": "object"
},
"Backup": {
"description": "Message describing Backup object",
"id": "Backup",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128",
"type": "object"
},
"clusterName": {
"description": "Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).",
"type": "string"
},
"clusterUid": {
"description": "Output only. The system-generated UID of the cluster which was used to create this resource.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. Create time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"databaseVersion": {
"description": "Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.",
"enum": [
"DATABASE_VERSION_UNSPECIFIED",
"POSTGRES_13",
"POSTGRES_14",
"POSTGRES_15",
"POSTGRES_16"
],
"enumDeprecated": [
false,
true,
false,
false,
false
],
"enumDescriptions": [
"This is an unknown database version.",
"DEPRECATED - The database version is Postgres 13.",
"The database version is Postgres 14.",
"The database version is Postgres 15.",
"The database version is Postgres 16."
],
"readOnly": true,
"type": "string"
},
"deleteTime": {
"description": "Output only. Delete time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "User-provided description of the backup.",
"type": "string"
},
"displayName": {
"description": "User-settable and human-readable display name for the Backup.",
"type": "string"
},
"encryptionConfig": {
"$ref": "EncryptionConfig",
"description": "Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data."
},
"encryptionInfo": {
"$ref": "EncryptionInfo",
"description": "Output only. The encryption information for the backup.",
"readOnly": true
},
"etag": {
"description": "For Resource freshness validation (https://google.aip.dev/154)",
"type": "string"
},
"expiryQuantity": {
"$ref": "QuantityBasedExpiry",
"description": "Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.",
"readOnly": true
},
"expiryTime": {
"description": "Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels as key value pairs",
"type": "object"
},
"name": {
"description": "Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}",
"readOnly": true,
"type": "string"
},
"reconciling": {
"description": "Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"sizeBytes": {
"description": "Output only. The size of the backup in bytes.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The current state of the backup.",
"enum": [
"STATE_UNSPECIFIED",
"READY",
"CREATING",
"FAILED",
"DELETING"
],
"enumDescriptions": [
"The state of the backup is unknown.",
"The backup is ready.",
"The backup is creating.",
"The backup failed.",
"The backup is being deleted."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "The backup type, which suggests the trigger for the backup.",
"enum": [
"TYPE_UNSPECIFIED",
"ON_DEMAND",
"AUTOMATED",
"CONTINUOUS"
],
"enumDescriptions": [
"Backup Type is unknown.",
"ON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).",
"AUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.",
"CONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy."
],
"type": "string"
},
"uid": {
"description": "Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. Update time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BackupSource": {
"description": "Message describing a BackupSource.",
"id": "BackupSource",
"properties": {
"backupName": {
"description": "Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}",
"type": "string"
},
"backupUid": {
"description": "Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"ClientConnectionConfig": {
"description": "Client connection configuration",
"id": "ClientConnectionConfig",
"properties": {
"requireConnectors": {
"description": "Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.",
"type": "boolean"
},
"sslConfig": {
"$ref": "SslConfig",
"description": "Optional. SSL config option for this instance."
}
},
"type": "object"
},
"CloudControl2SharedOperationsReconciliationOperationMetadata": {
"description": "Operation metadata returned by the CLH during resource state reconciliation.",
"id": "CloudControl2SharedOperationsReconciliationOperationMetadata",
"properties": {
"deleteResource": {
"deprecated": true,
"description": "DEPRECATED. Use exclusive_action instead.",
"type": "boolean"
},
"exclusiveAction": {
"description": "Excluisive action returned by the CLH.",
"enum": [
"UNKNOWN_REPAIR_ACTION",
"DELETE",
"RETRY"
],
"enumDeprecated": [
false,
true,
false
],
"enumDescriptions": [
"Unknown repair action.",
"The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.",
"This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource."
],
"type": "string"
}
},
"type": "object"
},
"CloudSQLBackupRunSource": {
"description": "The source CloudSQL backup resource.",
"id": "CloudSQLBackupRunSource",
"properties": {
"backupRunId": {
"description": "Required. The CloudSQL backup run ID.",
"format": "int64",
"type": "string"
},
"instanceId": {
"description": "Required. The CloudSQL instance ID.",
"type": "string"
},
"project": {
"description": "The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.",
"type": "string"
}
},
"type": "object"
},
"Cluster": {
"description": "A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.",
"id": "Cluster",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128",
"type": "object"
},
"automatedBackupPolicy": {
"$ref": "AutomatedBackupPolicy",
"description": "The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type."
},
"backupSource": {
"$ref": "BackupSource",
"description": "Output only. Cluster created from backup.",
"readOnly": true
},
"cloudsqlBackupRunSource": {
"$ref": "CloudSQLBackupRunSource",
"description": "Output only. Cluster created from CloudSQL snapshot.",
"readOnly": true
},
"clusterType": {
"description": "Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`",
"enum": [
"CLUSTER_TYPE_UNSPECIFIED",
"PRIMARY",
"SECONDARY"
],
"enumDescriptions": [
"The type of the cluster is unknown.",
"Primary cluster that support read and write operations.",
"Secondary cluster that is replicating from another region. This only supports read."
],
"readOnly": true,
"type": "string"
},
"continuousBackupConfig": {
"$ref": "ContinuousBackupConfig",
"description": "Optional. Continuous backup configuration for this cluster."
},
"continuousBackupInfo": {
"$ref": "ContinuousBackupInfo",
"description": "Output only. Continuous backup properties for this cluster.",
"readOnly": true
},
"createTime": {
"description": "Output only. Create time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"databaseVersion": {
"description": "Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.",
"enum": [
"DATABASE_VERSION_UNSPECIFIED",
"POSTGRES_13",
"POSTGRES_14",
"POSTGRES_15",
"POSTGRES_16"
],
"enumDeprecated": [
false,
true,
false,
false,
false
],
"enumDescriptions": [
"This is an unknown database version.",
"DEPRECATED - The database version is Postgres 13.",
"The database version is Postgres 14.",
"The database version is Postgres 15.",
"The database version is Postgres 16."
],
"type": "string"
},
"deleteTime": {
"description": "Output only. Delete time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "User-settable and human-readable display name for the Cluster.",
"type": "string"
},
"encryptionConfig": {
"$ref": "EncryptionConfig",
"description": "Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data."
},
"encryptionInfo": {
"$ref": "EncryptionInfo",
"description": "Output only. The encryption information for the cluster.",
"readOnly": true
},
"etag": {
"description": "For Resource freshness validation (https://google.aip.dev/154)",
"type": "string"
},
"geminiConfig": {
"$ref": "GeminiClusterConfig",
"description": "Optional. Configuration parameters related to the Gemini in Databases add-on."
},
"initialUser": {
"$ref": "UserPassword",
"description": "Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels as key value pairs",
"type": "object"
},
"maintenanceSchedule": {
"$ref": "MaintenanceSchedule",
"description": "Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.",
"readOnly": true
},
"maintenanceUpdatePolicy": {
"$ref": "MaintenanceUpdatePolicy",
"description": "Optional. The maintenance update policy determines when to allow or deny updates."
},
"migrationSource": {
"$ref": "MigrationSource",
"description": "Output only. Cluster created via DMS migration.",
"readOnly": true
},
"name": {
"description": "Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}",
"readOnly": true,
"type": "string"
},
"network": {
"deprecated": true,
"description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.",
"type": "string"
},
"networkConfig": {
"$ref": "NetworkConfig"
},
"primaryConfig": {
"$ref": "PrimaryConfig",
"description": "Output only. Cross Region replication config specific to PRIMARY cluster.",
"readOnly": true
},
"pscConfig": {
"$ref": "PscConfig",
"description": "Optional. The configuration for Private Service Connect (PSC) for the cluster."
},
"reconciling": {
"description": "Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"secondaryConfig": {
"$ref": "SecondaryConfig",
"description": "Cross Region replication config specific to SECONDARY cluster."
},
"sslConfig": {
"$ref": "SslConfig",
"deprecated": true,
"description": "SSL configuration for this AlloyDB cluster."
},
"state": {
"description": "Output only. The current serving state of the cluster.",
"enum": [
"STATE_UNSPECIFIED",
"READY",
"STOPPED",
"EMPTY",
"CREATING",
"DELETING",
"FAILED",
"BOOTSTRAPPING",
"MAINTENANCE",
"PROMOTING"
],
"enumDescriptions": [
"The state of the cluster is unknown.",
"The cluster is active and running.",
"The cluster is stopped. All instances in the cluster are stopped. Customers can start a stopped cluster at any point and all their instances will come back to life with same names and IP resources. In this state, customer pays for storage. Associated backups could also be present in a stopped cluster.",
"The cluster is empty and has no associated resources. All instances, associated storage and backups have been deleted.",
"The cluster is being created.",
"The cluster is being deleted.",
"The creation of the cluster failed.",
"The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.",
"The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.",
"The cluster is being promoted."
],
"readOnly": true,
"type": "string"
},
"subscriptionType": {
"description": "Optional. Subscription type of the cluster.",
"enum": [
"SUBSCRIPTION_TYPE_UNSPECIFIED",
"STANDARD",
"TRIAL"
],
"enumDescriptions": [
"This is an unknown Subscription type (By default, Subscription Type is STANDARD)",
"Standard subscription.",
"Trial subscription."
],
"type": "string"
},
"trialMetadata": {
"$ref": "TrialMetadata",
"description": "Output only. Metadata for free trial clusters",
"readOnly": true
},
"uid": {
"description": "Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. Update time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ClusterUpgradeDetails": {
"description": "Upgrade details of a cluster. This cluster can be primary or secondary.",
"id": "ClusterUpgradeDetails",
"properties": {
"clusterType": {
"description": "Cluster type which can either be primary or secondary.",
"enum": [
"CLUSTER_TYPE_UNSPECIFIED",
"PRIMARY",
"SECONDARY"
],
"enumDescriptions": [
"The type of the cluster is unknown.",
"Primary cluster that support read and write operations.",
"Secondary cluster that is replicating from another region. This only supports read."
],
"type": "string"
},
"databaseVersion": {
"description": "Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation.",
"enum": [
"DATABASE_VERSION_UNSPECIFIED",
"POSTGRES_13",
"POSTGRES_14",
"POSTGRES_15",
"POSTGRES_16"
],
"enumDeprecated": [
false,
true,
false,
false,
false
],
"enumDescriptions": [
"This is an unknown database version.",
"DEPRECATED - The database version is Postgres 13.",
"The database version is Postgres 14.",
"The database version is Postgres 15.",
"The database version is Postgres 16."
],
"type": "string"
},
"instanceUpgradeDetails": {
"description": "Upgrade details of the instances directly associated with this cluster.",
"items": {
"$ref": "InstanceUpgradeDetails"
},
"type": "array"
},
"name": {
"description": "Normalized name of the cluster",
"type": "string"
},
"stageInfo": {
"description": "Array containing stage info associated with this cluster.",
"items": {
"$ref": "StageInfo"
},
"type": "array"
},
"upgradeStatus": {
"description": "Upgrade status of the cluster.",
"enum": [
"STATUS_UNSPECIFIED",
"SUCCESS",
"FAILED",
"PARTIAL_SUCCESS"
],
"enumDescriptions": [
"Unspecified status.",
"Operation succeeded.",
"Operation failed.",
"Operation partially succeeded."
],
"type": "string"
}
},
"type": "object"
},
"ConnectionInfo": {
"description": "ConnectionInfo singleton resource. https://google.aip.dev/156",
"id": "ConnectionInfo",
"properties": {
"instanceUid": {
"description": "Output only. The unique ID of the Instance.",
"readOnly": true,
"type": "string"
},
"ipAddress": {
"description": "Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo This field currently has no semantic meaning.",
"type": "string"
},
"pemCertificateChain": {
"deprecated": true,
"description": "Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"pscDnsName": {
"description": "Output only. The DNS name to use with PSC for the Instance.",
"readOnly": true,
"type": "string"
},
"publicIpAddress": {
"description": "Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ContinuousBackupConfig": {
"description": "ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.",
"id": "ContinuousBackupConfig",
"properties": {
"enabled": {
"description": "Whether ContinuousBackup is enabled.",
"type": "boolean"
},
"encryptionConfig": {
"$ref": "EncryptionConfig",
"description": "The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data."
},
"recoveryWindowDays": {
"description": "The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ContinuousBackupInfo": {
"description": "ContinuousBackupInfo describes the continuous backup properties of a cluster.",
"id": "ContinuousBackupInfo",
"properties": {
"earliestRestorableTime": {
"description": "Output only. The earliest restorable time that can be restored to. Output only field.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"enabledTime": {
"description": "Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"encryptionInfo": {
"$ref": "EncryptionInfo",
"description": "Output only. The encryption information for the WALs and backups required for ContinuousBackup.",
"readOnly": true
},
"schedule": {
"description": "Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.",
"items": {
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"ContinuousBackupSource": {
"description": "Message describing a ContinuousBackupSource.",
"id": "ContinuousBackupSource",
"properties": {
"cluster": {
"description": "Required. The source cluster from which to restore. This cluster must have continuous backup enabled for this operation to succeed. For the required format, see the comment on the Cluster.name field.",
"type": "string"
},
"pointInTime": {
"description": "Required. The point in time to restore to.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"EncryptionConfig": {
"description": "EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).",
"id": "EncryptionConfig",
"properties": {
"kmsKeyName": {
"description": "The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]",
"type": "string"
}
},
"type": "object"
},
"EncryptionInfo": {
"description": "EncryptionInfo describes the encryption information of a cluster or a backup.",
"id": "EncryptionInfo",
"properties": {
"encryptionType": {
"description": "Output only. Type of encryption.",
"enum": [
"TYPE_UNSPECIFIED",
"GOOGLE_DEFAULT_ENCRYPTION",
"CUSTOMER_MANAGED_ENCRYPTION"
],
"enumDescriptions": [
"Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.",
"The data is encrypted at rest with a key that is fully managed by Google. No key version will be populated. This is the default state.",
"The data is encrypted at rest with a key that is managed by the customer. KMS key versions will be populated."
],
"readOnly": true,
"type": "string"
},
"kmsKeyVersions": {
"description": "Output only. Cloud KMS key versions that are being used to protect the database or the backup.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"FailoverInstanceRequest": {
"description": "Message for triggering failover on an Instance",
"id": "FailoverInstanceRequest",
"properties": {
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.",
"type": "boolean"
}
},
"type": "object"
},
"GeminiClusterConfig": {
"description": "Cluster level configuration parameters related to the Gemini in Databases add-on.",
"id": "GeminiClusterConfig",
"properties": {
"entitled": {
"description": "Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"GeminiInstanceConfig": {
"description": "Instance level configuration parameters related to the Gemini in Databases add-on.",
"id": "GeminiInstanceConfig",
"properties": {
"entitled": {
"description": "Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudLocationListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "GoogleCloudLocationListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleCloudLocationLocation"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudLocationLocation": {
"description": "A resource that represents a Google Cloud location.",
"id": "GoogleCloudLocationLocation",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeTimeOfDay": {
"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.",
"id": "GoogleTypeTimeOfDay",
"properties": {
"hours": {
"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "Minutes of hour of day. Must be from 0 to 59.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InjectFaultRequest": {
"description": "Message for triggering fault injection on an instance",
"id": "InjectFaultRequest",
"properties": {
"faultType": {
"description": "Required. The type of fault to be injected in an instance.",
"enum": [
"FAULT_TYPE_UNSPECIFIED",
"STOP_VM"
],
"enumDescriptions": [
"The fault type is unknown.",
"Stop the VM"
],
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection.",
"type": "boolean"
}
},
"type": "object"
},
"Instance": {
"description": "An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.",
"id": "Instance",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128",
"type": "object"
},
"availabilityType": {
"description": "Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).",
"enum": [
"AVAILABILITY_TYPE_UNSPECIFIED",
"ZONAL",
"REGIONAL"
],
"enumDescriptions": [
"This is an unknown Availability type.",
"Zonal available instance.",
"Regional (or Highly) available instance."
],
"type": "string"
},
"clientConnectionConfig": {
"$ref": "ClientConnectionConfig",
"description": "Optional. Client connection specific configurations"
},
"createTime": {
"description": "Output only. Create time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"databaseFlags": {
"additionalProperties": {
"type": "string"
},
"description": "Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of \"key\": \"value\" pairs. \"key\": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. \"value\": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.",
"type": "object"
},
"deleteTime": {
"description": "Output only. Delete time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "User-settable and human-readable display name for the Instance.",
"type": "string"
},
"etag": {
"description": "For Resource freshness validation (https://google.aip.dev/154)",
"type": "string"
},
"gceZone": {
"description": "The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.",
"type": "string"
},
"geminiConfig": {
"$ref": "GeminiInstanceConfig",
"description": "Optional. Configuration parameters related to the Gemini in Databases add-on."
},
"instanceType": {
"description": "Required. The type of the instance. Specified at creation time.",
"enum": [
"INSTANCE_TYPE_UNSPECIFIED",
"PRIMARY",
"READ_POOL",
"SECONDARY"
],
"enumDescriptions": [
"The type of the instance is unknown.",
"PRIMARY instances support read and write operations.",
"READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).",
"SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica"
],
"type": "string"
},
"ipAddress": {
"description": "Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels as key value pairs",
"type": "object"
},
"machineConfig": {
"$ref": "MachineConfig",
"description": "Configurations for the machines that host the underlying database engine."
},
"name": {
"description": "Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}",
"readOnly": true,
"type": "string"
},
"networkConfig": {
"$ref": "InstanceNetworkConfig",
"description": "Optional. Instance level network configuration."
},
"nodes": {
"description": "Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.",
"items": {
"$ref": "Node"
},
"readOnly": true,
"type": "array"
},
"observabilityConfig": {
"$ref": "ObservabilityInstanceConfig",
"description": "Configuration for observability."
},
"outboundPublicIpAddresses": {
"description": "Output only. All outbound public IP addresses configured for the instance.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"pscInstanceConfig": {
"$ref": "PscInstanceConfig",
"description": "Optional. The configuration for Private Service Connect (PSC) for the instance."
},
"publicIpAddress": {
"description": "Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.",
"readOnly": true,
"type": "string"
},
"queryInsightsConfig": {
"$ref": "QueryInsightsInstanceConfig",
"description": "Configuration for query insights."
},
"readPoolConfig": {
"$ref": "ReadPoolConfig",
"description": "Read pool instance configuration. This is required if the value of instanceType is READ_POOL."
},
"reconciling": {
"description": "Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"state": {
"description": "Output only. The current serving state of the instance.",
"enum": [
"STATE_UNSPECIFIED",
"READY",
"STOPPED",
"CREATING",
"DELETING",
"MAINTENANCE",
"FAILED",
"BOOTSTRAPPING",
"PROMOTING"
],
"enumDescriptions": [
"The state of the instance is unknown.",
"The instance is active and running.",
"The instance is stopped. Instance name and IP resources are preserved.",
"The instance is being created.",
"The instance is being deleted.",
"The instance is down for maintenance.",
"The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.",
"Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that index unused in case that state also needs to exposed via consumer apis in future. The instance has been configured to sync data from some other source.",
"The instance is being promoted."
],
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.",
"readOnly": true,
"type": "string"
},
"updatePolicy": {
"$ref": "UpdatePolicy",
"description": "Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request."
},
"updateTime": {
"description": "Output only. Update time stamp",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"writableNode": {
"$ref": "Node",
"description": "Output only. This is set for the read-write VM of the PRIMARY instance only.",
"readOnly": true
}
},
"type": "object"
},
"InstanceNetworkConfig": {
"description": "Metadata related to instance level network configuration.",
"id": "InstanceNetworkConfig",
"properties": {
"authorizedExternalNetworks": {
"description": "Optional. A list of external network authorized to access this instance.",
"items": {
"$ref": "AuthorizedNetwork"
},
"type": "array"
},
"enableOutboundPublicIp": {
"description": "Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.",
"type": "boolean"
},
"enablePublicIp": {
"description": "Optional. Enabling public ip for the instance.",
"type": "boolean"
}
},
"type": "object"
},
"InstanceUpgradeDetails": {
"description": "Details regarding the upgrade of instaces associated with a cluster.",
"id": "InstanceUpgradeDetails",
"properties": {
"instanceType": {
"description": "Instance type.",
"enum": [
"INSTANCE_TYPE_UNSPECIFIED",
"PRIMARY",
"READ_POOL",
"SECONDARY"
],
"enumDescriptions": [
"The type of the instance is unknown.",
"PRIMARY instances support read and write operations.",
"READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).",
"SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica"
],
"type": "string"
},
"name": {
"description": "Normalized name of the instance.",
"type": "string"
},
"upgradeStatus": {
"description": "Upgrade status of the instance.",
"enum": [
"STATUS_UNSPECIFIED",
"SUCCESS",
"FAILED",
"PARTIAL_SUCCESS"
],
"enumDescriptions": [
"Unspecified status.",
"Operation succeeded.",
"Operation failed.",
"Operation partially succeeded."
],
"type": "string"
}
},
"type": "object"
},
"IntegerRestrictions": {
"description": "Restrictions on INTEGER type values.",
"id": "IntegerRestrictions",
"properties": {
"maxValue": {
"description": "The maximum value that can be specified, if applicable.",
"format": "int64",
"type": "string"
},
"minValue": {
"description": "The minimum value that can be specified, if applicable.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ListBackupsResponse": {
"description": "Message for response to listing Backups",
"id": "ListBackupsResponse",
"properties": {
"backups": {
"description": "The list of Backup",
"items": {
"$ref": "Backup"
},
"type": "array"
},
"nextPageToken": {
"description": "A token identifying a page of results the server should return.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListClustersResponse": {
"description": "Message for response to listing Clusters",
"id": "ListClustersResponse",
"properties": {
"clusters": {
"description": "The list of Cluster",
"items": {
"$ref": "Cluster"
},
"type": "array"
},
"nextPageToken": {
"description": "A token identifying a page of results the server should return.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListInstancesResponse": {
"description": "Message for response to listing Instances",
"id": "ListInstancesResponse",
"properties": {
"instances": {
"description": "The list of Instance",
"items": {
"$ref": "Instance"
},
"type": "array"
},
"nextPageToken": {
"description": "A token identifying a page of results the server should return.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"ListSupportedDatabaseFlagsResponse": {
"description": "Message for response to listing SupportedDatabaseFlags.",
"id": "ListSupportedDatabaseFlagsResponse",
"properties": {
"nextPageToken": {
"description": "A token identifying a page of results the server should return.",
"type": "string"
},
"supportedDatabaseFlags": {
"description": "The list of SupportedDatabaseFlags.",
"items": {
"$ref": "SupportedDatabaseFlag"
},
"type": "array"
}
},
"type": "object"
},
"ListUsersResponse": {
"description": "Message for response to listing Users",
"id": "ListUsersResponse",
"properties": {
"nextPageToken": {
"description": "A token identifying a page of results the server should return.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
},
"users": {
"description": "The list of User",
"items": {
"$ref": "User"
},
"type": "array"
}
},
"type": "object"
},
"MachineConfig": {
"description": "MachineConfig describes the configuration of a machine.",
"id": "MachineConfig",
"properties": {
"cpuCount": {
"description": "The number of CPU's in the VM instance.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"MaintenanceSchedule": {
"description": "MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead.",
"id": "MaintenanceSchedule",
"properties": {
"startTime": {
"description": "Output only. The scheduled start time for the maintenance.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"MaintenanceUpdatePolicy": {
"description": "MaintenanceUpdatePolicy defines the policy for system updates.",
"id": "MaintenanceUpdatePolicy",
"properties": {
"maintenanceWindows": {
"description": "Preferred windows to perform maintenance. Currently limited to 1.",
"items": {
"$ref": "MaintenanceWindow"
},
"type": "array"
}
},
"type": "object"
},
"MaintenanceWindow": {
"description": "MaintenanceWindow specifies a preferred day and time for maintenance.",
"id": "MaintenanceWindow",
"properties": {
"day": {
"description": "Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string"
},
"startTime": {
"$ref": "GoogleTypeTimeOfDay",
"description": "Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time."
}
},
"type": "object"
},
"MigrationSource": {
"description": "Subset of the source instance configuration that is available when reading the cluster resource.",
"id": "MigrationSource",
"properties": {
"hostPort": {
"description": "Output only. The host and port of the on-premises instance in host:port format",
"readOnly": true,
"type": "string"
},
"referenceId": {
"description": "Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.",
"readOnly": true,
"type": "string"
},
"sourceType": {
"description": "Output only. Type of migration source.",
"enum": [
"MIGRATION_SOURCE_TYPE_UNSPECIFIED",
"DMS"
],
"enumDescriptions": [
"Migration source is unknown.",
"DMS source means the cluster was created via DMS migration job."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"NetworkConfig": {
"description": "Metadata related to network configuration.",
"id": "NetworkConfig",
"properties": {
"allocatedIpRange": {
"description": "Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: \"google-managed-services-default\". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.",
"type": "string"
},
"network": {
"description": "Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.",
"type": "string"
}
},
"type": "object"
},
"Node": {
"description": "Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.",
"id": "Node",
"properties": {
"id": {
"description": "The identifier of the VM e.g. \"test-read-0601-407e52be-ms3l\".",
"type": "string"
},
"ip": {
"description": "The private IP address of the VM e.g. \"10.57.0.34\".",
"type": "string"
},
"state": {
"description": "Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.",
"type": "string"
},
"zoneId": {
"description": "The Compute Engine zone of the VM e.g. \"us-central1-b\".",
"type": "string"
}
},
"type": "object"
},
"ObservabilityInstanceConfig": {
"description": "Observability Instance specific configuration.",
"id": "ObservabilityInstanceConfig",
"properties": {
"enabled": {
"description": "Observability feature status for an instance. This flag is turned \"off\" by default.",
"type": "boolean"
},
"maxQueryStringLength": {
"description": "Query string length. The default value is 10k.",
"format": "int32",
"type": "integer"
},
"preserveComments": {
"description": "Preserve comments in query string for an instance. This flag is turned \"off\" by default.",
"type": "boolean"
},
"queryPlansPerMinute": {
"description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.",
"format": "int32",
"type": "integer"
},
"recordApplicationTags": {
"description": "Record application tags for an instance. This flag is turned \"off\" by default.",
"type": "boolean"
},
"trackActiveQueries": {
"description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.",
"type": "boolean"
},
"trackClientAddress": {
"description": "Track client address for an instance. If not set, default value is \"off\".",
"type": "boolean"
},
"trackWaitEventTypes": {
"description": "Output only. Track wait event types during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.",
"readOnly": true,
"type": "boolean"
},
"trackWaitEvents": {
"description": "Track wait events during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on.",
"type": "boolean"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PrimaryConfig": {
"description": "Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.",
"id": "PrimaryConfig",
"properties": {
"secondaryClusterNames": {
"description": "Output only. Names of the clusters that are replicating from this cluster.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"PromoteClusterRequest": {
"description": "Message for promoting a Cluster",
"id": "PromoteClusterRequest",
"properties": {
"etag": {
"description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.",
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.",
"type": "boolean"
}
},
"type": "object"
},
"PscConfig": {
"description": "PscConfig contains PSC related configuration at a cluster level.",
"id": "PscConfig",
"properties": {
"pscEnabled": {
"description": "Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.",
"type": "boolean"
}
},
"type": "object"
},
"PscInstanceConfig": {
"description": "PscInstanceConfig contains PSC related configuration at an instance level.",
"id": "PscInstanceConfig",
"properties": {
"allowedConsumerProjects": {
"description": "Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.",
"items": {
"type": "string"
},
"type": "array"
},
"pscDnsName": {
"description": "Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog",
"readOnly": true,
"type": "string"
},
"serviceAttachmentLink": {
"description": "Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"QuantityBasedExpiry": {
"description": "A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)",
"id": "QuantityBasedExpiry",
"properties": {
"retentionCount": {
"description": "Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"totalRetentionCount": {
"description": "Output only. The length of the quantity-based queue, specified by the backup's retention policy.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"QuantityBasedRetention": {
"description": "A quantity based policy specifies that a certain number of the most recent successful backups should be retained.",
"id": "QuantityBasedRetention",
"properties": {
"count": {
"description": "The number of backups to retain.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"QueryInsightsInstanceConfig": {
"description": "QueryInsights Instance specific configuration.",
"id": "QueryInsightsInstanceConfig",
"properties": {
"queryPlansPerMinute": {
"description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.",
"format": "uint32",
"type": "integer"
},
"queryStringLength": {
"description": "Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.",
"format": "uint32",
"type": "integer"
},
"recordApplicationTags": {
"description": "Record application tags for an instance. This flag is turned \"on\" by default.",
"type": "boolean"
},
"recordClientAddress": {
"description": "Record client address for an instance. Client address is PII information. This flag is turned \"on\" by default.",
"type": "boolean"
}
},
"type": "object"
},
"ReadPoolConfig": {
"description": "Configuration for a read pool instance.",
"id": "ReadPoolConfig",
"properties": {
"nodeCount": {
"description": "Read capacity, i.e. number of nodes in a read pool instance.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RestartInstanceRequest": {
"id": "RestartInstanceRequest",
"properties": {
"nodeIds": {
"description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.",
"items": {
"type": "string"
},
"type": "array"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.",
"type": "boolean"
}
},
"type": "object"
},
"RestoreClusterRequest": {
"description": "Message for restoring a Cluster from a backup or another cluster at a given point in time.",
"id": "RestoreClusterRequest",
"properties": {
"backupSource": {
"$ref": "BackupSource",
"description": "Backup source."
},
"cluster": {
"$ref": "Cluster",
"description": "Required. The resource being created"
},
"clusterId": {
"description": "Required. ID of the requesting object.",
"type": "string"
},
"continuousBackupSource": {
"$ref": "ContinuousBackupSource",
"description": "ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed."
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request.",
"type": "boolean"
}
},
"type": "object"
},
"SecondaryConfig": {
"description": "Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.",
"id": "SecondaryConfig",
"properties": {
"primaryClusterName": {
"description": "The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}",
"type": "string"
}
},
"type": "object"
},
"SslConfig": {
"description": "SSL configuration.",
"id": "SslConfig",
"properties": {
"caSource": {
"description": "Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.",
"enum": [
"CA_SOURCE_UNSPECIFIED",
"CA_SOURCE_MANAGED"
],
"enumDescriptions": [
"Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.",
"Certificate Authority (CA) managed by the AlloyDB Cluster."
],
"type": "string"
},
"sslMode": {
"description": "Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.",
"enum": [
"SSL_MODE_UNSPECIFIED",
"SSL_MODE_ALLOW",
"SSL_MODE_REQUIRE",
"SSL_MODE_VERIFY_CA",
"ALLOW_UNENCRYPTED_AND_ENCRYPTED",
"ENCRYPTED_ONLY"
],
"enumDeprecated": [
false,
true,
true,
true,
false,
false
],
"enumDescriptions": [
"SSL mode not specified. Defaults to ENCRYPTED_ONLY.",
"SSL connections are optional. CA verification not enforced.",
"SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).",
"SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.",
"SSL connections are optional. CA verification not enforced.",
"SSL connections are required. CA verification not enforced."
],
"type": "string"
}
},
"type": "object"
},
"StageInfo": {
"description": "Stage information for different stages in the upgrade process.",
"id": "StageInfo",
"properties": {
"logsUrl": {
"description": "logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.",
"type": "string"
},
"stage": {
"description": "The stage.",
"enum": [
"STAGE_UNSPECIFIED",
"ALLOYDB_PRECHECK",
"PG_UPGRADE_CHECK",
"PRIMARY_INSTANCE_UPGRADE",
"READ_POOL_UPGRADE"
],
"enumDescriptions": [
"Unspecified stage.",
"This stage is for the custom checks done before upgrade.",
"This stage is for `pg_upgrade --check` run before upgrade.",
"This stage is primary upgrade.",
"This stage is read pool upgrade."
],
"type": "string"
},
"status": {
"description": "Status of the stage.",
"enum": [
"STATUS_UNSPECIFIED",
"SUCCESS",
"FAILED",
"PARTIAL_SUCCESS"
],
"enumDescriptions": [
"Unspecified status.",
"Operation succeeded.",
"Operation failed.",
"Operation partially succeeded."
],
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration": {
"description": "Configuration for availability of database instance",
"id": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration",
"properties": {
"availabilityType": {
"description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).",
"enum": [
"AVAILABILITY_TYPE_UNSPECIFIED",
"ZONAL",
"REGIONAL",
"MULTI_REGIONAL",
"AVAILABILITY_TYPE_OTHER"
],
"enumDescriptions": [
"",
"Zonal available instance.",
"Regional available instance.",
"Multi regional instance",
"For rest of the other category"
],
"type": "string"
},
"crossRegionReplicaConfigured": {
"description": "Checks for resources that are configured to have redundancy, and ongoing replication across regions",
"type": "boolean"
},
"externalReplicaConfigured": {
"type": "boolean"
},
"promotableReplicaConfigured": {
"type": "boolean"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainBackupConfiguration": {
"description": "Configuration for automatic backups",
"id": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration",
"properties": {
"automatedBackupEnabled": {
"description": "Whether customer visible automated backups are enabled on the instance.",
"type": "boolean"
},
"backupRetentionSettings": {
"$ref": "StorageDatabasecenterPartnerapiV1mainRetentionSettings",
"description": "Backup retention settings."
},
"pointInTimeRecoveryEnabled": {
"description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.",
"type": "boolean"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainBackupRun": {
"description": "A backup run.",
"id": "StorageDatabasecenterPartnerapiV1mainBackupRun",
"properties": {
"endTime": {
"description": "The time the backup operation completed. REQUIRED",
"format": "google-datetime",
"type": "string"
},
"error": {
"$ref": "StorageDatabasecenterPartnerapiV1mainOperationError",
"description": "Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL"
},
"startTime": {
"description": "The time the backup operation started. REQUIRED",
"format": "google-datetime",
"type": "string"
},
"status": {
"description": "The status of this run. REQUIRED",
"enum": [
"STATUS_UNSPECIFIED",
"SUCCESSFUL",
"FAILED"
],
"enumDescriptions": [
"",
"The backup was successful.",
"The backup was unsuccessful."
],
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainCompliance": {
"description": "Contains compliance information about a security standard indicating unmet recommendations.",
"id": "StorageDatabasecenterPartnerapiV1mainCompliance",
"properties": {
"standard": {
"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.",
"type": "string"
},
"version": {
"description": "Version of the standard or benchmark, for example, 1.1",
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainCustomMetadataData": {
"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data",
"id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData",
"properties": {
"internalResourceMetadata": {
"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.",
"items": {
"$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata"
},
"type": "array"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": {
"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.",
"id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed",
"properties": {
"feedTimestamp": {
"description": "Required. Timestamp when feed is generated.",
"format": "google-datetime",
"type": "string"
},
"feedType": {
"description": "Required. Type feed to be ingested into condor",
"enum": [
"FEEDTYPE_UNSPECIFIED",
"RESOURCE_METADATA",
"OBSERVABILITY_DATA",
"SECURITY_FINDING_DATA",
"RECOMMENDATION_SIGNAL_DATA"
],
"enumDescriptions": [
"",
"Database resource metadata feed from control plane",
"Database resource monitoring data",
"Database resource security health signal data",
"Database resource recommendation signal data"
],
"type": "string"
},
"observabilityMetricData": {
"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData"
},
"recommendationSignalData": {
"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData"
},
"resourceHealthSignalData": {
"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData"
},
"resourceId": {
"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId",
"deprecated": true,
"description": "Primary key associated with the Resource. resource_id is available in individual feed level as well."
},
"resourceMetadata": {
"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData": {
"description": "Common model for database resource health signal data.",
"id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData",
"properties": {
"additionalMetadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Any other additional metadata",
"type": "object"
},
"compliance": {
"description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.",
"items": {
"$ref": "StorageDatabasecenterPartnerapiV1mainCompliance"
},
"type": "array"
},
"description": {
"description": "Description associated with signal",
"type": "string"
},
"eventTime": {
"description": "Required. The last time at which the event described by this signal took place",
"format": "google-datetime",
"type": "string"
},
"externalUri": {
"description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.",
"type": "string"
},
"name": {
"description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.",
"type": "string"
},
"provider": {
"description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged",
"enum": [
"PROVIDER_UNSPECIFIED",
"GCP",
"AWS",
"AZURE",
"ONPREM",
"SELFMANAGED",
"PROVIDER_OTHER"
],
"enumDescriptions": [
"",
"Google cloud platform provider",
"Amazon web service",
"Azure web service",
"On-prem database resources.",
"Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.",
"For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values."
],
"type": "string"
},
"resourceContainer": {
"description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"projects/123\". For GCP provided resources, number should be project number.",
"type": "string"
},
"resourceName": {
"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel",
"type": "string"
},
"signalClass": {
"description": "Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.",
"enum": [
"CLASS_UNSPECIFIED",
"THREAT",
"VULNERABILITY",
"MISCONFIGURATION",
"OBSERVATION",
"ERROR"
],
"enumDescriptions": [
"Unspecified signal class.",
"Describes unwanted or malicious activity.",
"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.",
"Describes a potential weakness in cloud resource/asset configuration that increases risk.",
"Describes a security observation that is for informational purposes.",
"Describes an error that prevents some SCC functionality."
],
"type": "string"
},
"signalId": {
"description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.",
"type": "string"
},
"signalSeverity": {
"description": "The severity of the signal, such as if it's a HIGH or LOW severity.",
"enum": [
"SIGNAL_SEVERITY_UNSPECIFIED",
"CRITICAL",
"HIGH",
"MEDIUM",
"LOW"
],
"enumDescriptions": [
"This value is used for findings when a source doesn't write a severity value.",
"A critical vulnerability is easily discoverable by an external actor, exploitable.",
"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.",
"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.",
"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment."
],
"type": "string"
},
"signalType": {
"description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.",
"enum": [
"SIGNAL_TYPE_UNSPECIFIED",
"SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER",
"SIGNAL_TYPE_GROUP_NOT_REPLICATING_ACROSS_REGIONS",
"SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_ZONES",
"SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_REGIONS",
"SIGNAL_TYPE_NO_PROMOTABLE_REPLICA",
"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY",
"SIGNAL_TYPE_SHORT_BACKUP_RETENTION",
"SIGNAL_TYPE_LAST_BACKUP_FAILED",
"SIGNAL_TYPE_LAST_BACKUP_OLD",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_2_0",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_3",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0",
"SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0",
"SIGNAL_TYPE_VIOLATES_NIST_800_53",
"SIGNAL_TYPE_VIOLATES_NIST_800_53_R5",
"SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0",
"SIGNAL_TYPE_VIOLATES_ISO_27001",
"SIGNAL_TYPE_VIOLATES_ISO_27001_V2022",
"SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1",
"SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0",
"SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4",
"SIGNAL_TYPE_VIOLATES_HIPAA",
"SIGNAL_TYPE_VIOLATES_SOC2_V2017",
"SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING",
"SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED",
"SIGNAL_TYPE_VERBOSE_ERROR_LOGGING",
"SIGNAL_TYPE_QUERY_LOCK_WAITS_NOT_LOGGED",
"SIGNAL_TYPE_LOGGING_MOST_ERRORS",
"SIGNAL_TYPE_LOGGING_ONLY_CRITICAL_ERRORS",
"SIGNAL_TYPE_MINIMAL_ERROR_LOGGING",
"SIGNAL_TYPE_QUERY_STATISTICS_LOGGED",
"SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_CLIENT_HOSTNAME",
"SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PARSER_STATISTICS",
"SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PLANNER_STATISTICS",
"SIGNAL_TYPE_NOT_LOGGING_ONLY_DDL_STATEMENTS",
"SIGNAL_TYPE_LOGGING_QUERY_STATISTICS",
"SIGNAL_TYPE_NOT_LOGGING_TEMPORARY_FILES",
"SIGNAL_TYPE_CONNECTION_MAX_NOT_CONFIGURED",
"SIGNAL_TYPE_USER_OPTIONS_CONFIGURED",
"SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS",
"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS",
"SIGNAL_TYPE_NO_ROOT_PASSWORD",
"SIGNAL_TYPE_WEAK_ROOT_PASSWORD",
"SIGNAL_TYPE_ENCRYPTION_KEY_NOT_CUSTOMER_MANAGED",
"SIGNAL_TYPE_SERVER_AUTHENTICATION_NOT_REQUIRED",
"SIGNAL_TYPE_EXPOSED_BY_OWNERSHIP_CHAINING",
"SIGNAL_TYPE_EXPOSED_TO_EXTERNAL_SCRIPTS",
"SIGNAL_TYPE_EXPOSED_TO_LOCAL_DATA_LOADS",
"SIGNAL_TYPE_CONNECTION_ATTEMPTS_NOT_LOGGED",
"SIGNAL_TYPE_DISCONNECTIONS_NOT_LOGGED",
"SIGNAL_TYPE_LOGGING_EXCESSIVE_STATEMENT_INFO",
"SIGNAL_TYPE_EXPOSED_TO_REMOTE_ACCESS",
"SIGNAL_TYPE_DATABASE_NAMES_EXPOSED",
"SIGNAL_TYPE_SENSITIVE_TRACE_INFO_NOT_MASKED",
"SIGNAL_TYPE_PUBLIC_IP_ENABLED",
"SIGNAL_TYPE_IDLE",
"SIGNAL_TYPE_OVERPROVISIONED",
"SIGNAL_TYPE_HIGH_NUMBER_OF_OPEN_TABLES",
"SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES",
"SIGNAL_TYPE_HIGH_TRANSACTION_ID_UTILIZATION",
"SIGNAL_TYPE_UNDERPROVISIONED",
"SIGNAL_TYPE_OUT_OF_DISK",
"SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY",
"SIGNAL_TYPE_DATABASE_AUDITING_DISABLED",
"SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS",
"SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP",
"SIGNAL_TYPE_QUOTA_LIMIT",
"SIGNAL_TYPE_NO_PASSWORD_POLICY",
"SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT",
"SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT",
"SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT",
"SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES",
"SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES",
"SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS",
"SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET",
"SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET"
],
"enumDeprecated": [
false,
false,
false,
true,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Unspecified.",
"Represents if a resource is protected by automatic failover. Checks for resources that are configured to have redundancy within a region that enables automatic failover.",
"Represents if a group is replicating across regions. Checks for resources that are configured to have redundancy, and ongoing replication, across regions.",
"Represents if the resource is available in multiple zones or not.",
"Represents if a resource is available in multiple regions.",
"Represents if a resource has a promotable replica.",
"Represents if a resource has an automated backup policy.",
"Represents if a resources has a short backup retention period.",
"Represents if the last backup of a resource failed.",
"Represents if the last backup of a resource is older than some threshold value.",
"Represents if a resource violates CIS GCP Foundation 2.0.",
"Represents if a resource violates CIS GCP Foundation 1.3.",
"Represents if a resource violates CIS GCP Foundation 1.2.",
"Represents if a resource violates CIS GCP Foundation 1.1.",
"Represents if a resource violates CIS GCP Foundation 1.0.",
"Represents if a resource violates CIS Controls 8.0.",
"Represents if a resource violates NIST 800-53.",
"Represents if a resource violates NIST 800-53 R5.",
"Represents if a resource violates NIST Cybersecurity Framework 1.0.",
"Represents if a resource violates ISO-27001.",
"Represents if a resource violates ISO 27001 2022.",
"Represents if a resource violates PCI-DSS v3.2.1.",
"Represents if a resource violates PCI-DSS v4.0.",
"Represents if a resource violates Cloud Controls Matrix v4.0.",
"Represents if a resource violates HIPAA.",
"Represents if a resource violates SOC2 v2017.",
"Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).",
"Represents if the log_lock_waits database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance is not set appropriately.",
"Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance does not have an appropriate severity level.",
"Represents if the log_min_messages database flag for a Cloud SQL for PostgreSQL instance is not set to warning or another recommended value.",
"Represents if the databaseFlags property of instance metadata for the log_executor_status field is set to on.",
"Represents if the log_hostname database flag for a Cloud SQL for PostgreSQL instance is not set to off.",
"Represents if the log_parser_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.",
"Represents if the log_planner_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.",
"Represents if the log_statement database flag for a Cloud SQL for PostgreSQL instance is not set to DDL (all data definition statements).",
"Represents if the log_statement_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.",
"Represents if the log_temp_files database flag for a Cloud SQL for PostgreSQL instance is not set to \"0\". (NOTE: 0 = ON)",
"Represents if the user connections database flag for a Cloud SQL for SQL Server instance is configured.",
"Represents if the user options database flag for Cloud SQL SQL Server instance is configured or not.",
"Represents if a resource is exposed to public access.",
"Represents if a resources requires all incoming connections to use SSL or not.",
"Represents if a Cloud SQL database has a password configured for the root account or not.",
"Represents if a Cloud SQL database has a weak password configured for the root account.",
"Represents if a SQL database instance is not encrypted with customer-managed encryption keys (CMEK).",
"Represents if The contained database authentication database flag for a Cloud SQL for SQL Server instance is not set to off.",
"Represents if the cross_db_ownership_chaining database flag for a Cloud SQL for SQL Server instance is not set to off.",
"Represents if he external scripts enabled database flag for a Cloud SQL for SQL Server instance is not set to off.",
"Represents if the local_infile database flag for a Cloud SQL for MySQL instance is not set to off.",
"Represents if the log_connections database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_disconnections database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_min_duration_statement database flag for a Cloud SQL for PostgreSQL instance is not set to -1.",
"Represents if the remote access database flag for a Cloud SQL for SQL Server instance is not set to off.",
"Represents if the skip_show_database database flag for a Cloud SQL for MySQL instance is not set to on.",
"Represents if the 3625 (trace flag) database flag for a Cloud SQL for SQL Server instance is not set to on.",
"Represents if public IP is enabled.",
"Represents Idle instance helps to reduce costs.",
"Represents instances that are unnecessarily large for given workload.",
"Represents high number of concurrently opened tables.",
"Represents high table count close to SLA limit.",
"Represents high number of unvacuumed transactions",
"Represents need for more CPU and/or memory",
"Represents out of disk.",
"Represents server certificate is near expiry.",
"Represents database auditing is disabled.",
"Represents not restricted to authorized networks.",
"Represents violate org policy restrict public ip.",
"Cluster nearing quota limit",
"No password policy set on resources",
"Performance impact of connections settings",
"Performance impact of temporary tables settings",
"Performance impact of transaction logs settings",
"Performance impact of high joins without indexes",
"Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.",
"Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.",
"Detects if database instance data exported to a Cloud Storage bucket outside of the organization.",
"Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible."
],
"type": "string"
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"RESOLVED",
"MUTED"
],
"enumDescriptions": [
"Unspecified state.",
"The signal requires attention and has not been addressed yet.",
"The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.",
"The signal has been muted."
],
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainDatabaseResourceId": {
"description": "DatabaseResourceId will serve as primary key for any resource ingestion event.",
"id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId",
"properties": {
"provider": {
"description": "Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged",
"enum": [
"PROVIDER_UNSPECIFIED",
"GCP",
"AWS",
"AZURE",
"ONPREM",
"SELFMANAGED",
"PROVIDER_OTHER"
],
"enumDescriptions": [
"",
"Google cloud platform provider",
"Amazon web service",
"Azure web service",
"On-prem database resources.",
"Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.",
"For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values."
],
"type": "string"
},
"providerDescription": {
"description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.",
"type": "string"
},
"resourceType": {
"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel",
"type": "string"
},
"uniqueId": {
"description": "Required. A service-local token that distinguishes this resource from other resources within the same service.",
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": {
"description": "Common model for database resource instance metadata.",
"id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata",
"properties": {
"availabilityConfiguration": {
"$ref": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration",
"description": "Availability configuration for this instance"
},
"backupConfiguration": {
"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration",
"description": "Backup configuration for this instance"
},
"backupRun": {
"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun",
"description": "Latest backup run information for this instance"
},
"creationTime": {
"description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.",
"format": "google-datetime",
"type": "string"
},
"currentState": {
"description": "Current state of the instance.",
"enum": [
"STATE_UNSPECIFIED",
"HEALTHY",
"UNHEALTHY",
"SUSPENDED",
"DELETED",
"STATE_OTHER"
],
"enumDescriptions": [
"",
"The instance is running.",
"Instance being created, updated, deleted or under maintenance",
"When instance is suspended",
"Instance is deleted.",
"For rest of the other category"
],
"type": "string"
},
"customMetadata": {
"$ref": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData",
"description": "Any custom metadata associated with the resource"
},
"entitlements": {
"description": "Entitlements associated with the resource",
"items": {
"$ref": "StorageDatabasecenterPartnerapiV1mainEntitlement"
},
"type": "array"
},
"expectedState": {
"description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.",
"enum": [
"STATE_UNSPECIFIED",
"HEALTHY",
"UNHEALTHY",
"SUSPENDED",
"DELETED",
"STATE_OTHER"
],
"enumDescriptions": [
"",
"The instance is running.",
"Instance being created, updated, deleted or under maintenance",
"When instance is suspended",
"Instance is deleted.",
"For rest of the other category"
],
"type": "string"
},
"id": {
"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId",
"description": "Required. Unique identifier for a Database resource"
},
"instanceType": {
"description": "The type of the instance. Specified at creation time.",
"enum": [
"INSTANCE_TYPE_UNSPECIFIED",
"SUB_RESOURCE_TYPE_UNSPECIFIED",
"PRIMARY",
"SECONDARY",
"READ_REPLICA",
"OTHER",
"SUB_RESOURCE_TYPE_PRIMARY",
"SUB_RESOURCE_TYPE_SECONDARY",
"SUB_RESOURCE_TYPE_READ_REPLICA",
"SUB_RESOURCE_TYPE_OTHER"
],
"enumDeprecated": [
true,
false,
true,
true,
true,
true,
false,
false,
false,
false
],
"enumDescriptions": [
"",
"For rest of the other categories.",
"A regular primary database instance.",
"A cluster or an instance acting as a secondary.",
"An instance acting as a read-replica.",
"For rest of the other categories.",
"A regular primary database instance.",
"A cluster or an instance acting as a secondary.",
"An instance acting as a read-replica.",
"For rest of the other categories."
],
"type": "string"
},
"location": {
"description": "The resource location. REQUIRED",
"type": "string"
},
"machineConfiguration": {
"$ref": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration",
"description": "Machine configuration for this resource."
},
"primaryResourceId": {
"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId",
"description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional."
},
"product": {
"$ref": "StorageDatabasecenterProtoCommonProduct",
"description": "The product this resource represents."
},
"resourceContainer": {
"description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.",
"type": "string"
},
"resourceName": {
"description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel",
"type": "string"
},
"updationTime": {
"description": "The time at which the resource was updated and recorded at partner service.",
"format": "google-datetime",
"type": "string"
},
"userLabelSet": {
"$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels",
"description": "User-provided labels associated with the resource"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData": {
"description": "Common model for database resource recommendation signal data.",
"id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData",
"properties": {
"additionalMetadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. Any other additional metadata specific to recommendation",
"type": "object"
},
"lastRefreshTime": {
"description": "Required. last time recommendationw as refreshed",
"format": "google-datetime",
"type": "string"
},
"recommendationState": {
"description": "Required. Recommendation state",
"enum": [
"UNSPECIFIED",
"ACTIVE",
"CLAIMED",
"SUCCEEDED",
"FAILED",
"DISMISSED"
],
"enumDescriptions": [
"",
"Recommendation is active and can be applied. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.",
"Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.",
"Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.",
"Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.",
"Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE."
],
"type": "string"
},
"recommender": {
"description": "Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876",
"type": "string"
},
"recommenderId": {
"description": "Required. ID of recommender. Examples: \"google.cloudsql.instance.PerformanceRecommender\"",
"type": "string"
},
"recommenderSubtype": {
"description": "Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.cloudsql.instance.PerformanceRecommender\", recommender_subtype can be \"MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE\"/\"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE\"",
"type": "string"
},
"resourceName": {
"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel",
"type": "string"
},
"signalType": {
"description": "Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.",
"enum": [
"SIGNAL_TYPE_UNSPECIFIED",
"SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER",
"SIGNAL_TYPE_GROUP_NOT_REPLICATING_ACROSS_REGIONS",
"SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_ZONES",
"SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_REGIONS",
"SIGNAL_TYPE_NO_PROMOTABLE_REPLICA",
"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY",
"SIGNAL_TYPE_SHORT_BACKUP_RETENTION",
"SIGNAL_TYPE_LAST_BACKUP_FAILED",
"SIGNAL_TYPE_LAST_BACKUP_OLD",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_2_0",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_3",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1",
"SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0",
"SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0",
"SIGNAL_TYPE_VIOLATES_NIST_800_53",
"SIGNAL_TYPE_VIOLATES_NIST_800_53_R5",
"SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0",
"SIGNAL_TYPE_VIOLATES_ISO_27001",
"SIGNAL_TYPE_VIOLATES_ISO_27001_V2022",
"SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1",
"SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0",
"SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4",
"SIGNAL_TYPE_VIOLATES_HIPAA",
"SIGNAL_TYPE_VIOLATES_SOC2_V2017",
"SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING",
"SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED",
"SIGNAL_TYPE_VERBOSE_ERROR_LOGGING",
"SIGNAL_TYPE_QUERY_LOCK_WAITS_NOT_LOGGED",
"SIGNAL_TYPE_LOGGING_MOST_ERRORS",
"SIGNAL_TYPE_LOGGING_ONLY_CRITICAL_ERRORS",
"SIGNAL_TYPE_MINIMAL_ERROR_LOGGING",
"SIGNAL_TYPE_QUERY_STATISTICS_LOGGED",
"SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_CLIENT_HOSTNAME",
"SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PARSER_STATISTICS",
"SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PLANNER_STATISTICS",
"SIGNAL_TYPE_NOT_LOGGING_ONLY_DDL_STATEMENTS",
"SIGNAL_TYPE_LOGGING_QUERY_STATISTICS",
"SIGNAL_TYPE_NOT_LOGGING_TEMPORARY_FILES",
"SIGNAL_TYPE_CONNECTION_MAX_NOT_CONFIGURED",
"SIGNAL_TYPE_USER_OPTIONS_CONFIGURED",
"SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS",
"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS",
"SIGNAL_TYPE_NO_ROOT_PASSWORD",
"SIGNAL_TYPE_WEAK_ROOT_PASSWORD",
"SIGNAL_TYPE_ENCRYPTION_KEY_NOT_CUSTOMER_MANAGED",
"SIGNAL_TYPE_SERVER_AUTHENTICATION_NOT_REQUIRED",
"SIGNAL_TYPE_EXPOSED_BY_OWNERSHIP_CHAINING",
"SIGNAL_TYPE_EXPOSED_TO_EXTERNAL_SCRIPTS",
"SIGNAL_TYPE_EXPOSED_TO_LOCAL_DATA_LOADS",
"SIGNAL_TYPE_CONNECTION_ATTEMPTS_NOT_LOGGED",
"SIGNAL_TYPE_DISCONNECTIONS_NOT_LOGGED",
"SIGNAL_TYPE_LOGGING_EXCESSIVE_STATEMENT_INFO",
"SIGNAL_TYPE_EXPOSED_TO_REMOTE_ACCESS",
"SIGNAL_TYPE_DATABASE_NAMES_EXPOSED",
"SIGNAL_TYPE_SENSITIVE_TRACE_INFO_NOT_MASKED",
"SIGNAL_TYPE_PUBLIC_IP_ENABLED",
"SIGNAL_TYPE_IDLE",
"SIGNAL_TYPE_OVERPROVISIONED",
"SIGNAL_TYPE_HIGH_NUMBER_OF_OPEN_TABLES",
"SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES",
"SIGNAL_TYPE_HIGH_TRANSACTION_ID_UTILIZATION",
"SIGNAL_TYPE_UNDERPROVISIONED",
"SIGNAL_TYPE_OUT_OF_DISK",
"SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY",
"SIGNAL_TYPE_DATABASE_AUDITING_DISABLED",
"SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS",
"SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP",
"SIGNAL_TYPE_QUOTA_LIMIT",
"SIGNAL_TYPE_NO_PASSWORD_POLICY",
"SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT",
"SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT",
"SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT",
"SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES",
"SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES",
"SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS",
"SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET",
"SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET"
],
"enumDeprecated": [
false,
false,
false,
true,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Unspecified.",
"Represents if a resource is protected by automatic failover. Checks for resources that are configured to have redundancy within a region that enables automatic failover.",
"Represents if a group is replicating across regions. Checks for resources that are configured to have redundancy, and ongoing replication, across regions.",
"Represents if the resource is available in multiple zones or not.",
"Represents if a resource is available in multiple regions.",
"Represents if a resource has a promotable replica.",
"Represents if a resource has an automated backup policy.",
"Represents if a resources has a short backup retention period.",
"Represents if the last backup of a resource failed.",
"Represents if the last backup of a resource is older than some threshold value.",
"Represents if a resource violates CIS GCP Foundation 2.0.",
"Represents if a resource violates CIS GCP Foundation 1.3.",
"Represents if a resource violates CIS GCP Foundation 1.2.",
"Represents if a resource violates CIS GCP Foundation 1.1.",
"Represents if a resource violates CIS GCP Foundation 1.0.",
"Represents if a resource violates CIS Controls 8.0.",
"Represents if a resource violates NIST 800-53.",
"Represents if a resource violates NIST 800-53 R5.",
"Represents if a resource violates NIST Cybersecurity Framework 1.0.",
"Represents if a resource violates ISO-27001.",
"Represents if a resource violates ISO 27001 2022.",
"Represents if a resource violates PCI-DSS v3.2.1.",
"Represents if a resource violates PCI-DSS v4.0.",
"Represents if a resource violates Cloud Controls Matrix v4.0.",
"Represents if a resource violates HIPAA.",
"Represents if a resource violates SOC2 v2017.",
"Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).",
"Represents if the log_lock_waits database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance is not set appropriately.",
"Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance does not have an appropriate severity level.",
"Represents if the log_min_messages database flag for a Cloud SQL for PostgreSQL instance is not set to warning or another recommended value.",
"Represents if the databaseFlags property of instance metadata for the log_executor_status field is set to on.",
"Represents if the log_hostname database flag for a Cloud SQL for PostgreSQL instance is not set to off.",
"Represents if the log_parser_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.",
"Represents if the log_planner_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.",
"Represents if the log_statement database flag for a Cloud SQL for PostgreSQL instance is not set to DDL (all data definition statements).",
"Represents if the log_statement_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.",
"Represents if the log_temp_files database flag for a Cloud SQL for PostgreSQL instance is not set to \"0\". (NOTE: 0 = ON)",
"Represents if the user connections database flag for a Cloud SQL for SQL Server instance is configured.",
"Represents if the user options database flag for Cloud SQL SQL Server instance is configured or not.",
"Represents if a resource is exposed to public access.",
"Represents if a resources requires all incoming connections to use SSL or not.",
"Represents if a Cloud SQL database has a password configured for the root account or not.",
"Represents if a Cloud SQL database has a weak password configured for the root account.",
"Represents if a SQL database instance is not encrypted with customer-managed encryption keys (CMEK).",
"Represents if The contained database authentication database flag for a Cloud SQL for SQL Server instance is not set to off.",
"Represents if the cross_db_ownership_chaining database flag for a Cloud SQL for SQL Server instance is not set to off.",
"Represents if he external scripts enabled database flag for a Cloud SQL for SQL Server instance is not set to off.",
"Represents if the local_infile database flag for a Cloud SQL for MySQL instance is not set to off.",
"Represents if the log_connections database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_disconnections database flag for a Cloud SQL for PostgreSQL instance is not set to on.",
"Represents if the log_min_duration_statement database flag for a Cloud SQL for PostgreSQL instance is not set to -1.",
"Represents if the remote access database flag for a Cloud SQL for SQL Server instance is not set to off.",
"Represents if the skip_show_database database flag for a Cloud SQL for MySQL instance is not set to on.",
"Represents if the 3625 (trace flag) database flag for a Cloud SQL for SQL Server instance is not set to on.",
"Represents if public IP is enabled.",
"Represents Idle instance helps to reduce costs.",
"Represents instances that are unnecessarily large for given workload.",
"Represents high number of concurrently opened tables.",
"Represents high table count close to SLA limit.",
"Represents high number of unvacuumed transactions",
"Represents need for more CPU and/or memory",
"Represents out of disk.",
"Represents server certificate is near expiry.",
"Represents database auditing is disabled.",
"Represents not restricted to authorized networks.",
"Represents violate org policy restrict public ip.",
"Cluster nearing quota limit",
"No password policy set on resources",
"Performance impact of connections settings",
"Performance impact of temporary tables settings",
"Performance impact of transaction logs settings",
"Performance impact of high joins without indexes",
"Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.",
"Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.",
"Detects if database instance data exported to a Cloud Storage bucket outside of the organization.",
"Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible."
],
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainEntitlement": {
"description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.",
"id": "StorageDatabasecenterPartnerapiV1mainEntitlement",
"properties": {
"entitlementState": {
"description": "The current state of user's accessibility to a feature/benefit.",
"enum": [
"ENTITLEMENT_STATE_UNSPECIFIED",
"ENTITLED",
"REVOKED"
],
"enumDescriptions": [
"",
"User is entitled to a feature/benefit, but whether it has been successfully provisioned is decided by provisioning state.",
"User is entitled to a feature/benefit, but it was requested to be revoked. Whether the revoke has been successful is decided by provisioning state."
],
"type": "string"
},
"type": {
"description": "An enum that represents the type of this entitlement.",
"enum": [
"ENTITLEMENT_TYPE_UNSPECIFIED",
"GEMINI"
],
"enumDescriptions": [
"",
"The root entitlement representing Gemini package ownership."
],
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": {
"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.",
"id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata",
"properties": {
"backupConfiguration": {
"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration",
"description": "Backup configuration for this database"
},
"backupRun": {
"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun",
"description": "Information about the last backup attempt for this database"
},
"product": {
"$ref": "StorageDatabasecenterProtoCommonProduct"
},
"resourceId": {
"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId"
},
"resourceName": {
"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"",
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainMachineConfiguration": {
"description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.",
"id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration",
"properties": {
"cpuCount": {
"description": "The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.",
"format": "int32",
"type": "integer"
},
"memorySizeInBytes": {
"description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainObservabilityMetricData": {
"id": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData",
"properties": {
"aggregationType": {
"description": "Required. Type of aggregation performed on the metric.",
"enum": [
"AGGREGATION_TYPE_UNSPECIFIED",
"PEAK",
"P99",
"P95",
"CURRENT"
],
"enumDescriptions": [
"Unspecified aggregation type.",
"PEAK aggregation type.",
"P99 aggregation type.",
"P95 aggregation type.",
"current aggregation type."
],
"type": "string"
},
"metricType": {
"description": "Required. Type of metric like CPU, Memory, etc.",
"enum": [
"METRIC_TYPE_UNSPECIFIED",
"CPU_UTILIZATION",
"MEMORY_UTILIZATION",
"NETWORK_CONNECTIONS",
"STORAGE_UTILIZATION",
"STORAGE_USED_BYTES"
],
"enumDescriptions": [
"Unspecified metric type.",
"CPU utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).",
"Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).",
"Number of network connections for a resource.",
"Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).",
"Sotrage used by a resource."
],
"type": "string"
},
"observationTime": {
"description": "Required. The time the metric value was observed.",
"format": "google-datetime",
"type": "string"
},
"resourceName": {
"description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel",
"type": "string"
},
"value": {
"$ref": "StorageDatabasecenterProtoCommonTypedValue",
"description": "Required. Value of the metric type."
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainOperationError": {
"description": "An error that occurred during a backup creation operation.",
"id": "StorageDatabasecenterPartnerapiV1mainOperationError",
"properties": {
"code": {
"description": "Identifies the specific error that occurred. REQUIRED",
"type": "string"
},
"errorType": {
"enum": [
"OPERATION_ERROR_TYPE_UNSPECIFIED",
"KMS_KEY_ERROR",
"DATABASE_ERROR",
"STOCKOUT_ERROR",
"CANCELLATION_ERROR",
"SQLSERVER_ERROR",
"INTERNAL_ERROR"
],
"enumDescriptions": [
"UNSPECIFIED means product type is not known or available.",
"key destroyed, expired, not found, unreachable or permission denied.",
"Database is not accessible",
"The zone or region does not have sufficient resources to handle the request at the moment",
"User initiated cancellation",
"SQL server specific error",
"Any other internal error."
],
"type": "string"
},
"message": {
"description": "Additional information about the error encountered. REQUIRED",
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainRetentionSettings": {
"id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings",
"properties": {
"quantityBasedRetention": {
"format": "int32",
"type": "integer"
},
"retentionUnit": {
"description": "The unit that 'retained_backups' represents.",
"enum": [
"RETENTION_UNIT_UNSPECIFIED",
"COUNT",
"TIME",
"RETENTION_UNIT_OTHER"
],
"enumDescriptions": [
"Backup retention unit is unspecified, will be treated as COUNT.",
"Retention will be by count, eg. \"retain the most recent 7 backups\".",
"Retention will be by Time, eg. \"retain the last 7 days backups\".",
"For rest of the other category"
],
"type": "string"
},
"timeBasedRetention": {
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterPartnerapiV1mainUserLabels": {
"description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.",
"id": "StorageDatabasecenterPartnerapiV1mainUserLabels",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"StorageDatabasecenterProtoCommonProduct": {
"description": "Product specification for Condor resources.",
"id": "StorageDatabasecenterProtoCommonProduct",
"properties": {
"engine": {
"description": "The specific engine that the underlying database is running.",
"enum": [
"ENGINE_UNSPECIFIED",
"ENGINE_MYSQL",
"MYSQL",
"ENGINE_POSTGRES",
"POSTGRES",
"ENGINE_SQL_SERVER",
"SQL_SERVER",
"ENGINE_NATIVE",
"NATIVE",
"ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT",
"ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT",
"ENGINE_MEMORYSTORE_FOR_REDIS",
"ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER",
"ENGINE_OTHER",
"ENGINE_FIRESTORE_WITH_NATIVE_MODE",
"ENGINE_FIRESTORE_WITH_DATASTORE_MODE"
],
"enumDeprecated": [
false,
false,
true,
false,
true,
false,
true,
false,
true,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"UNSPECIFIED means engine type is not known or available.",
"MySQL binary running as an engine in the database instance.",
"MySQL binary running as engine in database instance.",
"Postgres binary running as engine in database instance.",
"Postgres binary running as engine in database instance.",
"SQLServer binary running as engine in database instance.",
"SQLServer binary running as engine in database instance.",
"Native database binary running as engine in instance.",
"Native database binary running as engine in instance.",
"Cloud Spanner with PostgreSQL dialect.",
"Cloud Spanner with Google SQL dialect.",
"Memorystore with Redis dialect.",
"Memorystore with Redis cluster dialect.",
"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.",
"Firestore with native mode.",
"Firestore with datastore mode."
],
"type": "string"
},
"type": {
"description": "Type of specific database product. It could be CloudSQL, AlloyDB etc..",
"enum": [
"PRODUCT_TYPE_UNSPECIFIED",
"PRODUCT_TYPE_CLOUD_SQL",
"CLOUD_SQL",
"PRODUCT_TYPE_ALLOYDB",
"ALLOYDB",
"PRODUCT_TYPE_SPANNER",
"PRODUCT_TYPE_ON_PREM",
"ON_PREM",
"PRODUCT_TYPE_MEMORYSTORE",
"PRODUCT_TYPE_BIGTABLE",
"PRODUCT_TYPE_OTHER",
"PRODUCT_TYPE_FIRESTORE"
],
"enumDeprecated": [
false,
false,
true,
false,
true,
false,
false,
true,
false,
false,
false,
false
],
"enumDescriptions": [
"UNSPECIFIED means product type is not known or available.",
"Cloud SQL product area in GCP",
"Cloud SQL product area in GCP",
"AlloyDB product area in GCP",
"AlloyDB product area in GCP",
"Spanner product area in GCP",
"On premises database product.",
"On premises database product.",
"Memorystore product area in GCP",
"Bigtable product area in GCP",
"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.",
"Firestore product area in GCP."
],
"type": "string"
},
"version": {
"description": "Version of the underlying database engine. Example values: For MySQL, it could be \"8.0\", \"5.7\" etc.. For Postgres, it could be \"14\", \"15\" etc..",
"type": "string"
}
},
"type": "object"
},
"StorageDatabasecenterProtoCommonTypedValue": {
"description": "TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.",
"id": "StorageDatabasecenterProtoCommonTypedValue",
"properties": {
"boolValue": {
"description": "For boolean value",
"type": "boolean"
},
"doubleValue": {
"description": "For double value",
"format": "double",
"type": "number"
},
"int64Value": {
"description": "For integer value",
"format": "int64",
"type": "string"
},
"stringValue": {
"description": "For string value",
"type": "string"
}
},
"type": "object"
},
"StringRestrictions": {
"description": "Restrictions on STRING type values",
"id": "StringRestrictions",
"properties": {
"allowedValues": {
"description": "The list of allowed values, if bounded. This field will be empty if there is a unbounded number of allowed values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SupportedDatabaseFlag": {
"description": "SupportedDatabaseFlag gives general information about a database flag, like type and allowed values. This is a static value that is defined on the server side, and it cannot be modified by callers. To set the Database flags on a particular Instance, a caller should modify the Instance.database_flags field.",
"id": "SupportedDatabaseFlag",
"properties": {
"acceptsMultipleValues": {
"description": "Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.",
"type": "boolean"
},
"flagName": {
"description": "The name of the database flag, e.g. \"max_allowed_packets\". The is a possibly key for the Instance.database_flags map field.",
"type": "string"
},
"integerRestrictions": {
"$ref": "IntegerRestrictions",
"description": "Restriction on INTEGER type value."
},
"name": {
"description": "The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.",
"type": "string"
},
"requiresDbRestart": {
"description": "Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).",
"type": "boolean"
},
"stringRestrictions": {
"$ref": "StringRestrictions",
"description": "Restriction on STRING type value."
},
"supportedDbVersions": {
"description": "Major database engine versions for which this flag is supported.",
"items": {
"enum": [
"DATABASE_VERSION_UNSPECIFIED",
"POSTGRES_13",
"POSTGRES_14",
"POSTGRES_15",
"POSTGRES_16"
],
"enumDeprecated": [
false,
true,
false,
false,
false
],
"enumDescriptions": [
"This is an unknown database version.",
"DEPRECATED - The database version is Postgres 13.",
"The database version is Postgres 14.",
"The database version is Postgres 15.",
"The database version is Postgres 16."
],
"type": "string"
},
"type": "array"
},
"valueType": {
"enum": [
"VALUE_TYPE_UNSPECIFIED",
"STRING",
"INTEGER",
"FLOAT",
"NONE"
],
"enumDescriptions": [
"This is an unknown flag type.",
"String type flag.",
"Integer type flag.",
"Float type flag.",
"Denotes that the flag does not accept any values."
],
"type": "string"
}
},
"type": "object"
},
"SwitchoverClusterRequest": {
"description": "Message for switching over to a cluster",
"id": "SwitchoverClusterRequest",
"properties": {
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.",
"type": "boolean"
}
},
"type": "object"
},
"TimeBasedRetention": {
"description": "A time based retention policy specifies that all backups within a certain time period should be retained.",
"id": "TimeBasedRetention",
"properties": {
"retentionPeriod": {
"description": "The retention period.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"TrialMetadata": {
"description": "Contains information and all metadata related to TRIAL clusters.",
"id": "TrialMetadata",
"properties": {
"endTime": {
"description": "End time of the trial cluster.",
"format": "google-datetime",
"type": "string"
},
"graceEndTime": {
"description": "grace end time of the cluster.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "start time of the trial cluster.",
"format": "google-datetime",
"type": "string"
},
"upgradeTime": {
"description": "Upgrade time of trial cluster to Standard cluster.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"UpdatePolicy": {
"description": "Policy to be used while updating the instance.",
"id": "UpdatePolicy",
"properties": {
"mode": {
"description": "Mode for updating the instance.",
"enum": [
"MODE_UNSPECIFIED",
"DEFAULT",
"FORCE_APPLY"
],
"enumDescriptions": [
"Mode is unknown.",
"Least disruptive way to apply the update.",
"Performs a forced update when applicable. This will be fast but may incur a downtime."
],
"type": "string"
}
},
"type": "object"
},
"UpgradeClusterRequest": {
"description": "Upgrades a cluster.",
"id": "UpgradeClusterRequest",
"properties": {
"etag": {
"description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.",
"type": "string"
},
"requestId": {
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"type": "string"
},
"validateOnly": {
"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.",
"type": "boolean"
},
"version": {
"description": "Required. The version the cluster is going to be upgraded to.",
"enum": [
"DATABASE_VERSION_UNSPECIFIED",
"POSTGRES_13",
"POSTGRES_14",
"POSTGRES_15",
"POSTGRES_16"
],
"enumDeprecated": [
false,
true,
false,
false,
false
],
"enumDescriptions": [
"This is an unknown database version.",
"DEPRECATED - The database version is Postgres 13.",
"The database version is Postgres 14.",
"The database version is Postgres 15.",
"The database version is Postgres 16."
],
"type": "string"
}
},
"type": "object"
},
"UpgradeClusterResponse": {
"description": "UpgradeClusterResponse contains the response for upgrade cluster operation.",
"id": "UpgradeClusterResponse",
"properties": {
"clusterUpgradeDetails": {
"description": "Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.",
"items": {
"$ref": "ClusterUpgradeDetails"
},
"type": "array"
},
"message": {
"description": "A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.",
"type": "string"
},
"status": {
"description": "Status of upgrade operation.",
"enum": [
"STATUS_UNSPECIFIED",
"SUCCESS",
"FAILED",
"PARTIAL_SUCCESS"
],
"enumDescriptions": [
"Unspecified status.",
"Operation succeeded.",
"Operation failed.",
"Operation partially succeeded."
],
"type": "string"
}
},
"type": "object"
},
"User": {
"description": "Message describing User object.",
"id": "User",
"properties": {
"databaseRoles": {
"description": "Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.",
"readOnly": true,
"type": "string"
},
"password": {
"description": "Input only. Password for the user.",
"type": "string"
},
"userType": {
"description": "Optional. Type of this user.",
"enum": [
"USER_TYPE_UNSPECIFIED",
"ALLOYDB_BUILT_IN",
"ALLOYDB_IAM_USER"
],
"enumDescriptions": [
"Unspecified user type.",
"The default user type that authenticates via password-based authentication.",
"Database user that can authenticate via IAM-Based authentication."
],
"type": "string"
}
},
"type": "object"
},
"UserPassword": {
"description": "The username/password for a database user. Used for specifying initial users at cluster creation time.",
"id": "UserPassword",
"properties": {
"password": {
"description": "The initial password for the user.",
"type": "string"
},
"user": {
"description": "The database username.",
"type": "string"
}
},
"type": "object"
},
"WeeklySchedule": {
"description": "A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the `start_times` field to have one element \"22:00\" and the `days_of_week` field to have all seven days of the week.",
"id": "WeeklySchedule",
"properties": {
"daysOfWeek": {
"description": "The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.",
"items": {
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string"
},
"type": "array"
},
"startTimes": {
"description": "The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.",
"items": {
"$ref": "GoogleTypeTimeOfDay"
},
"type": "array"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "AlloyDB API",
"version": "v1alpha",
"version_module": true
} |