v1beta4.d.ts
132 KB
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
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace sqladmin_v1beta4 {
export interface Options extends GlobalOptions {
version: 'v1beta4';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Cloud SQL Admin API
*
* Creates and manages Cloud SQL instances, which provide fully managed MySQL or PostgreSQL databases.
*
* @example
* const {google} = require('googleapis');
* const sqladmin = google.sqladmin('v1beta4');
*
* @namespace sqladmin
* @type {Function}
* @version v1beta4
* @variation v1beta4
* @param {object=} options Options for Sqladmin
*/
export class Sqladmin {
context: APIRequestContext;
backupRuns: Resource$Backupruns;
databases: Resource$Databases;
flags: Resource$Flags;
instances: Resource$Instances;
operations: Resource$Operations;
sslCerts: Resource$Sslcerts;
tiers: Resource$Tiers;
users: Resource$Users;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An entry for an Access Control list.
*/
export interface Schema$AclEntry {
/**
* The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
expirationTime?: string | null;
/**
* This is always sql#aclEntry.
*/
kind?: string | null;
/**
* An optional label to identify this entry.
*/
name?: string | null;
/**
* The whitelisted value for the access control list.
*/
value?: string | null;
}
/**
* An Admin API warning message.
*/
export interface Schema$ApiWarning {
/**
* Code to uniquely identify the warning type.
*/
code?: string | null;
/**
* The warning message.
*/
message?: string | null;
}
/**
* Database instance backup configuration.
*/
export interface Schema$BackupConfiguration {
/**
* Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.
*/
binaryLogEnabled?: boolean | null;
/**
* Whether this configuration is enabled.
*/
enabled?: boolean | null;
/**
* This is always sql#backupConfiguration.
*/
kind?: string | null;
/**
* The location of the backup.
*/
location?: string | null;
/**
* Reserved for future use.
*/
replicationLogArchivingEnabled?: boolean | null;
/**
* Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
*/
startTime?: string | null;
}
/**
* A BackupRun resource.
*/
export interface Schema$BackupRun {
/**
* The description of this run, only applicable to on-demand backups.
*/
description?: string | null;
/**
* Disk encryption configuration specific to a backup. Applies only to Second Generation instances.
*/
diskEncryptionConfiguration?: Schema$DiskEncryptionConfiguration;
/**
* Disk encryption status specific to a backup. Applies only to Second Generation instances.
*/
diskEncryptionStatus?: Schema$DiskEncryptionStatus;
/**
* The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
endTime?: string | null;
/**
* The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
enqueuedTime?: string | null;
/**
* Information about why the backup operation failed. This is only present if the run has the FAILED status.
*/
error?: Schema$OperationError;
/**
* The identifier for this backup run. Unique only for a specific Cloud SQL instance.
*/
id?: string | null;
/**
* Name of the database instance.
*/
instance?: string | null;
/**
* This is always sql#backupRun.
*/
kind?: string | null;
/**
* The location of the backup.
*/
location?: string | null;
/**
* The URI of this resource.
*/
selfLink?: string | null;
/**
* The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
startTime?: string | null;
/**
* The status of this run.
*/
status?: string | null;
/**
* The type of this run; can be either "AUTOMATED" or "ON_DEMAND".
*/
type?: string | null;
/**
* The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
windowStartTime?: string | null;
}
/**
* Backup run list results.
*/
export interface Schema$BackupRunsListResponse {
/**
* A list of backup runs in reverse chronological order of the enqueued time.
*/
items?: Schema$BackupRun[];
/**
* This is always sql#backupRunsList.
*/
kind?: string | null;
/**
* The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Binary log coordinates.
*/
export interface Schema$BinLogCoordinates {
/**
* Name of the binary log file for a Cloud SQL instance.
*/
binLogFileName?: string | null;
/**
* Position (offset) within the binary log file.
*/
binLogPosition?: string | null;
/**
* This is always sql#binLogCoordinates.
*/
kind?: string | null;
}
/**
* Database instance clone context.
*/
export interface Schema$CloneContext {
/**
* Binary log coordinates, if specified, identify the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
*/
binLogCoordinates?: Schema$BinLogCoordinates;
/**
* Name of the Cloud SQL instance to be created as a clone.
*/
destinationInstanceName?: string | null;
/**
* This is always sql#cloneContext.
*/
kind?: string | null;
/**
* Reserved for future use.
*/
pitrTimestampMs?: string | null;
}
/**
* Represents a SQL database on the Cloud SQL instance.
*/
export interface Schema$Database {
/**
* The MySQL charset value.
*/
charset?: string | null;
/**
* The MySQL collation value.
*/
collation?: string | null;
/**
* This field is deprecated and will be removed from a future version of the API.
*/
etag?: string | null;
/**
* The name of the Cloud SQL instance. This does not include the project ID.
*/
instance?: string | null;
/**
* This is always sql#database.
*/
kind?: string | null;
/**
* The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
*/
name?: string | null;
/**
* The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.
*/
project?: string | null;
/**
* The URI of this resource.
*/
selfLink?: string | null;
}
/**
* Database flags for Cloud SQL instances.
*/
export interface Schema$DatabaseFlags {
/**
* The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags should be specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation.
*/
name?: string | null;
/**
* The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
*/
value?: string | null;
}
/**
* A Cloud SQL instance resource.
*/
export interface Schema$DatabaseInstance {
/**
* FIRST_GEN: First Generation instance. MySQL only. SECOND_GEN: Second Generation instance or PostgreSQL instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type and Second or First Generation.
*/
backendType?: string | null;
/**
* Connection name of the Cloud SQL instance used in connection strings.
*/
connectionName?: string | null;
/**
* The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.
*/
currentDiskSize?: string | null;
/**
* The database engine type and version. The databaseVersion field can not be changed after instance creation. MySQL Second Generation instances: MYSQL_5_7 (default) or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6 (default) or POSTGRES_11 Beta. MySQL First Generation instances: MYSQL_5_6 (default) or MYSQL_5_5
*/
databaseVersion?: string | null;
/**
* Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
*/
diskEncryptionConfiguration?: Schema$DiskEncryptionConfiguration;
/**
* Disk encryption status specific to an instance. Applies only to Second Generation instances.
*/
diskEncryptionStatus?: Schema$DiskEncryptionStatus;
/**
* This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.
*/
etag?: string | null;
/**
* The name and status of the failover replica. This property is applicable only to Second Generation instances.
*/
failoverReplica?: {
available?: boolean;
name?: string;
} | null;
/**
* The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
*/
gceZone?: string | null;
/**
* The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. ON_PREMISES_INSTANCE: An instance running on the customer's premises. READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
*/
instanceType?: string | null;
/**
* The assigned IP addresses for the instance.
*/
ipAddresses?: Schema$IpMapping[];
/**
* The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.
*/
ipv6Address?: string | null;
/**
* This is always sql#instance.
*/
kind?: string | null;
/**
* The name of the instance which will act as master in the replication setup.
*/
masterInstanceName?: string | null;
/**
* The maximum disk size of the instance in bytes.
*/
maxDiskSize?: string | null;
/**
* Name of the Cloud SQL instance. This does not include the project ID.
*/
name?: string | null;
/**
* Configuration specific to on-premises instances.
*/
onPremisesConfiguration?: Schema$OnPremisesConfiguration;
/**
* The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
*/
project?: string | null;
/**
* The geographical region. Can be us-central (FIRST_GEN instances only), us-central1 (SECOND_GEN instances only), asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation.
*/
region?: string | null;
/**
* Configuration specific to failover replicas and read replicas.
*/
replicaConfiguration?: Schema$ReplicaConfiguration;
/**
* The replicas of the instance.
*/
replicaNames?: string[] | null;
/**
* Initial root password. Use only on creation.
*/
rootPassword?: string | null;
/**
* The URI of this resource.
*/
selfLink?: string | null;
/**
* SSL configuration.
*/
serverCaCert?: Schema$SslCert;
/**
* The service account email address assigned to the instance. This property is applicable only to Second Generation instances.
*/
serviceAccountEmailAddress?: string | null;
/**
* The user settings.
*/
settings?: Schema$Settings;
/**
* The current serving state of the Cloud SQL instance. This can be one of the following. RUNNABLE: The instance is running, or is ready to run when accessed. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. FAILED: The instance creation failed. UNKNOWN_STATE: The state of the instance is unknown.
*/
state?: string | null;
/**
* If the instance state is SUSPENDED, the reason for the suspension.
*/
suspensionReason?: string[] | null;
}
/**
* Database list response.
*/
export interface Schema$DatabasesListResponse {
/**
* List of database resources in the instance.
*/
items?: Schema$Database[];
/**
* This is always sql#databasesList.
*/
kind?: string | null;
}
/**
* Read-replica configuration for connecting to the on-premises master.
*/
export interface Schema$DemoteMasterConfiguration {
/**
* This is always sql#demoteMasterConfiguration.
*/
kind?: string | null;
/**
* MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
*/
mysqlReplicaConfiguration?: Schema$DemoteMasterMySqlReplicaConfiguration;
}
/**
* Database instance demote master context.
*/
export interface Schema$DemoteMasterContext {
/**
* This is always sql#demoteMasterContext.
*/
kind?: string | null;
/**
* The name of the instance which will act as on-premises master in the replication setup.
*/
masterInstanceName?: string | null;
/**
* Configuration specific to read-replicas replicating from the on-premises master.
*/
replicaConfiguration?: Schema$DemoteMasterConfiguration;
/**
* Verify GTID consistency for demote operation. Default value: True. Second Generation instances only. Setting this flag to false enables you to bypass GTID consistency check between on-premises master and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.
*/
verifyGtidConsistency?: boolean | null;
}
/**
* Read-replica configuration specific to MySQL databases.
*/
export interface Schema$DemoteMasterMySqlReplicaConfiguration {
/**
* PEM representation of the trusted CA's x509 certificate.
*/
caCertificate?: string | null;
/**
* PEM representation of the slave's x509 certificate.
*/
clientCertificate?: string | null;
/**
* PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. The format of the slave's private key can be either PKCS #1 or PKCS #8.
*/
clientKey?: string | null;
/**
* This is always sql#demoteMasterMysqlReplicaConfiguration.
*/
kind?: string | null;
/**
* The password for the replication connection.
*/
password?: string | null;
/**
* The username for the replication connection.
*/
username?: string | null;
}
/**
* Disk encryption configuration.
*/
export interface Schema$DiskEncryptionConfiguration {
/**
* This is always sql#diskEncryptionConfiguration.
*/
kind?: string | null;
/**
* KMS key resource name
*/
kmsKeyName?: string | null;
}
/**
* Disk encryption status.
*/
export interface Schema$DiskEncryptionStatus {
/**
* This is always sql#diskEncryptionStatus.
*/
kind?: string | null;
/**
* KMS key version used to encrypt the Cloud SQL instance disk
*/
kmsKeyVersionName?: string | null;
}
/**
* Database instance export context.
*/
export interface Schema$ExportContext {
/**
* Options for exporting data as CSV.
*/
csvExportOptions?: {
selectQuery?: string;
} | null;
/**
* Databases to be exported. MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. PostgreSQL instances: Specify exactly one database to be exported. If fileType is CSV, this database must match the database used in the csvExportOptions.selectQuery property.
*/
databases?: string[] | null;
/**
* The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data.
*/
fileType?: string | null;
/**
* This is always sql#exportContext.
*/
kind?: string | null;
/**
* Options for exporting data as SQL statements.
*/
sqlExportOptions?: {
mysqlExportOptions?: {
masterData?: number;
};
schemaOnly?: boolean;
tables?: string[];
} | null;
/**
* The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the requests succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
*/
uri?: string | null;
}
/**
* Database instance failover context.
*/
export interface Schema$FailoverContext {
/**
* This is always sql#failoverContext.
*/
kind?: string | null;
/**
* The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.
*/
settingsVersion?: string | null;
}
/**
* A flag resource.
*/
export interface Schema$Flag {
/**
* For STRING flags, a list of strings that the value can be set to.
*/
allowedStringValues?: string[] | null;
/**
* The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or MYSQL_5_7. MYSQL_5_7 is applicable only to Second Generation instances.
*/
appliesTo?: string[] | null;
/**
* True if the flag is only released in Beta.
*/
inBeta?: boolean | null;
/**
* This is always sql#flag.
*/
kind?: string | null;
/**
* For INTEGER flags, the maximum allowed value.
*/
maxValue?: string | null;
/**
* For INTEGER flags, the minimum allowed value.
*/
minValue?: string | null;
/**
* This is the name of the flag. Flag names always use underscores, not hyphens, e.g. max_allowed_packet
*/
name?: string | null;
/**
* Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
*/
requiresRestart?: boolean | null;
/**
* The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags which do not take a value, such as skip_grant_tables.
*/
type?: string | null;
}
/**
* Flags list response.
*/
export interface Schema$FlagsListResponse {
/**
* List of flags.
*/
items?: Schema$Flag[];
/**
* This is always sql#flagsList.
*/
kind?: string | null;
}
/**
* Database instance import context.
*/
export interface Schema$ImportContext {
/**
* Import parameters specific to SQL Server .BAK files
*/
bakImportOptions?: {
encryptionOptions?: {
certPath?: string;
pvkPassword?: string;
pvkPath?: string;
};
} | null;
/**
* Options for importing data as CSV.
*/
csvImportOptions?: {
columns?: string[];
table?: string;
} | null;
/**
* The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If fileType is CSV, one database must be specified.
*/
database?: string | null;
/**
* The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data.
*/
fileType?: string | null;
/**
* The PostgreSQL user for this import operation. PostgreSQL instances only.
*/
importUser?: string | null;
/**
* This is always sql#importContext.
*/
kind?: string | null;
/**
* Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.
*/
uri?: string | null;
}
/**
* Database instance clone request.
*/
export interface Schema$InstancesCloneRequest {
/**
* Contains details about the clone operation.
*/
cloneContext?: Schema$CloneContext;
}
/**
* Database demote master request.
*/
export interface Schema$InstancesDemoteMasterRequest {
/**
* Contains details about the demoteMaster operation.
*/
demoteMasterContext?: Schema$DemoteMasterContext;
}
/**
* Database instance export request.
*/
export interface Schema$InstancesExportRequest {
/**
* Contains details about the export operation.
*/
exportContext?: Schema$ExportContext;
}
/**
* Instance failover request.
*/
export interface Schema$InstancesFailoverRequest {
/**
* Failover Context.
*/
failoverContext?: Schema$FailoverContext;
}
/**
* Database instance import request.
*/
export interface Schema$InstancesImportRequest {
/**
* Contains details about the import operation.
*/
importContext?: Schema$ImportContext;
}
/**
* Database instances list response.
*/
export interface Schema$InstancesListResponse {
/**
* List of database instance resources.
*/
items?: Schema$DatabaseInstance[];
/**
* This is always sql#instancesList.
*/
kind?: string | null;
/**
* The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string | null;
/**
* List of warnings that ocurred while handling the request.
*/
warnings?: Schema$ApiWarning[];
}
/**
* Instances ListServerCas response.
*/
export interface Schema$InstancesListServerCasResponse {
activeVersion?: string | null;
/**
* List of server CA certificates for the instance.
*/
certs?: Schema$SslCert[];
/**
* This is always sql#instancesListServerCas.
*/
kind?: string | null;
}
/**
* Database instance restore backup request.
*/
export interface Schema$InstancesRestoreBackupRequest {
/**
* Parameters required to perform the restore backup operation.
*/
restoreBackupContext?: Schema$RestoreBackupContext;
}
/**
* Rotate Server CA request.
*/
export interface Schema$InstancesRotateServerCaRequest {
/**
* Contains details about the rotate server CA operation.
*/
rotateServerCaContext?: Schema$RotateServerCaContext;
}
/**
* Instance truncate log request.
*/
export interface Schema$InstancesTruncateLogRequest {
/**
* Contains details about the truncate log operation.
*/
truncateLogContext?: Schema$TruncateLogContext;
}
/**
* IP Management configuration.
*/
export interface Schema$IpConfiguration {
/**
* The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).
*/
authorizedNetworks?: Schema$AclEntry[];
/**
* Whether the instance should be assigned an IP address or not.
*/
ipv4Enabled?: boolean | null;
/**
* The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, /projects/myProject/global/networks/default. This setting can be updated, but it cannot be removed after it is set.
*/
privateNetwork?: string | null;
/**
* Whether SSL connections over IP should be enforced or not.
*/
requireSsl?: boolean | null;
}
/**
* Database instance IP Mapping.
*/
export interface Schema$IpMapping {
/**
* The IP address assigned.
*/
ipAddress?: string | null;
/**
* The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
*/
timeToRetire?: string | null;
/**
* The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.
*/
type?: string | null;
}
/**
* Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.
*/
export interface Schema$LocationPreference {
/**
* The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.
*/
followGaeApplication?: string | null;
/**
* This is always sql#locationPreference.
*/
kind?: string | null;
/**
* The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.).
*/
zone?: string | null;
}
/**
* Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance purposes.
*/
export interface Schema$MaintenanceWindow {
/**
* day of week (1-7), starting on Monday.
*/
day?: number | null;
/**
* hour of day - 0 to 23.
*/
hour?: number | null;
/**
* This is always sql#maintenanceWindow.
*/
kind?: string | null;
/**
* Maintenance timing setting: canary (Earlier) or stable (Later). Learn more.
*/
updateTrack?: string | null;
}
/**
* Read-replica configuration specific to MySQL databases.
*/
export interface Schema$MySqlReplicaConfiguration {
/**
* PEM representation of the trusted CA's x509 certificate.
*/
caCertificate?: string | null;
/**
* PEM representation of the slave's x509 certificate.
*/
clientCertificate?: string | null;
/**
* PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.
*/
clientKey?: string | null;
/**
* Seconds to wait between connect retries. MySQL's default is 60 seconds.
*/
connectRetryInterval?: number | null;
/**
* Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.
*/
dumpFilePath?: string | null;
/**
* This is always sql#mysqlReplicaConfiguration.
*/
kind?: string | null;
/**
* Interval in milliseconds between replication heartbeats.
*/
masterHeartbeatPeriod?: string | null;
/**
* The password for the replication connection.
*/
password?: string | null;
/**
* A list of permissible ciphers to use for SSL encryption.
*/
sslCipher?: string | null;
/**
* The username for the replication connection.
*/
username?: string | null;
/**
* Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.
*/
verifyServerCertificate?: boolean | null;
}
/**
* On-premises instance configuration.
*/
export interface Schema$OnPremisesConfiguration {
/**
* The host and port of the on-premises instance in host:port format
*/
hostPort?: string | null;
/**
* This is always sql#onPremisesConfiguration.
*/
kind?: string | null;
}
/**
* An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
*/
export interface Schema$Operation {
/**
* The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
endTime?: string | null;
/**
* If errors occurred during processing of this operation, this field will be populated.
*/
error?: Schema$OperationErrors;
/**
* The context for export operation, if applicable.
*/
exportContext?: Schema$ExportContext;
/**
* The context for import operation, if applicable.
*/
importContext?: Schema$ImportContext;
/**
* The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
insertTime?: string | null;
/**
* This is always sql#operation.
*/
kind?: string | null;
/**
* An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
*/
name?: string | null;
/**
* The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
*/
operationType?: string | null;
/**
* The URI of this resource.
*/
selfLink?: string | null;
/**
* The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
startTime?: string | null;
/**
* The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
*/
status?: string | null;
/**
* Name of the database instance related to this operation.
*/
targetId?: string | null;
targetLink?: string | null;
/**
* The project ID of the target instance related to this operation.
*/
targetProject?: string | null;
/**
* The email address of the user who initiated this operation.
*/
user?: string | null;
}
/**
* Database instance operation error.
*/
export interface Schema$OperationError {
/**
* Identifies the specific error that occurred.
*/
code?: string | null;
/**
* This is always sql#operationError.
*/
kind?: string | null;
/**
* Additional information about the error encountered.
*/
message?: string | null;
}
/**
* Database instance operation errors list wrapper.
*/
export interface Schema$OperationErrors {
/**
* The list of errors encountered while processing this operation.
*/
errors?: Schema$OperationError[];
/**
* This is always sql#operationErrors.
*/
kind?: string | null;
}
/**
* Database instance list operations response.
*/
export interface Schema$OperationsListResponse {
/**
* List of operation resources.
*/
items?: Schema$Operation[];
/**
* This is always sql#operationsList.
*/
kind?: string | null;
/**
* The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Read-replica configuration for connecting to the master.
*/
export interface Schema$ReplicaConfiguration {
/**
* Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.
*/
failoverTarget?: boolean | null;
/**
* This is always sql#replicaConfiguration.
*/
kind?: string | null;
/**
* MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
*/
mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
}
/**
* Database instance restore from backup context.
*/
export interface Schema$RestoreBackupContext {
/**
* The ID of the backup run to restore from.
*/
backupRunId?: string | null;
/**
* The ID of the instance that the backup was taken from.
*/
instanceId?: string | null;
/**
* This is always sql#restoreBackupContext.
*/
kind?: string | null;
/**
* The full project ID of the source instance.
*/
project?: string | null;
}
/**
* Instance rotate server CA context.
*/
export interface Schema$RotateServerCaContext {
/**
* This is always sql#rotateServerCaContext.
*/
kind?: string | null;
/**
* The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version.
*/
nextVersion?: string | null;
}
/**
* Database instance settings.
*/
export interface Schema$Settings {
/**
* The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: ALWAYS: The instance is on, and remains so even in the absence of connection requests. NEVER: The instance is off; it is not activated, even if a connection request arrives. ON_DEMAND: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity.
*/
activationPolicy?: string | null;
/**
* The App Engine app IDs that can access this instance. First Generation instances only.
*/
authorizedGaeApplications?: string[] | null;
/**
* Availability type (PostgreSQL instances only). 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). For more information, see Overview of the High Availability Configuration.
*/
availabilityType?: string | null;
/**
* The daily backup configuration for the instance.
*/
backupConfiguration?: Schema$BackupConfiguration;
/**
* Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances.
*/
crashSafeReplicationEnabled?: boolean | null;
/**
* The database flags passed to the instance at startup.
*/
databaseFlags?: Schema$DatabaseFlags[];
/**
* Configuration specific to read replica instances. Indicates whether replication is enabled or not.
*/
databaseReplicationEnabled?: boolean | null;
/**
* The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances.
*/
dataDiskSizeGb?: string | null;
/**
* The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
*/
dataDiskType?: string | null;
/**
* The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
*/
ipConfiguration?: Schema$IpConfiguration;
/**
* This is always sql#settings.
*/
kind?: string | null;
/**
* The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location is only applicable to First Generation instances.
*/
locationPreference?: Schema$LocationPreference;
/**
* The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. Not used for First Generation instances.
*/
maintenanceWindow?: Schema$MaintenanceWindow;
/**
* The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
*/
pricingPlan?: string | null;
/**
* The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. This property is only applicable to First Generation instances.
*/
replicationType?: string | null;
/**
* The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
*/
settingsVersion?: string | null;
/**
* Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances.
*/
storageAutoResize?: boolean | null;
/**
* The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances.
*/
storageAutoResizeLimit?: string | null;
/**
* The tier (or machine type) for this instance, for example db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see Instance Settings.
*/
tier?: string | null;
/**
* User-provided labels, represented as a dictionary where each label is a single key value pair.
*/
userLabels?: {
[key: string]: string;
} | null;
}
/**
* SslCerts Resource
*/
export interface Schema$SslCert {
/**
* PEM representation.
*/
cert?: string | null;
/**
* Serial number, as extracted from the certificate.
*/
certSerialNumber?: string | null;
/**
* User supplied name. Constrained to [a-zA-Z.-_ ]+.
*/
commonName?: string | null;
/**
* The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z
*/
createTime?: string | null;
/**
* The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
*/
expirationTime?: string | null;
/**
* Name of the database instance.
*/
instance?: string | null;
/**
* This is always sql#sslCert.
*/
kind?: string | null;
/**
* The URI of this resource.
*/
selfLink?: string | null;
/**
* Sha1 Fingerprint.
*/
sha1Fingerprint?: string | null;
}
/**
* SslCertDetail.
*/
export interface Schema$SslCertDetail {
/**
* The public information about the cert.
*/
certInfo?: Schema$SslCert;
/**
* The private key for the client cert, in pem format. Keep private in order to protect your security.
*/
certPrivateKey?: string | null;
}
/**
* SslCerts create ephemeral certificate request.
*/
export interface Schema$SslCertsCreateEphemeralRequest {
/**
* PEM encoded public key to include in the signed certificate.
*/
public_key?: string | null;
}
/**
* SslCerts insert request.
*/
export interface Schema$SslCertsInsertRequest {
/**
* User supplied name. Must be a distinct name from the other certificates for this instance.
*/
commonName?: string | null;
}
/**
* SslCert insert response.
*/
export interface Schema$SslCertsInsertResponse {
/**
* The new client certificate and private key. For First Generation instances, the new certificate does not take effect until the instance is restarted.
*/
clientCert?: Schema$SslCertDetail;
/**
* This is always sql#sslCertsInsert.
*/
kind?: string | null;
/**
* The operation to track the ssl certs insert request.
*/
operation?: Schema$Operation;
/**
* The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource.
*/
serverCaCert?: Schema$SslCert;
}
/**
* SslCerts list response.
*/
export interface Schema$SslCertsListResponse {
/**
* List of client certificates for the instance.
*/
items?: Schema$SslCert[];
/**
* This is always sql#sslCertsList.
*/
kind?: string | null;
}
/**
* A Google Cloud SQL service tier resource.
*/
export interface Schema$Tier {
/**
* The maximum disk size of this tier in bytes.
*/
DiskQuota?: string | null;
/**
* This is always sql#tier.
*/
kind?: string | null;
/**
* The maximum RAM usage of this tier in bytes.
*/
RAM?: string | null;
/**
* The applicable regions for this tier.
*/
region?: string[] | null;
/**
* An identifier for the machine type, for example, db-n1-standard-1. For related information, see Pricing.
*/
tier?: string | null;
}
/**
* Tiers list response.
*/
export interface Schema$TiersListResponse {
/**
* List of tiers.
*/
items?: Schema$Tier[];
/**
* This is always sql#tiersList.
*/
kind?: string | null;
}
/**
* Database Instance truncate log context.
*/
export interface Schema$TruncateLogContext {
/**
* This is always sql#truncateLogContext.
*/
kind?: string | null;
/**
* The type of log to truncate. Valid values are MYSQL_GENERAL_TABLE and MYSQL_SLOW_TABLE.
*/
logType?: string | null;
}
/**
* A Cloud SQL user resource.
*/
export interface Schema$User {
/**
* This field is deprecated and will be removed from a future version of the API.
*/
etag?: string | null;
/**
* The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion.
*/
host?: string | null;
/**
* The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.
*/
instance?: string | null;
/**
* This is always sql#user.
*/
kind?: string | null;
/**
* The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified in the URL.
*/
name?: string | null;
/**
* The password for the user.
*/
password?: string | null;
/**
* The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.
*/
project?: string | null;
}
/**
* User list response.
*/
export interface Schema$UsersListResponse {
/**
* List of user resources in the instance.
*/
items?: Schema$User[];
/**
* This is always sql#usersList.
*/
kind?: string | null;
/**
* An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
*/
nextPageToken?: string | null;
}
export class Resource$Backupruns {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sql.backupRuns.delete
* @desc Deletes the backup taken by a backup run.
* @alias sql.backupRuns.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of the Backup Run to delete. To find a Backup Run ID, use the list method.
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Backupruns$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Backupruns$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Backupruns$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.backupRuns.get
* @desc Retrieves a resource containing information about a backup run.
* @alias sql.backupRuns.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The ID of this Backup Run.
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Backupruns$Get, options?: MethodOptions): GaxiosPromise<Schema$BackupRun>;
get(params: Params$Resource$Backupruns$Get, options: MethodOptions | BodyResponseCallback<Schema$BackupRun>, callback: BodyResponseCallback<Schema$BackupRun>): void;
get(params: Params$Resource$Backupruns$Get, callback: BodyResponseCallback<Schema$BackupRun>): void;
get(callback: BodyResponseCallback<Schema$BackupRun>): void;
/**
* sql.backupRuns.insert
* @desc Creates a new backup run on demand. This method is applicable only to Second Generation instances.
* @alias sql.backupRuns.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().BackupRun} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Backupruns$Insert, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
insert(params: Params$Resource$Backupruns$Insert, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
insert(params: Params$Resource$Backupruns$Insert, callback: BodyResponseCallback<Schema$Operation>): void;
insert(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.backupRuns.list
* @desc Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.
* @alias sql.backupRuns.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {integer=} params.maxResults Maximum number of backup runs per response.
* @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Backupruns$List, options?: MethodOptions): GaxiosPromise<Schema$BackupRunsListResponse>;
list(params: Params$Resource$Backupruns$List, options: MethodOptions | BodyResponseCallback<Schema$BackupRunsListResponse>, callback: BodyResponseCallback<Schema$BackupRunsListResponse>): void;
list(params: Params$Resource$Backupruns$List, callback: BodyResponseCallback<Schema$BackupRunsListResponse>): void;
list(callback: BodyResponseCallback<Schema$BackupRunsListResponse>): void;
}
export interface Params$Resource$Backupruns$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Backup Run to delete. To find a Backup Run ID, use the list method.
*/
id?: string;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Backupruns$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of this Backup Run.
*/
id?: string;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Backupruns$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BackupRun;
}
export interface Params$Resource$Backupruns$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Maximum number of backup runs per response.
*/
maxResults?: number;
/**
* A previously-returned page token representing part of the larger set of results to view.
*/
pageToken?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export class Resource$Databases {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sql.databases.delete
* @desc Deletes a database from a Cloud SQL instance.
* @alias sql.databases.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.database Name of the database to be deleted in the instance.
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Databases$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Databases$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Databases$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.databases.get
* @desc Retrieves a resource containing information about a database inside a Cloud SQL instance.
* @alias sql.databases.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.database Name of the database in the instance.
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Databases$Get, options?: MethodOptions): GaxiosPromise<Schema$Database>;
get(params: Params$Resource$Databases$Get, options: MethodOptions | BodyResponseCallback<Schema$Database>, callback: BodyResponseCallback<Schema$Database>): void;
get(params: Params$Resource$Databases$Get, callback: BodyResponseCallback<Schema$Database>): void;
get(callback: BodyResponseCallback<Schema$Database>): void;
/**
* sql.databases.insert
* @desc Inserts a resource containing information about a database inside a Cloud SQL instance.
* @alias sql.databases.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().Database} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Databases$Insert, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
insert(params: Params$Resource$Databases$Insert, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
insert(params: Params$Resource$Databases$Insert, callback: BodyResponseCallback<Schema$Operation>): void;
insert(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.databases.list
* @desc Lists databases in the specified Cloud SQL instance.
* @alias sql.databases.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Databases$List, options?: MethodOptions): GaxiosPromise<Schema$DatabasesListResponse>;
list(params: Params$Resource$Databases$List, options: MethodOptions | BodyResponseCallback<Schema$DatabasesListResponse>, callback: BodyResponseCallback<Schema$DatabasesListResponse>): void;
list(params: Params$Resource$Databases$List, callback: BodyResponseCallback<Schema$DatabasesListResponse>): void;
list(callback: BodyResponseCallback<Schema$DatabasesListResponse>): void;
/**
* sql.databases.patch
* @desc Updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.
* @alias sql.databases.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.database Name of the database to be updated in the instance.
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().Database} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Databases$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Databases$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Databases$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.databases.update
* @desc Updates a resource containing information about a database inside a Cloud SQL instance.
* @alias sql.databases.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.database Name of the database to be updated in the instance.
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().Database} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Databases$Update, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
update(params: Params$Resource$Databases$Update, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
update(params: Params$Resource$Databases$Update, callback: BodyResponseCallback<Schema$Operation>): void;
update(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Databases$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the database to be deleted in the instance.
*/
database?: string;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Databases$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the database in the instance.
*/
database?: string;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Databases$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Database;
}
export interface Params$Resource$Databases$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Databases$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the database to be updated in the instance.
*/
database?: string;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Database;
}
export interface Params$Resource$Databases$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the database to be updated in the instance.
*/
database?: string;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Database;
}
export class Resource$Flags {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sql.flags.list
* @desc List all available database flags for Cloud SQL instances.
* @alias sql.flags.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.databaseVersion Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Flags$List, options?: MethodOptions): GaxiosPromise<Schema$FlagsListResponse>;
list(params: Params$Resource$Flags$List, options: MethodOptions | BodyResponseCallback<Schema$FlagsListResponse>, callback: BodyResponseCallback<Schema$FlagsListResponse>): void;
list(params: Params$Resource$Flags$List, callback: BodyResponseCallback<Schema$FlagsListResponse>): void;
list(callback: BodyResponseCallback<Schema$FlagsListResponse>): void;
}
export interface Params$Resource$Flags$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
*/
databaseVersion?: string;
}
export class Resource$Instances {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sql.instances.addServerCa
* @desc Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.
* @alias sql.instances.addServerCa
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
addServerCa(params?: Params$Resource$Instances$Addserverca, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
addServerCa(params: Params$Resource$Instances$Addserverca, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
addServerCa(params: Params$Resource$Instances$Addserverca, callback: BodyResponseCallback<Schema$Operation>): void;
addServerCa(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.clone
* @desc Creates a Cloud SQL instance as a clone of the source instance.
* @alias sql.instances.clone
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
* @param {string} params.project Project ID of the source as well as the clone Cloud SQL instance.
* @param {().InstancesCloneRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
clone(params?: Params$Resource$Instances$Clone, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
clone(params: Params$Resource$Instances$Clone, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
clone(params: Params$Resource$Instances$Clone, callback: BodyResponseCallback<Schema$Operation>): void;
clone(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.delete
* @desc Deletes a Cloud SQL instance.
* @alias sql.instances.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance to be deleted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Instances$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Instances$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Instances$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.demoteMaster
* @desc Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
* @alias sql.instances.demoteMaster
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance name.
* @param {string} params.project ID of the project that contains the instance.
* @param {().InstancesDemoteMasterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
demoteMaster(params?: Params$Resource$Instances$Demotemaster, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
demoteMaster(params: Params$Resource$Instances$Demotemaster, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
demoteMaster(params: Params$Resource$Instances$Demotemaster, callback: BodyResponseCallback<Schema$Operation>): void;
demoteMaster(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.export
* @desc Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
* @alias sql.instances.export
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance to be exported.
* @param {().InstancesExportRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
export(params?: Params$Resource$Instances$Export, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
export(params: Params$Resource$Instances$Export, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
export(params: Params$Resource$Instances$Export, callback: BodyResponseCallback<Schema$Operation>): void;
export(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.failover
* @desc Failover the instance to its failover replica instance.
* @alias sql.instances.failover
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project ID of the project that contains the read replica.
* @param {().InstancesFailoverRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
failover(params?: Params$Resource$Instances$Failover, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
failover(params: Params$Resource$Instances$Failover, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
failover(params: Params$Resource$Instances$Failover, callback: BodyResponseCallback<Schema$Operation>): void;
failover(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.get
* @desc Retrieves a resource containing information about a Cloud SQL instance.
* @alias sql.instances.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Instances$Get, options?: MethodOptions): GaxiosPromise<Schema$DatabaseInstance>;
get(params: Params$Resource$Instances$Get, options: MethodOptions | BodyResponseCallback<Schema$DatabaseInstance>, callback: BodyResponseCallback<Schema$DatabaseInstance>): void;
get(params: Params$Resource$Instances$Get, callback: BodyResponseCallback<Schema$DatabaseInstance>): void;
get(callback: BodyResponseCallback<Schema$DatabaseInstance>): void;
/**
* sql.instances.import
* @desc Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.
* @alias sql.instances.import
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().InstancesImportRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
import(params?: Params$Resource$Instances$Import, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
import(params: Params$Resource$Instances$Import, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
import(params: Params$Resource$Instances$Import, callback: BodyResponseCallback<Schema$Operation>): void;
import(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.insert
* @desc Creates a new Cloud SQL instance.
* @alias sql.instances.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.project Project ID of the project to which the newly created Cloud SQL instances should belong.
* @param {().DatabaseInstance} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Instances$Insert, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
insert(params: Params$Resource$Instances$Insert, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
insert(params: Params$Resource$Instances$Insert, callback: BodyResponseCallback<Schema$Operation>): void;
insert(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.list
* @desc Lists instances under a given project in the alphabetical order of the instance name.
* @alias sql.instances.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter An expression for filtering the results of the request, such as by name or label.
* @param {integer=} params.maxResults The maximum number of results to return per response.
* @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view.
* @param {string} params.project Project ID of the project for which to list Cloud SQL instances.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Instances$List, options?: MethodOptions): GaxiosPromise<Schema$InstancesListResponse>;
list(params: Params$Resource$Instances$List, options: MethodOptions | BodyResponseCallback<Schema$InstancesListResponse>, callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
list(params: Params$Resource$Instances$List, callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
list(callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
/**
* sql.instances.listServerCas
* @desc Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.
* @alias sql.instances.listServerCas
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
listServerCas(params?: Params$Resource$Instances$Listservercas, options?: MethodOptions): GaxiosPromise<Schema$InstancesListServerCasResponse>;
listServerCas(params: Params$Resource$Instances$Listservercas, options: MethodOptions | BodyResponseCallback<Schema$InstancesListServerCasResponse>, callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
listServerCas(params: Params$Resource$Instances$Listservercas, callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
listServerCas(callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
/**
* sql.instances.patch
* @desc Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics.
* @alias sql.instances.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().DatabaseInstance} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Instances$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Instances$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Instances$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.promoteReplica
* @desc Promotes the read replica instance to be a stand-alone Cloud SQL instance.
* @alias sql.instances.promoteReplica
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL read replica instance name.
* @param {string} params.project ID of the project that contains the read replica.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
promoteReplica(params?: Params$Resource$Instances$Promotereplica, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
promoteReplica(params: Params$Resource$Instances$Promotereplica, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
promoteReplica(params: Params$Resource$Instances$Promotereplica, callback: BodyResponseCallback<Schema$Operation>): void;
promoteReplica(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.resetSslConfig
* @desc Deletes all client certificates and generates a new server SSL certificate for the instance.
* @alias sql.instances.resetSslConfig
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
resetSslConfig(params?: Params$Resource$Instances$Resetsslconfig, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
resetSslConfig(params: Params$Resource$Instances$Resetsslconfig, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
resetSslConfig(params: Params$Resource$Instances$Resetsslconfig, callback: BodyResponseCallback<Schema$Operation>): void;
resetSslConfig(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.restart
* @desc Restarts a Cloud SQL instance.
* @alias sql.instances.restart
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance to be restarted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
restart(params?: Params$Resource$Instances$Restart, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
restart(params: Params$Resource$Instances$Restart, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
restart(params: Params$Resource$Instances$Restart, callback: BodyResponseCallback<Schema$Operation>): void;
restart(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.restoreBackup
* @desc Restores a backup of a Cloud SQL instance.
* @alias sql.instances.restoreBackup
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().InstancesRestoreBackupRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
restoreBackup(params?: Params$Resource$Instances$Restorebackup, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
restoreBackup(params: Params$Resource$Instances$Restorebackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
restoreBackup(params: Params$Resource$Instances$Restorebackup, callback: BodyResponseCallback<Schema$Operation>): void;
restoreBackup(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.rotateServerCa
* @desc Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
* @alias sql.instances.rotateServerCa
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().InstancesRotateServerCaRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
rotateServerCa(params?: Params$Resource$Instances$Rotateserverca, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
rotateServerCa(params: Params$Resource$Instances$Rotateserverca, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
rotateServerCa(params: Params$Resource$Instances$Rotateserverca, callback: BodyResponseCallback<Schema$Operation>): void;
rotateServerCa(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.startReplica
* @desc Starts the replication in the read replica instance.
* @alias sql.instances.startReplica
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL read replica instance name.
* @param {string} params.project ID of the project that contains the read replica.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
startReplica(params?: Params$Resource$Instances$Startreplica, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
startReplica(params: Params$Resource$Instances$Startreplica, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
startReplica(params: Params$Resource$Instances$Startreplica, callback: BodyResponseCallback<Schema$Operation>): void;
startReplica(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.stopReplica
* @desc Stops the replication in the read replica instance.
* @alias sql.instances.stopReplica
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL read replica instance name.
* @param {string} params.project ID of the project that contains the read replica.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
stopReplica(params?: Params$Resource$Instances$Stopreplica, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
stopReplica(params: Params$Resource$Instances$Stopreplica, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
stopReplica(params: Params$Resource$Instances$Stopreplica, callback: BodyResponseCallback<Schema$Operation>): void;
stopReplica(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.truncateLog
* @desc Truncate MySQL general and slow query log tables
* @alias sql.instances.truncateLog
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the Cloud SQL project.
* @param {().InstancesTruncateLogRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
truncateLog(params?: Params$Resource$Instances$Truncatelog, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
truncateLog(params: Params$Resource$Instances$Truncatelog, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
truncateLog(params: Params$Resource$Instances$Truncatelog, callback: BodyResponseCallback<Schema$Operation>): void;
truncateLog(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.instances.update
* @desc Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.
* @alias sql.instances.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().DatabaseInstance} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Instances$Update, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
update(params: Params$Resource$Instances$Update, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
update(params: Params$Resource$Instances$Update, callback: BodyResponseCallback<Schema$Operation>): void;
update(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Instances$Addserverca extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Instances$Clone extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the source as well as the clone Cloud SQL instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InstancesCloneRequest;
}
export interface Params$Resource$Instances$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance to be deleted.
*/
project?: string;
}
export interface Params$Resource$Instances$Demotemaster extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance name.
*/
instance?: string;
/**
* ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InstancesDemoteMasterRequest;
}
export interface Params$Resource$Instances$Export extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance to be exported.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InstancesExportRequest;
}
export interface Params$Resource$Instances$Failover extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* ID of the project that contains the read replica.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InstancesFailoverRequest;
}
export interface Params$Resource$Instances$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Instances$Import extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InstancesImportRequest;
}
export interface Params$Resource$Instances$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Project ID of the project to which the newly created Cloud SQL instances should belong.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DatabaseInstance;
}
export interface Params$Resource$Instances$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* An expression for filtering the results of the request, such as by name or label.
*/
filter?: string;
/**
* The maximum number of results to return per response.
*/
maxResults?: number;
/**
* A previously-returned page token representing part of the larger set of results to view.
*/
pageToken?: string;
/**
* Project ID of the project for which to list Cloud SQL instances.
*/
project?: string;
}
export interface Params$Resource$Instances$Listservercas extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Instances$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DatabaseInstance;
}
export interface Params$Resource$Instances$Promotereplica extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL read replica instance name.
*/
instance?: string;
/**
* ID of the project that contains the read replica.
*/
project?: string;
}
export interface Params$Resource$Instances$Resetsslconfig extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Instances$Restart extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance to be restarted.
*/
project?: string;
}
export interface Params$Resource$Instances$Restorebackup extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InstancesRestoreBackupRequest;
}
export interface Params$Resource$Instances$Rotateserverca extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InstancesRotateServerCaRequest;
}
export interface Params$Resource$Instances$Startreplica extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL read replica instance name.
*/
instance?: string;
/**
* ID of the project that contains the read replica.
*/
project?: string;
}
export interface Params$Resource$Instances$Stopreplica extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL read replica instance name.
*/
instance?: string;
/**
* ID of the project that contains the read replica.
*/
project?: string;
}
export interface Params$Resource$Instances$Truncatelog extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the Cloud SQL project.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InstancesTruncateLogRequest;
}
export interface Params$Resource$Instances$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DatabaseInstance;
}
export class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sql.operations.get
* @desc Retrieves an instance operation that has been performed on an instance.
* @alias sql.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.operation Instance operation ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.operations.list
* @desc Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.
* @alias sql.operations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {integer=} params.maxResults Maximum number of operations per response.
* @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$OperationsListResponse>;
list(params: Params$Resource$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$OperationsListResponse>, callback: BodyResponseCallback<Schema$OperationsListResponse>): void;
list(params: Params$Resource$Operations$List, callback: BodyResponseCallback<Schema$OperationsListResponse>): void;
list(callback: BodyResponseCallback<Schema$OperationsListResponse>): void;
}
export interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Instance operation ID.
*/
operation?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Operations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Maximum number of operations per response.
*/
maxResults?: number;
/**
* A previously-returned page token representing part of the larger set of results to view.
*/
pageToken?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export class Resource$Sslcerts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sql.sslCerts.createEphemeral
* @desc Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
* @alias sql.sslCerts.createEphemeral
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the Cloud SQL project.
* @param {().SslCertsCreateEphemeralRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
createEphemeral(params?: Params$Resource$Sslcerts$Createephemeral, options?: MethodOptions): GaxiosPromise<Schema$SslCert>;
createEphemeral(params: Params$Resource$Sslcerts$Createephemeral, options: MethodOptions | BodyResponseCallback<Schema$SslCert>, callback: BodyResponseCallback<Schema$SslCert>): void;
createEphemeral(params: Params$Resource$Sslcerts$Createephemeral, callback: BodyResponseCallback<Schema$SslCert>): void;
createEphemeral(callback: BodyResponseCallback<Schema$SslCert>): void;
/**
* sql.sslCerts.delete
* @desc Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.
* @alias sql.sslCerts.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {string} params.sha1Fingerprint Sha1 FingerPrint.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Sslcerts$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Sslcerts$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Sslcerts$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.sslCerts.get
* @desc Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.
* @alias sql.sslCerts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {string} params.sha1Fingerprint Sha1 FingerPrint.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Sslcerts$Get, options?: MethodOptions): GaxiosPromise<Schema$SslCert>;
get(params: Params$Resource$Sslcerts$Get, options: MethodOptions | BodyResponseCallback<Schema$SslCert>, callback: BodyResponseCallback<Schema$SslCert>): void;
get(params: Params$Resource$Sslcerts$Get, callback: BodyResponseCallback<Schema$SslCert>): void;
get(callback: BodyResponseCallback<Schema$SslCert>): void;
/**
* sql.sslCerts.insert
* @desc Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.
* @alias sql.sslCerts.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().SslCertsInsertRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Sslcerts$Insert, options?: MethodOptions): GaxiosPromise<Schema$SslCertsInsertResponse>;
insert(params: Params$Resource$Sslcerts$Insert, options: MethodOptions | BodyResponseCallback<Schema$SslCertsInsertResponse>, callback: BodyResponseCallback<Schema$SslCertsInsertResponse>): void;
insert(params: Params$Resource$Sslcerts$Insert, callback: BodyResponseCallback<Schema$SslCertsInsertResponse>): void;
insert(callback: BodyResponseCallback<Schema$SslCertsInsertResponse>): void;
/**
* sql.sslCerts.list
* @desc Lists all of the current SSL certificates for the instance.
* @alias sql.sslCerts.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Cloud SQL instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Sslcerts$List, options?: MethodOptions): GaxiosPromise<Schema$SslCertsListResponse>;
list(params: Params$Resource$Sslcerts$List, options: MethodOptions | BodyResponseCallback<Schema$SslCertsListResponse>, callback: BodyResponseCallback<Schema$SslCertsListResponse>): void;
list(params: Params$Resource$Sslcerts$List, callback: BodyResponseCallback<Schema$SslCertsListResponse>): void;
list(callback: BodyResponseCallback<Schema$SslCertsListResponse>): void;
}
export interface Params$Resource$Sslcerts$Createephemeral extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the Cloud SQL project.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SslCertsCreateEphemeralRequest;
}
export interface Params$Resource$Sslcerts$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Sha1 FingerPrint.
*/
sha1Fingerprint?: string;
}
export interface Params$Resource$Sslcerts$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Sha1 FingerPrint.
*/
sha1Fingerprint?: string;
}
export interface Params$Resource$Sslcerts$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SslCertsInsertRequest;
}
export interface Params$Resource$Sslcerts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export class Resource$Tiers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sql.tiers.list
* @desc Lists all available machine types (tiers) for Cloud SQL, for example, db-n1-standard-1. For related information, see Pricing.
* @alias sql.tiers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.project Project ID of the project for which to list tiers.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Tiers$List, options?: MethodOptions): GaxiosPromise<Schema$TiersListResponse>;
list(params: Params$Resource$Tiers$List, options: MethodOptions | BodyResponseCallback<Schema$TiersListResponse>, callback: BodyResponseCallback<Schema$TiersListResponse>): void;
list(params: Params$Resource$Tiers$List, callback: BodyResponseCallback<Schema$TiersListResponse>): void;
list(callback: BodyResponseCallback<Schema$TiersListResponse>): void;
}
export interface Params$Resource$Tiers$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Project ID of the project for which to list tiers.
*/
project?: string;
}
export class Resource$Users {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sql.users.delete
* @desc Deletes a user from a Cloud SQL instance.
* @alias sql.users.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.host Host of the user in the instance.
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.name Name of the user in the instance.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Users$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Users$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Users$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.users.insert
* @desc Creates a new user in a Cloud SQL instance.
* @alias sql.users.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().User} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Users$Insert, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
insert(params: Params$Resource$Users$Insert, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
insert(params: Params$Resource$Users$Insert, callback: BodyResponseCallback<Schema$Operation>): void;
insert(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* sql.users.list
* @desc Lists users in the specified Cloud SQL instance.
* @alias sql.users.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Users$List, options?: MethodOptions): GaxiosPromise<Schema$UsersListResponse>;
list(params: Params$Resource$Users$List, options: MethodOptions | BodyResponseCallback<Schema$UsersListResponse>, callback: BodyResponseCallback<Schema$UsersListResponse>): void;
list(params: Params$Resource$Users$List, callback: BodyResponseCallback<Schema$UsersListResponse>): void;
list(callback: BodyResponseCallback<Schema$UsersListResponse>): void;
/**
* sql.users.update
* @desc Updates an existing user in a Cloud SQL instance.
* @alias sql.users.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.host Host of the user in the instance. For a MySQL instance, it's required; For a PostgreSQL instance, it's optional.
* @param {string} params.instance Database instance ID. This does not include the project ID.
* @param {string} params.name Name of the user in the instance.
* @param {string} params.project Project ID of the project that contains the instance.
* @param {().User} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Users$Update, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
update(params: Params$Resource$Users$Update, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
update(params: Params$Resource$Users$Update, callback: BodyResponseCallback<Schema$Operation>): void;
update(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Users$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Host of the user in the instance.
*/
host?: string;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Name of the user in the instance.
*/
name?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Users$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$User;
}
export interface Params$Resource$Users$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
}
export interface Params$Resource$Users$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Host of the user in the instance. For a MySQL instance, it's required; For a PostgreSQL instance, it's optional.
*/
host?: string;
/**
* Database instance ID. This does not include the project ID.
*/
instance?: string;
/**
* Name of the user in the instance.
*/
name?: string;
/**
* Project ID of the project that contains the instance.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$User;
}
export {};
}