v1.d.ts
156 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
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
/**
* 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 { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace appengine_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: 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;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* App Engine Admin API
*
* Provisions and manages developers' App Engine applications.
*
* @example
* const {google} = require('googleapis');
* const appengine = google.appengine('v1');
*
* @namespace appengine
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Appengine
*/
class Appengine {
context: APIRequestContext;
apps: Resource$Apps;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Google Cloud Endpoints
* (https://cloud.google.com/appengine/docs/python/endpoints/) configuration
* for API handlers.
*/
interface Schema$ApiConfigHandler {
/**
* Action to take when users access resources that require authentication.
* Defaults to redirect.
*/
authFailAction?: string;
/**
* Level of login required to access this resource. Defaults to optional.
*/
login?: string;
/**
* Path to the script from the application root directory.
*/
script?: string;
/**
* Security (HTTPS) enforcement for this URL.
*/
securityLevel?: string;
/**
* URL to serve the endpoint at.
*/
url?: string;
}
/**
* Uses Google Cloud Endpoints to handle requests.
*/
interface Schema$ApiEndpointHandler {
/**
* Path to the script from the application root directory.
*/
scriptPath?: string;
}
/**
* An Application resource contains the top-level configuration of an App
* Engine application.
*/
interface Schema$Application {
/**
* Google Apps authentication domain that controls which users can access
* this application.Defaults to open access for any Google Account.
*/
authDomain?: string;
/**
* Google Cloud Storage bucket that can be used for storing files associated
* with this application. This bucket is associated with the application and
* can be used by the gcloud deployment commands.@OutputOnly
*/
codeBucket?: string;
/**
* Google Cloud Storage bucket that can be used by this application to store
* content.@OutputOnly
*/
defaultBucket?: string;
/**
* Cookie expiration policy for this application.
*/
defaultCookieExpiration?: string;
/**
* Hostname used to reach this application, as resolved by App
* Engine.@OutputOnly
*/
defaultHostname?: string;
/**
* HTTP path dispatch rules for requests to the application that do not
* explicitly target a service or version. Rules are order-dependent. Up to
* 20 dispatch rules can be supported.
*/
dispatchRules?: Schema$UrlDispatchRule[];
/**
* The feature specific settings to be used in the application.
*/
featureSettings?: Schema$FeatureSettings;
/**
* The Google Container Registry domain used for storing managed build
* docker images for this application.
*/
gcrDomain?: string;
iap?: Schema$IdentityAwareProxy;
/**
* Identifier of the Application resource. This identifier is equivalent to
* the project ID of the Google Cloud Platform project where you want to
* deploy your application. Example: myapp.
*/
id?: string;
/**
* Location from which this application runs. Application instances run out
* of the data centers in the specified location, which is also where all of
* the application's end user content is stored.Defaults to
* us-central.View the list of supported locations
* (https://cloud.google.com/appengine/docs/locations).
*/
locationId?: string;
/**
* Full path to the Application resource in the API. Example:
* apps/myapp.@OutputOnly
*/
name?: string;
/**
* Serving status of this application.
*/
servingStatus?: string;
}
/**
* An SSL certificate that a user has been authorized to administer. A user is
* authorized to administer any certificate that applies to one of their
* authorized domains.
*/
interface Schema$AuthorizedCertificate {
/**
* The SSL certificate serving the AuthorizedCertificate resource. This must
* be obtained independently from a certificate authority.
*/
certificateRawData?: Schema$CertificateRawData;
/**
* The user-specified display name of the certificate. This is not
* guaranteed to be unique. Example: My Certificate.
*/
displayName?: string;
/**
* Aggregate count of the domain mappings with this certificate mapped. This
* count includes domain mappings on applications for which the user does
* not have VIEWER permissions.Only returned by GET or LIST requests when
* specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
domainMappingsCount?: number;
/**
* Topmost applicable domains of this certificate. This certificate applies
* to these domains and their subdomains. Example: example.com.@OutputOnly
*/
domainNames?: string[];
/**
* The time when this certificate expires. To update the renewal time on
* this certificate, upload an SSL certificate with a different expiration
* time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
*/
expireTime?: string;
/**
* Relative name of the certificate. This is a unique value autogenerated on
* AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
*/
id?: string;
/**
* Only applicable if this certificate is managed by App Engine. Managed
* certificates are tied to the lifecycle of a DomainMapping and cannot be
* updated or deleted via the AuthorizedCertificates API. If this
* certificate is manually administered by the user, this field will be
* empty.@OutputOnly
*/
managedCertificate?: Schema$ManagedCertificate;
/**
* Full path to the AuthorizedCertificate resource in the API. Example:
* apps/myapp/authorizedCertificates/12345.@OutputOnly
*/
name?: string;
/**
* The full paths to user visible Domain Mapping resources that have this
* certificate mapped. Example: apps/myapp/domainMappings/example.com.This
* may not represent the full list of mapped domain mappings if the user
* does not have VIEWER permissions on all of the applications that have
* this certificate mapped. See domain_mappings_count for a complete
* count.Only returned by GET or LIST requests when specifically requested
* by the view=FULL_CERTIFICATE option.@OutputOnly
*/
visibleDomainMappings?: string[];
}
/**
* A domain that a user has been authorized to administer. To authorize use of
* a domain, verify ownership via Webmaster Central
* (https://www.google.com/webmasters/verification/home).
*/
interface Schema$AuthorizedDomain {
/**
* Fully qualified domain name of the domain authorized for use. Example:
* example.com.
*/
id?: string;
/**
* Full path to the AuthorizedDomain resource in the API. Example:
* apps/myapp/authorizedDomains/example.com.@OutputOnly
*/
name?: string;
}
/**
* Automatic scaling is based on request rate, response latencies, and other
* application metrics.
*/
interface Schema$AutomaticScaling {
/**
* The time period that the Autoscaler
* (https://cloud.google.com/compute/docs/autoscaler/) should wait before it
* starts collecting information from a new instance. This prevents the
* autoscaler from collecting information when the instance is initializing,
* during which the collected usage would not be reliable. Only applicable
* in the App Engine flexible environment.
*/
coolDownPeriod?: string;
/**
* Target scaling by CPU usage.
*/
cpuUtilization?: Schema$CpuUtilization;
/**
* Target scaling by disk usage.
*/
diskUtilization?: Schema$DiskUtilization;
/**
* Number of concurrent requests an automatic scaling instance can accept
* before the scheduler spawns a new instance.Defaults to a runtime-specific
* value.
*/
maxConcurrentRequests?: number;
/**
* Maximum number of idle instances that should be maintained for this
* version.
*/
maxIdleInstances?: number;
/**
* Maximum amount of time that a request should wait in the pending queue
* before starting a new instance to handle it.
*/
maxPendingLatency?: string;
/**
* Maximum number of instances that should be started to handle requests for
* this version.
*/
maxTotalInstances?: number;
/**
* Minimum number of idle instances that should be maintained for this
* version. Only applicable for the default version of a service.
*/
minIdleInstances?: number;
/**
* Minimum amount of time a request should wait in the pending queue before
* starting a new instance to handle it.
*/
minPendingLatency?: string;
/**
* Minimum number of running instances that should be maintained for this
* version.
*/
minTotalInstances?: number;
/**
* Target scaling by network usage.
*/
networkUtilization?: Schema$NetworkUtilization;
/**
* Target scaling by request utilization.
*/
requestUtilization?: Schema$RequestUtilization;
/**
* Scheduler settings for standard environment.
*/
standardSchedulerSettings?: Schema$StandardSchedulerSettings;
}
/**
* A service with basic scaling will create an instance when the application
* receives a request. The instance will be turned down when the app becomes
* idle. Basic scaling is ideal for work that is intermittent or driven by
* user activity.
*/
interface Schema$BasicScaling {
/**
* Duration of time after the last request that an instance must wait before
* the instance is shut down.
*/
idleTimeout?: string;
/**
* Maximum number of instances to create for this version.
*/
maxInstances?: number;
}
/**
* Request message for Firewall.BatchUpdateIngressRules.
*/
interface Schema$BatchUpdateIngressRulesRequest {
/**
* A list of FirewallRules to replace the existing set.
*/
ingressRules?: Schema$FirewallRule[];
}
/**
* Response message for Firewall.UpdateAllIngressRules.
*/
interface Schema$BatchUpdateIngressRulesResponse {
/**
* The full list of ingress FirewallRules for this application.
*/
ingressRules?: Schema$FirewallRule[];
}
/**
* An SSL certificate obtained from a certificate authority.
*/
interface Schema$CertificateRawData {
/**
* Unencrypted PEM encoded RSA private key. This field is set once on
* certificate creation and then encrypted. The key size must be 2048 bits
* or fewer. Must include the header and footer. Example: <pre>
* -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END
* RSA PRIVATE KEY----- </pre> @InputOnly
*/
privateKey?: string;
/**
* PEM encoded x.509 public key certificate. This field is set once on
* certificate creation. Must include the header and footer. Example:
* <pre> -----BEGIN CERTIFICATE----- <certificate_value>
* -----END CERTIFICATE----- </pre>
*/
publicCertificate?: string;
}
/**
* Options for the build operations performed as a part of the version
* deployment. Only applicable for App Engine flexible environment when
* creating a version using source code directly.
*/
interface Schema$CloudBuildOptions {
/**
* Path to the yaml file used in deployment, used to determine runtime
* configuration details.Required for flexible environment builds.See
* https://cloud.google.com/appengine/docs/standard/python/config/appref for
* more details.
*/
appYamlPath?: string;
/**
* The Cloud Build timeout used as part of any dependent builds performed by
* version creation. Defaults to 10 minutes.
*/
cloudBuildTimeout?: string;
}
/**
* Docker image that is used to create a container and start a VM instance for
* the version that you deploy. Only applicable for instances running in the
* App Engine flexible environment.
*/
interface Schema$ContainerInfo {
/**
* URI to the hosted container image in Google Container Registry. The URI
* must be fully qualified and include a tag or digest. Examples:
* "gcr.io/my-project/image:tag" or
* "gcr.io/my-project/image@digest"
*/
image?: string;
}
/**
* Target scaling by CPU usage.
*/
interface Schema$CpuUtilization {
/**
* Period of time over which CPU utilization is calculated.
*/
aggregationWindowLength?: string;
/**
* Target CPU utilization ratio to maintain when scaling. Must be between 0
* and 1.
*/
targetUtilization?: number;
}
/**
* Metadata for the given google.longrunning.Operation during a
* google.appengine.v1.CreateVersionRequest.
*/
interface Schema$CreateVersionMetadataV1 {
/**
* The Cloud Build ID if one was created as part of the version create.
* @OutputOnly
*/
cloudBuildId?: string;
}
/**
* Metadata for the given google.longrunning.Operation during a
* google.appengine.v1alpha.CreateVersionRequest.
*/
interface Schema$CreateVersionMetadataV1Alpha {
/**
* The Cloud Build ID if one was created as part of the version create.
* @OutputOnly
*/
cloudBuildId?: string;
}
/**
* Metadata for the given google.longrunning.Operation during a
* google.appengine.v1beta.CreateVersionRequest.
*/
interface Schema$CreateVersionMetadataV1Beta {
/**
* The Cloud Build ID if one was created as part of the version create.
* @OutputOnly
*/
cloudBuildId?: string;
}
/**
* Request message for Instances.DebugInstance.
*/
interface Schema$DebugInstanceRequest {
/**
* Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa
* [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh
* {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For
* more information, see Adding and Removing SSH Keys
* (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
*/
sshKey?: string;
}
/**
* Code and application artifacts used to deploy a version to App Engine.
*/
interface Schema$Deployment {
/**
* Options for any Google Cloud Build builds created as a part of this
* deployment.These options will only be used if a new build is created,
* such as when deploying to the App Engine flexible environment using files
* or zip.
*/
cloudBuildOptions?: Schema$CloudBuildOptions;
/**
* The Docker image for the container that runs the version. Only applicable
* for instances running in the App Engine flexible environment.
*/
container?: Schema$ContainerInfo;
/**
* Manifest of the files stored in Google Cloud Storage that are included as
* part of this version. All files must be readable using the credentials
* supplied with this call.
*/
files?: {
[key: string]: Schema$FileInfo;
};
/**
* The zip file for this deployment, if this is a zip deployment.
*/
zip?: Schema$ZipInfo;
}
/**
* Target scaling by disk usage. Only applicable in the App Engine flexible
* environment.
*/
interface Schema$DiskUtilization {
/**
* Target bytes read per second.
*/
targetReadBytesPerSecond?: number;
/**
* Target ops read per seconds.
*/
targetReadOpsPerSecond?: number;
/**
* Target bytes written per second.
*/
targetWriteBytesPerSecond?: number;
/**
* Target ops written per second.
*/
targetWriteOpsPerSecond?: number;
}
/**
* A domain serving an App Engine application.
*/
interface Schema$DomainMapping {
/**
* Relative name of the domain serving the application. Example:
* example.com.
*/
id?: string;
/**
* Full path to the DomainMapping resource in the API. Example:
* apps/myapp/domainMapping/example.com.@OutputOnly
*/
name?: string;
/**
* The resource records required to configure this domain mapping. These
* records must be added to the domain's DNS configuration in order to
* serve the application via this domain mapping.@OutputOnly
*/
resourceRecords?: Schema$ResourceRecord[];
/**
* SSL configuration for this domain. If unconfigured, this domain will not
* serve with SSL.
*/
sslSettings?: Schema$SslSettings;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for Empty is empty JSON object {}.
*/
interface Schema$Empty {
}
/**
* Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The
* Endpoints API Service provides tooling for serving Open API and gRPC
* endpoints via an NGINX proxy. Only valid for App Engine Flexible
* environment deployments.The fields here refer to the name and configuration
* ID of a "service" resource in the Service Management API
* (https://cloud.google.com/service-management/overview).
*/
interface Schema$EndpointsApiService {
/**
* Endpoints service configuration ID as specified by the Service Management
* API. For example "2016-09-19r1".By default, the rollout
* strategy for Endpoints is RolloutStrategy.FIXED. This means that
* Endpoints starts up with a particular configuration ID. When a new
* configuration is rolled out, Endpoints must be given the new
* configuration ID. The config_id field is used to give the configuration
* ID and is required in this case.Endpoints also has a rollout strategy
* called RolloutStrategy.MANAGED. When using this, Endpoints fetches the
* latest configuration and does not need the configuration ID. In this
* case, config_id must be omitted.
*/
configId?: string;
/**
* Enable or disable trace sampling. By default, this is set to false for
* enabled.
*/
disableTraceSampling?: boolean;
/**
* Endpoints service name which is the name of the "service"
* resource in the Service Management API. For example
* "myapi.endpoints.myproject.cloud.goog"
*/
name?: string;
/**
* Endpoints rollout strategy. If FIXED, config_id must be specified. If
* MANAGED, config_id must be omitted.
*/
rolloutStrategy?: string;
}
/**
* The entrypoint for the application.
*/
interface Schema$Entrypoint {
/**
* The format should be a shell command that can be fed to bash -c.
*/
shell?: string;
}
/**
* Custom static error page to be served when an error occurs.
*/
interface Schema$ErrorHandler {
/**
* Error condition this handler applies to.
*/
errorCode?: string;
/**
* MIME type of file. Defaults to text/html.
*/
mimeType?: string;
/**
* Static file content to be served for this error.
*/
staticFile?: string;
}
/**
* The feature specific settings to be used in the application. These define
* behaviors that are user configurable.
*/
interface Schema$FeatureSettings {
/**
* Boolean value indicating if split health checks should be used instead of
* the legacy health checks. At an app.yaml level, this means defaulting to
* 'readiness_check' and 'liveness_check' values instead of
* 'health_check' ones. Once the legacy 'health_check'
* behavior is deprecated, and this value is always true, this setting can
* be removed.
*/
splitHealthChecks?: boolean;
/**
* If true, use Container-Optimized OS
* (https://cloud.google.com/container-optimized-os/) base image for VMs,
* rather than a base Debian image.
*/
useContainerOptimizedOs?: boolean;
}
/**
* Single source file that is part of the version to be deployed. Each source
* file that is deployed must be specified separately.
*/
interface Schema$FileInfo {
/**
* The MIME type of the file.Defaults to the value from Google Cloud
* Storage.
*/
mimeType?: string;
/**
* The SHA1 hash of the file, in hex.
*/
sha1Sum?: string;
/**
* URL source to use to fetch this file. Must be a URL to a resource in
* Google Cloud Storage in the form
* 'http(s)://storage.googleapis.com/<bucket>/<object>'.
*/
sourceUrl?: string;
}
/**
* A single firewall rule that is evaluated against incoming traffic and
* provides an action to take on matched requests.
*/
interface Schema$FirewallRule {
/**
* The action to take on matched requests.
*/
action?: string;
/**
* An optional string description of this rule. This field has a maximum
* length of 100 characters.
*/
description?: string;
/**
* A positive integer between 1, Int32.MaxValue-1 that defines the order of
* rule evaluation. Rules with the lowest priority are evaluated first.A
* default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic
* when no previous rule matches. Only the action of this rule can be
* modified by the user.
*/
priority?: number;
/**
* IP address or range, defined using CIDR notation, of requests that this
* rule applies to. You can use the wildcard character "*" to
* match all IPs equivalent to "0/0" and "::/0"
* together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or
* 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be
* silently performed on addresses which are not properly truncated. For
* example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24.
* Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as
* 2001:db8::/32.
*/
sourceRange?: string;
}
/**
* Health checking configuration for VM instances. Unhealthy instances are
* killed and replaced with new instances. Only applicable for instances in
* App Engine flexible environment.
*/
interface Schema$HealthCheck {
/**
* Interval between health checks.
*/
checkInterval?: string;
/**
* Whether to explicitly disable health checks for this instance.
*/
disableHealthCheck?: boolean;
/**
* Number of consecutive successful health checks required before receiving
* traffic.
*/
healthyThreshold?: number;
/**
* Host header to send when performing an HTTP health check. Example:
* "myapp.appspot.com"
*/
host?: string;
/**
* Number of consecutive failed health checks required before an instance is
* restarted.
*/
restartThreshold?: number;
/**
* Time before the health check is considered failed.
*/
timeout?: string;
/**
* Number of consecutive failed health checks required before removing
* traffic.
*/
unhealthyThreshold?: number;
}
/**
* Identity-Aware Proxy
*/
interface Schema$IdentityAwareProxy {
/**
* Whether the serving infrastructure will authenticate and authorize all
* incoming requests.If true, the oauth2_client_id and oauth2_client_secret
* fields must be non-empty.
*/
enabled?: boolean;
/**
* OAuth2 client ID to use for the authentication flow.
*/
oauth2ClientId?: string;
/**
* OAuth2 client secret to use for the authentication flow.For security
* reasons, this value cannot be retrieved via the API. Instead, the SHA-256
* hash of the value is returned in the oauth2_client_secret_sha256
* field.@InputOnly
*/
oauth2ClientSecret?: string;
/**
* Hex-encoded SHA-256 hash of the client secret.@OutputOnly
*/
oauth2ClientSecretSha256?: string;
}
/**
* An Instance resource is the computing unit that App Engine uses to
* automatically scale an application.
*/
interface Schema$Instance {
/**
* App Engine release this instance is running on.@OutputOnly
*/
appEngineRelease?: string;
/**
* Availability of the instance.@OutputOnly
*/
availability?: string;
/**
* Average latency (ms) over the last minute.@OutputOnly
*/
averageLatency?: number;
/**
* Number of errors since this instance was started.@OutputOnly
*/
errors?: number;
/**
* Relative name of the instance within the version. Example:
* instance-1.@OutputOnly
*/
id?: string;
/**
* Total memory in use (bytes).@OutputOnly
*/
memoryUsage?: string;
/**
* Full path to the Instance resource in the API. Example:
* apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly
*/
name?: string;
/**
* Average queries per second (QPS) over the last minute.@OutputOnly
*/
qps?: number;
/**
* Number of requests since this instance was started.@OutputOnly
*/
requests?: number;
/**
* Time that this instance was started.@OutputOnly
*/
startTime?: string;
/**
* Whether this instance is in debug mode. Only applicable for instances in
* App Engine flexible environment.@OutputOnly
*/
vmDebugEnabled?: boolean;
/**
* Virtual machine ID of this instance. Only applicable for instances in App
* Engine flexible environment.@OutputOnly
*/
vmId?: string;
/**
* The IP address of this instance. Only applicable for instances in App
* Engine flexible environment.@OutputOnly
*/
vmIp?: string;
/**
* Name of the virtual machine where this instance lives. Only applicable
* for instances in App Engine flexible environment.@OutputOnly
*/
vmName?: string;
/**
* Status of the virtual machine where this instance lives. Only applicable
* for instances in App Engine flexible environment.@OutputOnly
*/
vmStatus?: string;
/**
* Zone where the virtual machine is located. Only applicable for instances
* in App Engine flexible environment.@OutputOnly
*/
vmZoneName?: string;
}
/**
* Third-party Python runtime library that is required by the application.
*/
interface Schema$Library {
/**
* Name of the library. Example: "django".
*/
name?: string;
/**
* Version of the library to select, or "latest".
*/
version?: string;
}
/**
* Response message for AuthorizedCertificates.ListAuthorizedCertificates.
*/
interface Schema$ListAuthorizedCertificatesResponse {
/**
* The SSL certificates the user is authorized to administer.
*/
certificates?: Schema$AuthorizedCertificate[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for AuthorizedDomains.ListAuthorizedDomains.
*/
interface Schema$ListAuthorizedDomainsResponse {
/**
* The authorized domains belonging to the user.
*/
domains?: Schema$AuthorizedDomain[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for DomainMappings.ListDomainMappings.
*/
interface Schema$ListDomainMappingsResponse {
/**
* The domain mappings for the application.
*/
domainMappings?: Schema$DomainMapping[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for Firewall.ListIngressRules.
*/
interface Schema$ListIngressRulesResponse {
/**
* The ingress FirewallRules for this application.
*/
ingressRules?: Schema$FirewallRule[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for Instances.ListInstances.
*/
interface Schema$ListInstancesResponse {
/**
* The instances belonging to the requested version.
*/
instances?: Schema$Instance[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
}
/**
* The response message for Locations.ListLocations.
*/
interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string;
}
/**
* The response message for Operations.ListOperations.
*/
interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response message for Services.ListServices.
*/
interface Schema$ListServicesResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
/**
* The services belonging to the requested application.
*/
services?: Schema$Service[];
}
/**
* Response message for Versions.ListVersions.
*/
interface Schema$ListVersionsResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
/**
* The versions belonging to the requested service.
*/
versions?: Schema$Version[];
}
/**
* Health checking configuration for VM instances. Unhealthy instances are
* killed and replaced with new instances.
*/
interface Schema$LivenessCheck {
/**
* Interval between health checks.
*/
checkInterval?: string;
/**
* Number of consecutive failed checks required before considering the VM
* unhealthy.
*/
failureThreshold?: number;
/**
* Host header to send when performing a HTTP Liveness check. Example:
* "myapp.appspot.com"
*/
host?: string;
/**
* The initial delay before starting to execute the checks.
*/
initialDelay?: string;
/**
* The request path.
*/
path?: string;
/**
* Number of consecutive successful checks required before considering the
* VM healthy.
*/
successThreshold?: number;
/**
* Time before the check is considered failed.
*/
timeout?: string;
}
/**
* A resource that represents Google Cloud Platform location.
*/
interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For
* example, "Tokyo".
*/
displayName?: string;
/**
* Cross-service attributes for the location. For example
* {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {
[key: string]: string;
};
/**
* The canonical id for this location. For example: "us-east1".
*/
locationId?: string;
/**
* Service-specific metadata. For example the available capacity at the
* given location.
*/
metadata?: {
[key: string]: any;
};
/**
* Resource name for the location, which may vary between implementations.
* For example: "projects/example-project/locations/us-east1"
*/
name?: string;
}
/**
* Metadata for the given google.cloud.location.Location.
*/
interface Schema$LocationMetadata {
/**
* App Engine flexible environment is available in the given
* location.@OutputOnly
*/
flexibleEnvironmentAvailable?: boolean;
/**
* App Engine standard environment is available in the given
* location.@OutputOnly
*/
standardEnvironmentAvailable?: boolean;
}
/**
* A certificate managed by App Engine.
*/
interface Schema$ManagedCertificate {
/**
* Time at which the certificate was last renewed. The renewal process is
* fully managed. Certificate renewal will automatically occur before the
* certificate expires. Renewal errors can be tracked via
* ManagementStatus.@OutputOnly
*/
lastRenewalTime?: string;
/**
* Status of certificate management. Refers to the most recent certificate
* acquisition or renewal attempt.@OutputOnly
*/
status?: string;
}
/**
* A service with manual scaling runs continuously, allowing you to perform
* complex initialization and rely on the state of its memory over time.
*/
interface Schema$ManualScaling {
/**
* Number of instances to assign to the service at the start. This number
* can later be altered by using the Modules API
* (https://cloud.google.com/appengine/docs/python/modules/functions)
* set_num_instances() function.
*/
instances?: number;
}
/**
* Extra network settings. Only applicable in the App Engine flexible
* environment.
*/
interface Schema$Network {
/**
* List of ports, or port pairs, to forward from the virtual machine to the
* application container. Only applicable in the App Engine flexible
* environment.
*/
forwardedPorts?: string[];
/**
* Tag to apply to the instance during creation. Only applicable in the App
* Engine flexible environment.
*/
instanceTag?: string;
/**
* Google Compute Engine network where the virtual machines are created.
* Specify the short name, not the resource path.Defaults to default.
*/
name?: string;
/**
* Enable session affinity. Only applicable in the App Engine flexible
* environment.
*/
sessionAffinity?: boolean;
/**
* Google Cloud Platform sub-network where the virtual machines are created.
* Specify the short name, not the resource path.If a subnetwork name is
* specified, a network name will also be required unless it is for the
* default network. If the network that the instance is being created in is
* a Legacy network, then the IP address is allocated from the IPv4Range. If
* the network that the instance is being created in is an auto Subnet Mode
* Network, then only network name should be specified (not the
* subnetwork_name) and the IP address is created from the IPCidrRange of
* the subnetwork that exists in that zone for that network. If the network
* that the instance is being created in is a custom Subnet Mode Network,
* then the subnetwork_name must be specified and the IP address is created
* from the IPCidrRange of the subnetwork.If specified, the subnetwork must
* exist in the same region as the App Engine flexible environment
* application.
*/
subnetworkName?: string;
}
/**
* Target scaling by network usage. Only applicable in the App Engine flexible
* environment.
*/
interface Schema$NetworkUtilization {
/**
* Target bytes received per second.
*/
targetReceivedBytesPerSecond?: number;
/**
* Target packets received per second.
*/
targetReceivedPacketsPerSecond?: number;
/**
* Target bytes sent per second.
*/
targetSentBytesPerSecond?: number;
/**
* Target packets sent per second.
*/
targetSentPacketsPerSecond?: number;
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
interface Schema$Operation {
/**
* If the value is false, it means the operation is still in progress. If
* true, the operation is completed, and either error or response is
* available.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
};
/**
* The server-assigned name, which is only unique within the same service
* that originally returns it. If you use the default HTTP mapping, the name
* should have the format of operations/some/unique/name.
*/
name?: string;
/**
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as Delete, the response is
* google.protobuf.Empty. If the original method is standard
* Get/Create/Update, the response should be the resource. For other
* methods, the response should have the type XxxResponse, where Xxx is the
* original method name. For example, if the original method name is
* TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
*/
response?: {
[key: string]: any;
};
}
/**
* Metadata for the given google.longrunning.Operation.
*/
interface Schema$OperationMetadataV1 {
createVersionMetadata?: Schema$CreateVersionMetadataV1;
/**
* Time that this operation completed.@OutputOnly
*/
endTime?: string;
/**
* Ephemeral message that may change every time the operation is polled.
* @OutputOnly
*/
ephemeralMessage?: string;
/**
* Time that this operation was created.@OutputOnly
*/
insertTime?: string;
/**
* API method that initiated this operation. Example:
* google.appengine.v1.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
* Name of the resource that this operation is acting on. Example:
* apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
* User who requested this operation.@OutputOnly
*/
user?: string;
/**
* Durable messages that persist on every operation poll. @OutputOnly
*/
warning?: string[];
}
/**
* Metadata for the given google.longrunning.Operation.
*/
interface Schema$OperationMetadataV1Alpha {
createVersionMetadata?: Schema$CreateVersionMetadataV1Alpha;
/**
* Time that this operation completed.@OutputOnly
*/
endTime?: string;
/**
* Ephemeral message that may change every time the operation is polled.
* @OutputOnly
*/
ephemeralMessage?: string;
/**
* Time that this operation was created.@OutputOnly
*/
insertTime?: string;
/**
* API method that initiated this operation. Example:
* google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
* Name of the resource that this operation is acting on. Example:
* apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
* User who requested this operation.@OutputOnly
*/
user?: string;
/**
* Durable messages that persist on every operation poll. @OutputOnly
*/
warning?: string[];
}
/**
* Metadata for the given google.longrunning.Operation.
*/
interface Schema$OperationMetadataV1Beta {
createVersionMetadata?: Schema$CreateVersionMetadataV1Beta;
/**
* Time that this operation completed.@OutputOnly
*/
endTime?: string;
/**
* Ephemeral message that may change every time the operation is polled.
* @OutputOnly
*/
ephemeralMessage?: string;
/**
* Time that this operation was created.@OutputOnly
*/
insertTime?: string;
/**
* API method that initiated this operation. Example:
* google.appengine.v1beta.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
* Name of the resource that this operation is acting on. Example:
* apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
* User who requested this operation.@OutputOnly
*/
user?: string;
/**
* Durable messages that persist on every operation poll. @OutputOnly
*/
warning?: string[];
}
/**
* Readiness checking configuration for VM instances. Unhealthy instances are
* removed from traffic rotation.
*/
interface Schema$ReadinessCheck {
/**
* A maximum time limit on application initialization, measured from moment
* the application successfully replies to a healthcheck until it is ready
* to serve traffic.
*/
appStartTimeout?: string;
/**
* Interval between health checks.
*/
checkInterval?: string;
/**
* Number of consecutive failed checks required before removing traffic.
*/
failureThreshold?: number;
/**
* Host header to send when performing a HTTP Readiness check. Example:
* "myapp.appspot.com"
*/
host?: string;
/**
* The request path.
*/
path?: string;
/**
* Number of consecutive successful checks required before receiving
* traffic.
*/
successThreshold?: number;
/**
* Time before the check is considered failed.
*/
timeout?: string;
}
/**
* Request message for 'Applications.RepairApplication'.
*/
interface Schema$RepairApplicationRequest {
}
/**
* Target scaling by request utilization. Only applicable in the App Engine
* flexible environment.
*/
interface Schema$RequestUtilization {
/**
* Target number of concurrent requests.
*/
targetConcurrentRequests?: number;
/**
* Target requests per second.
*/
targetRequestCountPerSecond?: number;
}
/**
* A DNS resource record.
*/
interface Schema$ResourceRecord {
/**
* Relative name of the object affected by this record. Only applicable for
* CNAME records. Example: 'www'.
*/
name?: string;
/**
* Data for this record. Values vary by record type, as defined in RFC 1035
* (section 5) and RFC 1034 (section 3.6.1).
*/
rrdata?: string;
/**
* Resource record type. Example: AAAA.
*/
type?: string;
}
/**
* Machine resources for a version.
*/
interface Schema$Resources {
/**
* Number of CPU cores needed.
*/
cpu?: number;
/**
* Disk size (GB) needed.
*/
diskGb?: number;
/**
* Memory (GB) needed.
*/
memoryGb?: number;
/**
* User specified volumes.
*/
volumes?: Schema$Volume[];
}
/**
* Executes a script to handle the request that matches the URL pattern.
*/
interface Schema$ScriptHandler {
/**
* Path to the script from the application root directory.
*/
scriptPath?: string;
}
/**
* A Service resource is a logical component of an application that can share
* state and communicate in a secure fashion with other services. For example,
* an application that handles customer requests might include separate
* services to handle tasks such as backend data analysis or API requests from
* mobile devices. Each service has a collection of versions that define a
* specific set of code used to implement the functionality of that service.
*/
interface Schema$Service {
/**
* Relative name of the service within the application. Example:
* default.@OutputOnly
*/
id?: string;
/**
* Full path to the Service resource in the API. Example:
* apps/myapp/services/default.@OutputOnly
*/
name?: string;
/**
* Mapping that defines fractional HTTP traffic diversion to different
* versions within the service.
*/
split?: Schema$TrafficSplit;
}
/**
* SSL configuration for a DomainMapping resource.
*/
interface Schema$SslSettings {
/**
* ID of the AuthorizedCertificate resource configuring SSL for the
* application. Clearing this field will remove SSL support.By default, a
* managed certificate is automatically created for every domain mapping. To
* omit SSL support or to configure SSL manually, specify
* SslManagementType.MANUAL on a CREATE or UPDATE request. You must be
* authorized to administer the AuthorizedCertificate resource to manually
* map it to a DomainMapping resource. Example: 12345.
*/
certificateId?: string;
/**
* ID of the managed AuthorizedCertificate resource currently being
* provisioned, if applicable. Until the new managed certificate has been
* successfully provisioned, the previous SSL state will be preserved. Once
* the provisioning process completes, the certificate_id field will reflect
* the new managed certificate and this field will be left empty. To remove
* SSL support while there is still a pending managed certificate, clear the
* certificate_id field with an UpdateDomainMappingRequest.@OutputOnly
*/
pendingManagedCertificateId?: string;
/**
* SSL management type for this domain. If AUTOMATIC, a managed certificate
* is automatically provisioned. If MANUAL, certificate_id must be manually
* specified in order to configure SSL for this domain.
*/
sslManagementType?: string;
}
/**
* Scheduler settings for standard environment.
*/
interface Schema$StandardSchedulerSettings {
/**
* Maximum number of instances to run for this version. Set to zero to
* disable max_instances configuration.
*/
maxInstances?: number;
/**
* Minimum number of instances to run for this version. Set to zero to
* disable min_instances configuration.
*/
minInstances?: number;
/**
* Target CPU utilization ratio to maintain when scaling.
*/
targetCpuUtilization?: number;
/**
* Target throughput utilization ratio to maintain when scaling
*/
targetThroughputUtilization?: number;
}
/**
* Files served directly to the user for a given URL, such as images, CSS
* stylesheets, or JavaScript source files. Static file handlers describe
* which files in the application directory are static files, and which URLs
* serve them.
*/
interface Schema$StaticFilesHandler {
/**
* Whether files should also be uploaded as code data. By default, files
* declared in static file handlers are uploaded as static data and are only
* served to end users; they cannot be read by the application. If enabled,
* uploads are charged against both your code and static data storage
* resource quotas.
*/
applicationReadable?: boolean;
/**
* Time a static file served by this handler should be cached by web proxies
* and browsers.
*/
expiration?: string;
/**
* HTTP headers to use for all responses from these URLs.
*/
httpHeaders?: {
[key: string]: string;
};
/**
* MIME type used to serve all files served by this handler.Defaults to
* file-specific MIME types, which are derived from each file's filename
* extension.
*/
mimeType?: string;
/**
* Path to the static files matched by the URL pattern, from the application
* root directory. The path can refer to text matched in groupings in the
* URL pattern.
*/
path?: string;
/**
* Whether this handler should match the request if the file referenced by
* the handler does not exist.
*/
requireMatchingFile?: boolean;
/**
* Regular expression that matches the file paths for all files that should
* be referenced by this handler.
*/
uploadPathRegex?: string;
}
/**
* The Status type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by gRPC (https://github.com/grpc). The error model is designed to be:
* Simple to use and understand for most users Flexible enough to meet
* unexpected needsOverviewThe Status message contains three pieces of data:
* error code, error message, and error details. The error code should be an
* enum value of google.rpc.Code, but it may accept additional error codes if
* needed. The error message should be a developer-facing English message that
* helps developers understand and resolve the error. If a localized
* user-facing error message is needed, put the localized message in the error
* details or localize it in the client. The optional error details may
* contain arbitrary information about the error. There is a predefined set of
* error detail types in the package google.rpc that can be used for common
* error conditions.Language mappingThe Status message is the logical
* representation of the error model, but it is not necessarily the actual
* wire format. When the Status message is exposed in different client
* libraries and different wire protocols, it can be mapped differently. For
* example, it will likely be mapped to some exceptions in Java, but more
* likely mapped to some error codes in C.Other usesThe error model and the
* Status message can be used in a variety of environments, either with or
* without APIs, to provide a consistent developer experience across different
* environments.Example uses of this error model include: Partial errors. If a
* service needs to return partial errors to the client, it may embed the
* Status in the normal response to indicate the partial errors. Workflow
* errors. A typical workflow has multiple steps. Each step may have a Status
* message for error reporting. Batch operations. If a client uses batch
* request and batch response, the Status message should be used directly
* inside batch response, one for each error sub-response. Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the Status message. Logging. If some API errors are stored in logs,
* the message Status could be used directly after any stripping needed for
* security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set of
* message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}>;
/**
* A developer-facing error message, which should be in English. Any
* user-facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
* Traffic routing configuration for versions within a single service. Traffic
* splits define how traffic directed to the service is assigned to versions.
*/
interface Schema$TrafficSplit {
/**
* Mapping from version IDs within the service to fractional (0.000, 1]
* allocations of traffic for that version. Each version can be specified
* only once, but some versions in the service may not have any traffic
* allocation. Services that have traffic allocated cannot be deleted until
* either the service is deleted or their traffic allocation is removed.
* Allocations must sum to 1. Up to two decimal place precision is supported
* for IP-based splits and up to three decimal places is supported for
* cookie-based splits.
*/
allocations?: {
[key: string]: number;
};
/**
* Mechanism used to determine which version a request is sent to. The
* traffic selection algorithm will be stable for either type until
* allocations are changed.
*/
shardBy?: string;
}
/**
* Rules to match an HTTP request and dispatch that request to a service.
*/
interface Schema$UrlDispatchRule {
/**
* Domain name to match against. The wildcard "*" is supported if
* specified before a period: "*.".Defaults to matching all
* domains: "*".
*/
domain?: string;
/**
* Pathname within the host. Must start with a "/". A single
* "*" can be included at the end of the path.The sum of the
* lengths of the domain and path may not exceed 100 characters.
*/
path?: string;
/**
* Resource ID of a service in this application that should serve the
* matched request. The service must already exist. Example: default.
*/
service?: string;
}
/**
* URL pattern and description of how the URL should be handled. App Engine
* can handle URLs by executing application code or by serving static files
* uploaded with the version, such as images, CSS, or JavaScript.
*/
interface Schema$UrlMap {
/**
* Uses API Endpoints to handle requests.
*/
apiEndpoint?: Schema$ApiEndpointHandler;
/**
* Action to take when users access resources that require authentication.
* Defaults to redirect.
*/
authFailAction?: string;
/**
* Level of login required to access this resource. Not supported for
* Node.js in the App Engine standard environment.
*/
login?: string;
/**
* 30x code to use when performing redirects for the secure field. Defaults
* to 302.
*/
redirectHttpResponseCode?: string;
/**
* Executes a script to handle the requests that match this URL pattern.
* Only the auto value is supported for Node.js in the App Engine standard
* environment, for example "script": "auto".
*/
script?: Schema$ScriptHandler;
/**
* Security (HTTPS) enforcement for this URL.
*/
securityLevel?: string;
/**
* Returns the contents of a file, such as an image, as the response.
*/
staticFiles?: Schema$StaticFilesHandler;
/**
* URL prefix. Uses regular expression syntax, which means regexp special
* characters must be escaped, but should not contain groupings. All URLs
* that begin with this prefix are handled by this handler, using the
* portion of the URL after the prefix as part of the file path.
*/
urlRegex?: string;
}
/**
* A Version resource is a specific set of source code and configuration files
* that are deployed into a service.
*/
interface Schema$Version {
/**
* Serving configuration for Google Cloud Endpoints
* (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned
* in GET requests if view=FULL is set.
*/
apiConfig?: Schema$ApiConfigHandler;
/**
* Automatic scaling is based on request rate, response latencies, and other
* application metrics.
*/
automaticScaling?: Schema$AutomaticScaling;
/**
* A service with basic scaling will create an instance when the application
* receives a request. The instance will be turned down when the app becomes
* idle. Basic scaling is ideal for work that is intermittent or driven by
* user activity.
*/
basicScaling?: Schema$BasicScaling;
/**
* Metadata settings that are supplied to this version to enable beta
* runtime features.
*/
betaSettings?: {
[key: string]: string;
};
/**
* Email address of the user who created this version.@OutputOnly
*/
createdBy?: string;
/**
* Time that this version was created.@OutputOnly
*/
createTime?: string;
/**
* Duration that static files should be cached by web proxies and browsers.
* Only applicable if the corresponding StaticFilesHandler
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler)
* does not specify its own expiration time.Only returned in GET requests if
* view=FULL is set.
*/
defaultExpiration?: string;
/**
* Code and application artifacts that make up this version.Only returned in
* GET requests if view=FULL is set.
*/
deployment?: Schema$Deployment;
/**
* Total size in bytes of all the files that are included in this version
* and currently hosted on the App Engine disk.@OutputOnly
*/
diskUsageBytes?: string;
/**
* Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud
* Endpoints Extensible Service Proxy will be provided to serve the API
* implemented by the app.
*/
endpointsApiService?: Schema$EndpointsApiService;
/**
* The entrypoint for the application.
*/
entrypoint?: Schema$Entrypoint;
/**
* App Engine execution environment for this version.Defaults to standard.
*/
env?: string;
/**
* Environment variables available to the application.Only returned in GET
* requests if view=FULL is set.
*/
envVariables?: {
[key: string]: string;
};
/**
* Custom static error pages. Limited to 10KB per page.Only returned in GET
* requests if view=FULL is set.
*/
errorHandlers?: Schema$ErrorHandler[];
/**
* An ordered list of URL-matching patterns that should be applied to
* incoming requests. The first matching URL handles the request and other
* request handlers are not attempted.Only returned in GET requests if
* view=FULL is set.
*/
handlers?: Schema$UrlMap[];
/**
* Configures health checking for instances. Unhealthy instances are stopped
* and replaced with new instances. Only applicable in the App Engine
* flexible environment.Only returned in GET requests if view=FULL is set.
*/
healthCheck?: Schema$HealthCheck;
/**
* Relative name of the version within the service. Example: v1. Version
* names can contain only lowercase letters, numbers, or hyphens. Reserved
* names: "default", "latest", and any name with the
* prefix "ah-".
*/
id?: string;
/**
* Before an application can receive email or XMPP messages, the application
* must be configured to enable the service.
*/
inboundServices?: string[];
/**
* Instance class that is used to run this version. Valid values are:
* AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1,
* B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for
* ManualScaling or BasicScaling.
*/
instanceClass?: string;
/**
* Configuration for third-party Python runtime libraries that are required
* by the application.Only returned in GET requests if view=FULL is set.
*/
libraries?: Schema$Library[];
/**
* Configures liveness health checking for instances. Unhealthy instances
* are stopped and replaced with new instancesOnly returned in GET requests
* if view=FULL is set.
*/
livenessCheck?: Schema$LivenessCheck;
/**
* A service with manual scaling runs continuously, allowing you to perform
* complex initialization and rely on the state of its memory over time.
*/
manualScaling?: Schema$ManualScaling;
/**
* Full path to the Version resource in the API. Example:
* apps/myapp/services/default/versions/v1.@OutputOnly
*/
name?: string;
/**
* Extra network settings. Only applicable in the App Engine flexible
* environment.
*/
network?: Schema$Network;
/**
* Files that match this pattern will not be built into this version. Only
* applicable for Go runtimes.Only returned in GET requests if view=FULL is
* set.
*/
nobuildFilesRegex?: string;
/**
* Configures readiness health checking for instances. Unhealthy instances
* are not put into the backend traffic rotation.Only returned in GET
* requests if view=FULL is set.
*/
readinessCheck?: Schema$ReadinessCheck;
/**
* Machine resources for this version. Only applicable in the App Engine
* flexible environment.
*/
resources?: Schema$Resources;
/**
* Desired runtime. Example: python27.
*/
runtime?: string;
/**
* The version of the API in the given runtime environment. Please see the
* app.yaml reference for valid values at
* https://cloud.google.com/appengine/docs/standard/<language>/config/appref
*/
runtimeApiVersion?: string;
/**
* The channel of the runtime to use. Only available for some runtimes.
* Defaults to the default channel.
*/
runtimeChannel?: string;
/**
* The path or name of the app's main executable.
*/
runtimeMainExecutablePath?: string;
/**
* Current serving status of this version. Only the versions with a SERVING
* status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is
* an invalid value. Defaults to SERVING.
*/
servingStatus?: string;
/**
* Whether multiple requests can be dispatched to this version at once.
*/
threadsafe?: boolean;
/**
* Serving URL for this version. Example:
* "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
*/
versionUrl?: string;
/**
* Whether to deploy this version in a container on a virtual machine.
*/
vm?: boolean;
/**
* Enables VPC connectivity for standard apps.
*/
vpcAccessConnector?: Schema$VpcAccessConnector;
/**
* The Google Compute Engine zones that are supported by this version in the
* App Engine flexible environment. Deprecated.
*/
zones?: string[];
}
/**
* Volumes mounted within the app container. Only applicable in the App Engine
* flexible environment.
*/
interface Schema$Volume {
/**
* Unique name for the volume.
*/
name?: string;
/**
* Volume size in gigabytes.
*/
sizeGb?: number;
/**
* Underlying volume type, e.g. 'tmpfs'.
*/
volumeType?: string;
}
/**
* VPC access connector specification.
*/
interface Schema$VpcAccessConnector {
/**
* Full Serverless VPC Access Connector name e.g.
* /projects/my-project/locations/us-central1/connectors/c1.
*/
name?: string;
}
/**
* The zip file information for a zip deployment.
*/
interface Schema$ZipInfo {
/**
* An estimate of the number of files in a zip for a zip deployment. If set,
* must be greater than or equal to the actual number of files. Used for
* optimizing performance; if not provided, deployment may be slow.
*/
filesCount?: number;
/**
* URL of the zip file to deploy from. Must be a URL to a resource in Google
* Cloud Storage in the form
* 'http(s)://storage.googleapis.com/<bucket>/<object>'.
*/
sourceUrl?: string;
}
class Resource$Apps {
context: APIRequestContext;
authorizedCertificates: Resource$Apps$Authorizedcertificates;
authorizedDomains: Resource$Apps$Authorizeddomains;
domainMappings: Resource$Apps$Domainmappings;
firewall: Resource$Apps$Firewall;
locations: Resource$Apps$Locations;
operations: Resource$Apps$Operations;
services: Resource$Apps$Services;
constructor(context: APIRequestContext);
/**
* appengine.apps.create
* @desc Creates an App Engine application for a Google Cloud Platform
* project. Required fields: id - The ID of the target Cloud Platform
* project. location - The region
* (https://cloud.google.com/appengine/docs/locations) where you want the
* App Engine application located.For more information about App Engine
* applications, see Managing Projects, Applications, and Billing
* (https://cloud.google.com/appengine/docs/standard/python/console/).
* @alias appengine.apps.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Application} 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
*/
create(params?: Params$Resource$Apps$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Apps$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Apps$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.get
* @desc Gets information about an application.
* @alias appengine.apps.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the Application resource to get. Example: apps/myapp.
* @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$Apps$Get, options?: MethodOptions): GaxiosPromise<Schema$Application>;
get(params: Params$Resource$Apps$Get, options: MethodOptions | BodyResponseCallback<Schema$Application>, callback: BodyResponseCallback<Schema$Application>): void;
get(params: Params$Resource$Apps$Get, callback: BodyResponseCallback<Schema$Application>): void;
get(callback: BodyResponseCallback<Schema$Application>): void;
/**
* appengine.apps.patch
* @desc Updates the specified Application resource. You can update the
* following fields: auth_domain - Google authentication domain for
* controlling user access to the application. default_cookie_expiration -
* Cookie expiration policy for the application.
* @alias appengine.apps.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the Application resource to update. Example: apps/myapp.
* @param {string=} params.updateMask Standard field mask for the set of fields to be updated.
* @param {().Application} 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$Apps$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Apps$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Apps$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.repair
* @desc Recreates the required App Engine features for the specified App
* Engine application, for example a Cloud Storage bucket or App Engine
* service account. Use this method if you receive an error message about a
* missing feature, for example, Error retrieving the App Engine service
* account.
* @alias appengine.apps.repair
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the application to repair. Example: apps/myapp
* @param {().RepairApplicationRequest} 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
*/
repair(params?: Params$Resource$Apps$Repair, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
repair(params: Params$Resource$Apps$Repair, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
repair(params: Params$Resource$Apps$Repair, callback: BodyResponseCallback<Schema$Operation>): void;
repair(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Apps$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Application;
}
interface Params$Resource$Apps$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the Application resource to get. Example:
* apps/myapp.
*/
appsId?: string;
}
interface Params$Resource$Apps$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the Application resource to update. Example:
* apps/myapp.
*/
appsId?: string;
/**
* Standard field mask for the set of fields to be updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Application;
}
interface Params$Resource$Apps$Repair extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the application to repair. Example: apps/myapp
*/
appsId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RepairApplicationRequest;
}
class Resource$Apps$Authorizedcertificates {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* appengine.apps.authorizedCertificates.create
* @desc Uploads the specified SSL certificate.
* @alias appengine.apps.authorizedCertificates.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
* @param {().AuthorizedCertificate} 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
*/
create(params?: Params$Resource$Apps$Authorizedcertificates$Create, options?: MethodOptions): GaxiosPromise<Schema$AuthorizedCertificate>;
create(params: Params$Resource$Apps$Authorizedcertificates$Create, options: MethodOptions | BodyResponseCallback<Schema$AuthorizedCertificate>, callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
create(params: Params$Resource$Apps$Authorizedcertificates$Create, callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
create(callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
/**
* appengine.apps.authorizedCertificates.delete
* @desc Deletes the specified SSL certificate.
* @alias appengine.apps.authorizedCertificates.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.
* @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`.
* @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$Apps$Authorizedcertificates$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Apps$Authorizedcertificates$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Apps$Authorizedcertificates$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* appengine.apps.authorizedCertificates.get
* @desc Gets the specified SSL certificate.
* @alias appengine.apps.authorizedCertificates.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.
* @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`.
* @param {string=} params.view Controls the set of fields returned in the GET response.
* @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$Apps$Authorizedcertificates$Get, options?: MethodOptions): GaxiosPromise<Schema$AuthorizedCertificate>;
get(params: Params$Resource$Apps$Authorizedcertificates$Get, options: MethodOptions | BodyResponseCallback<Schema$AuthorizedCertificate>, callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
get(params: Params$Resource$Apps$Authorizedcertificates$Get, callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
get(callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
/**
* appengine.apps.authorizedCertificates.list
* @desc Lists all SSL certificates the user is authorized to administer.
* @alias appengine.apps.authorizedCertificates.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
* @param {integer=} params.pageSize Maximum results to return per page.
* @param {string=} params.pageToken Continuation token for fetching the next page of results.
* @param {string=} params.view Controls the set of fields returned in the LIST response.
* @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$Apps$Authorizedcertificates$List, options?: MethodOptions): GaxiosPromise<Schema$ListAuthorizedCertificatesResponse>;
list(params: Params$Resource$Apps$Authorizedcertificates$List, options: MethodOptions | BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>, callback: BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>): void;
list(params: Params$Resource$Apps$Authorizedcertificates$List, callback: BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>): void;
/**
* appengine.apps.authorizedCertificates.patch
* @desc Updates the specified SSL certificate. To renew a certificate and
* maintain its existing domain mappings, update certificate_data with a new
* certificate. The new certificate must be applicable to the same domains
* as the original certificate. The certificate display_name may also be
* updated.
* @alias appengine.apps.authorizedCertificates.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.
* @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`.
* @param {string=} params.updateMask Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
* @param {().AuthorizedCertificate} 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$Apps$Authorizedcertificates$Patch, options?: MethodOptions): GaxiosPromise<Schema$AuthorizedCertificate>;
patch(params: Params$Resource$Apps$Authorizedcertificates$Patch, options: MethodOptions | BodyResponseCallback<Schema$AuthorizedCertificate>, callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
patch(params: Params$Resource$Apps$Authorizedcertificates$Patch, callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
patch(callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
}
interface Params$Resource$Apps$Authorizedcertificates$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Application resource. Example:
* apps/myapp.
*/
appsId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AuthorizedCertificate;
}
interface Params$Resource$Apps$Authorizedcertificates$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource to delete. Example:
* apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
authorizedCertificatesId?: string;
}
interface Params$Resource$Apps$Authorizedcertificates$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
authorizedCertificatesId?: string;
/**
* Controls the set of fields returned in the GET response.
*/
view?: string;
}
interface Params$Resource$Apps$Authorizedcertificates$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Application resource. Example:
* apps/myapp.
*/
appsId?: string;
/**
* Maximum results to return per page.
*/
pageSize?: number;
/**
* Continuation token for fetching the next page of results.
*/
pageToken?: string;
/**
* Controls the set of fields returned in the LIST response.
*/
view?: string;
}
interface Params$Resource$Apps$Authorizedcertificates$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource to update. Example:
* apps/myapp/authorizedCertificates/12345.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
authorizedCertificatesId?: string;
/**
* Standard field mask for the set of fields to be updated. Updates are only
* supported on the certificate_raw_data and display_name fields.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AuthorizedCertificate;
}
class Resource$Apps$Authorizeddomains {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* appengine.apps.authorizedDomains.list
* @desc Lists all domains the user is authorized to administer.
* @alias appengine.apps.authorizedDomains.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
* @param {integer=} params.pageSize Maximum results to return per page.
* @param {string=} params.pageToken Continuation token for fetching the next page of results.
* @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$Apps$Authorizeddomains$List, options?: MethodOptions): GaxiosPromise<Schema$ListAuthorizedDomainsResponse>;
list(params: Params$Resource$Apps$Authorizeddomains$List, options: MethodOptions | BodyResponseCallback<Schema$ListAuthorizedDomainsResponse>, callback: BodyResponseCallback<Schema$ListAuthorizedDomainsResponse>): void;
list(params: Params$Resource$Apps$Authorizeddomains$List, callback: BodyResponseCallback<Schema$ListAuthorizedDomainsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAuthorizedDomainsResponse>): void;
}
interface Params$Resource$Apps$Authorizeddomains$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Application resource. Example:
* apps/myapp.
*/
appsId?: string;
/**
* Maximum results to return per page.
*/
pageSize?: number;
/**
* Continuation token for fetching the next page of results.
*/
pageToken?: string;
}
class Resource$Apps$Domainmappings {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* appengine.apps.domainMappings.create
* @desc Maps a domain to an application. A user must be authorized to
* administer a domain in order to map it to an application. For a list of
* available authorized domains, see
* AuthorizedDomains.ListAuthorizedDomains.
* @alias appengine.apps.domainMappings.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
* @param {string=} params.overrideStrategy Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
* @param {().DomainMapping} 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
*/
create(params?: Params$Resource$Apps$Domainmappings$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Apps$Domainmappings$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Apps$Domainmappings$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.domainMappings.delete
* @desc Deletes the specified domain mapping. A user must be authorized to
* administer the associated domain in order to delete a DomainMapping
* resource.
* @alias appengine.apps.domainMappings.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.
* @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`.
* @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$Apps$Domainmappings$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Apps$Domainmappings$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Apps$Domainmappings$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.domainMappings.get
* @desc Gets the specified domain mapping.
* @alias appengine.apps.domainMappings.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.
* @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`.
* @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$Apps$Domainmappings$Get, options?: MethodOptions): GaxiosPromise<Schema$DomainMapping>;
get(params: Params$Resource$Apps$Domainmappings$Get, options: MethodOptions | BodyResponseCallback<Schema$DomainMapping>, callback: BodyResponseCallback<Schema$DomainMapping>): void;
get(params: Params$Resource$Apps$Domainmappings$Get, callback: BodyResponseCallback<Schema$DomainMapping>): void;
get(callback: BodyResponseCallback<Schema$DomainMapping>): void;
/**
* appengine.apps.domainMappings.list
* @desc Lists the domain mappings on an application.
* @alias appengine.apps.domainMappings.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
* @param {integer=} params.pageSize Maximum results to return per page.
* @param {string=} params.pageToken Continuation token for fetching the next page of results.
* @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$Apps$Domainmappings$List, options?: MethodOptions): GaxiosPromise<Schema$ListDomainMappingsResponse>;
list(params: Params$Resource$Apps$Domainmappings$List, options: MethodOptions | BodyResponseCallback<Schema$ListDomainMappingsResponse>, callback: BodyResponseCallback<Schema$ListDomainMappingsResponse>): void;
list(params: Params$Resource$Apps$Domainmappings$List, callback: BodyResponseCallback<Schema$ListDomainMappingsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDomainMappingsResponse>): void;
/**
* appengine.apps.domainMappings.patch
* @desc Updates the specified domain mapping. To map an SSL certificate to
* a domain mapping, update certificate_id to point to an
* AuthorizedCertificate resource. A user must be authorized to administer
* the associated domain in order to update a DomainMapping resource.
* @alias appengine.apps.domainMappings.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.
* @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`.
* @param {string=} params.updateMask Standard field mask for the set of fields to be updated.
* @param {().DomainMapping} 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$Apps$Domainmappings$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Apps$Domainmappings$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Apps$Domainmappings$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Apps$Domainmappings$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Application resource. Example:
* apps/myapp.
*/
appsId?: string;
/**
* Whether the domain creation should override any existing mappings for
* this domain. By default, overrides are rejected.
*/
overrideStrategy?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DomainMapping;
}
interface Params$Resource$Apps$Domainmappings$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource to delete. Example:
* apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
domainMappingsId?: string;
}
interface Params$Resource$Apps$Domainmappings$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
domainMappingsId?: string;
}
interface Params$Resource$Apps$Domainmappings$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Application resource. Example:
* apps/myapp.
*/
appsId?: string;
/**
* Maximum results to return per page.
*/
pageSize?: number;
/**
* Continuation token for fetching the next page of results.
*/
pageToken?: string;
}
interface Params$Resource$Apps$Domainmappings$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource to update. Example:
* apps/myapp/domainMappings/example.com.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
domainMappingsId?: string;
/**
* Standard field mask for the set of fields to be updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DomainMapping;
}
class Resource$Apps$Firewall {
context: APIRequestContext;
ingressRules: Resource$Apps$Firewall$Ingressrules;
constructor(context: APIRequestContext);
}
class Resource$Apps$Firewall$Ingressrules {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* appengine.apps.firewall.ingressRules.batchUpdate
* @desc Replaces the entire firewall ruleset in one bulk operation. This
* overrides and replaces the rules of an existing firewall with the new
* rules.If the final rule does not match traffic with the '*' wildcard IP
* range, then an "allow all" rule is explicitly added to the end of the
* list.
* @alias appengine.apps.firewall.ingressRules.batchUpdate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.
* @param {().BatchUpdateIngressRulesRequest} 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
*/
batchUpdate(params?: Params$Resource$Apps$Firewall$Ingressrules$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$BatchUpdateIngressRulesResponse>;
batchUpdate(params: Params$Resource$Apps$Firewall$Ingressrules$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$BatchUpdateIngressRulesResponse>, callback: BodyResponseCallback<Schema$BatchUpdateIngressRulesResponse>): void;
batchUpdate(params: Params$Resource$Apps$Firewall$Ingressrules$Batchupdate, callback: BodyResponseCallback<Schema$BatchUpdateIngressRulesResponse>): void;
batchUpdate(callback: BodyResponseCallback<Schema$BatchUpdateIngressRulesResponse>): void;
/**
* appengine.apps.firewall.ingressRules.create
* @desc Creates a firewall rule for the application.
* @alias appengine.apps.firewall.ingressRules.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.
* @param {().FirewallRule} 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
*/
create(params?: Params$Resource$Apps$Firewall$Ingressrules$Create, options?: MethodOptions): GaxiosPromise<Schema$FirewallRule>;
create(params: Params$Resource$Apps$Firewall$Ingressrules$Create, options: MethodOptions | BodyResponseCallback<Schema$FirewallRule>, callback: BodyResponseCallback<Schema$FirewallRule>): void;
create(params: Params$Resource$Apps$Firewall$Ingressrules$Create, callback: BodyResponseCallback<Schema$FirewallRule>): void;
create(callback: BodyResponseCallback<Schema$FirewallRule>): void;
/**
* appengine.apps.firewall.ingressRules.delete
* @desc Deletes the specified firewall rule.
* @alias appengine.apps.firewall.ingressRules.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.
* @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`.
* @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$Apps$Firewall$Ingressrules$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Apps$Firewall$Ingressrules$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Apps$Firewall$Ingressrules$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* appengine.apps.firewall.ingressRules.get
* @desc Gets the specified firewall rule.
* @alias appengine.apps.firewall.ingressRules.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.
* @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`.
* @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$Apps$Firewall$Ingressrules$Get, options?: MethodOptions): GaxiosPromise<Schema$FirewallRule>;
get(params: Params$Resource$Apps$Firewall$Ingressrules$Get, options: MethodOptions | BodyResponseCallback<Schema$FirewallRule>, callback: BodyResponseCallback<Schema$FirewallRule>): void;
get(params: Params$Resource$Apps$Firewall$Ingressrules$Get, callback: BodyResponseCallback<Schema$FirewallRule>): void;
get(callback: BodyResponseCallback<Schema$FirewallRule>): void;
/**
* appengine.apps.firewall.ingressRules.list
* @desc Lists the firewall rules of an application.
* @alias appengine.apps.firewall.ingressRules.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.
* @param {string=} params.matchingAddress A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.
* @param {integer=} params.pageSize Maximum results to return per page.
* @param {string=} params.pageToken Continuation token for fetching the next page of results.
* @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$Apps$Firewall$Ingressrules$List, options?: MethodOptions): GaxiosPromise<Schema$ListIngressRulesResponse>;
list(params: Params$Resource$Apps$Firewall$Ingressrules$List, options: MethodOptions | BodyResponseCallback<Schema$ListIngressRulesResponse>, callback: BodyResponseCallback<Schema$ListIngressRulesResponse>): void;
list(params: Params$Resource$Apps$Firewall$Ingressrules$List, callback: BodyResponseCallback<Schema$ListIngressRulesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListIngressRulesResponse>): void;
/**
* appengine.apps.firewall.ingressRules.patch
* @desc Updates the specified firewall rule.
* @alias appengine.apps.firewall.ingressRules.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.
* @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`.
* @param {string=} params.updateMask Standard field mask for the set of fields to be updated.
* @param {().FirewallRule} 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$Apps$Firewall$Ingressrules$Patch, options?: MethodOptions): GaxiosPromise<Schema$FirewallRule>;
patch(params: Params$Resource$Apps$Firewall$Ingressrules$Patch, options: MethodOptions | BodyResponseCallback<Schema$FirewallRule>, callback: BodyResponseCallback<Schema$FirewallRule>): void;
patch(params: Params$Resource$Apps$Firewall$Ingressrules$Patch, callback: BodyResponseCallback<Schema$FirewallRule>): void;
patch(callback: BodyResponseCallback<Schema$FirewallRule>): void;
}
interface Params$Resource$Apps$Firewall$Ingressrules$Batchupdate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the Firewall collection to set. Example:
* apps/myapp/firewall/ingressRules.
*/
appsId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchUpdateIngressRulesRequest;
}
interface Params$Resource$Apps$Firewall$Ingressrules$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Firewall collection in which to
* create a new rule. Example: apps/myapp/firewall/ingressRules.
*/
appsId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FirewallRule;
}
interface Params$Resource$Apps$Firewall$Ingressrules$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the Firewall resource to delete. Example:
* apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
ingressRulesId?: string;
}
interface Params$Resource$Apps$Firewall$Ingressrules$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the Firewall resource to retrieve. Example:
* apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
ingressRulesId?: string;
}
interface Params$Resource$Apps$Firewall$Ingressrules$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the Firewall collection to retrieve. Example:
* apps/myapp/firewall/ingressRules.
*/
appsId?: string;
/**
* A valid IP Address. If set, only rules matching this address will be
* returned. The first returned rule will be the rule that fires on requests
* from this IP.
*/
matchingAddress?: string;
/**
* Maximum results to return per page.
*/
pageSize?: number;
/**
* Continuation token for fetching the next page of results.
*/
pageToken?: string;
}
interface Params$Resource$Apps$Firewall$Ingressrules$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the Firewall resource to update. Example:
* apps/myapp/firewall/ingressRules/100.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
ingressRulesId?: string;
/**
* Standard field mask for the set of fields to be updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FirewallRule;
}
class Resource$Apps$Locations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* appengine.apps.locations.get
* @desc Gets information about a location.
* @alias appengine.apps.locations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Resource name for the location.
* @param {string} params.locationsId Part of `name`. See documentation of `appsId`.
* @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$Apps$Locations$Get, options?: MethodOptions): GaxiosPromise<Schema$Location>;
get(params: Params$Resource$Apps$Locations$Get, options: MethodOptions | BodyResponseCallback<Schema$Location>, callback: BodyResponseCallback<Schema$Location>): void;
get(params: Params$Resource$Apps$Locations$Get, callback: BodyResponseCallback<Schema$Location>): void;
get(callback: BodyResponseCallback<Schema$Location>): void;
/**
* appengine.apps.locations.list
* @desc Lists information about the supported locations for this service.
* @alias appengine.apps.locations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. The resource that owns the locations collection, if applicable.
* @param {string=} params.filter The standard list filter.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @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$Apps$Locations$List, options?: MethodOptions): GaxiosPromise<Schema$ListLocationsResponse>;
list(params: Params$Resource$Apps$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(params: Params$Resource$Apps$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
}
interface Params$Resource$Apps$Locations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Resource name for the location.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
locationsId?: string;
}
interface Params$Resource$Apps$Locations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. The resource that owns the locations collection, if
* applicable.
*/
appsId?: string;
/**
* The standard list filter.
*/
filter?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
class Resource$Apps$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* appengine.apps.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use
* this method to poll the operation result at intervals as recommended by
* the API service.
* @alias appengine.apps.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. The name of the operation resource.
* @param {string} params.operationsId Part of `name`. See documentation of `appsId`.
* @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$Apps$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Apps$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Apps$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.operations.list
* @desc Lists operations that match the specified filter in the request. If
* the server doesn't support this method, it returns UNIMPLEMENTED.NOTE:
* the name binding allows API services to override the binding to use
* different resource name schemes, such as users/x/operations. To override
* the binding, API services can add a binding such as
* "/v1/{name=users/x}/operations" to their service configuration. For
* backwards compatibility, the default name includes the operations
* collection id, however overriding users must ensure the name binding is
* the parent resource, without the operations collection id.
* @alias appengine.apps.operations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. The name of the operation's parent resource.
* @param {string=} params.filter The standard list filter.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @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$Apps$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Apps$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Apps$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
}
interface Params$Resource$Apps$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. The name of the operation resource.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
operationsId?: string;
}
interface Params$Resource$Apps$Operations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. The name of the operation's parent resource.
*/
appsId?: string;
/**
* The standard list filter.
*/
filter?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
class Resource$Apps$Services {
context: APIRequestContext;
versions: Resource$Apps$Services$Versions;
constructor(context: APIRequestContext);
/**
* appengine.apps.services.delete
* @desc Deletes the specified service and all enclosed versions.
* @alias appengine.apps.services.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @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$Apps$Services$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Apps$Services$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Apps$Services$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.services.get
* @desc Gets the current configuration of the specified service.
* @alias appengine.apps.services.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @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$Apps$Services$Get, options?: MethodOptions): GaxiosPromise<Schema$Service>;
get(params: Params$Resource$Apps$Services$Get, options: MethodOptions | BodyResponseCallback<Schema$Service>, callback: BodyResponseCallback<Schema$Service>): void;
get(params: Params$Resource$Apps$Services$Get, callback: BodyResponseCallback<Schema$Service>): void;
get(callback: BodyResponseCallback<Schema$Service>): void;
/**
* appengine.apps.services.list
* @desc Lists all the services in the application.
* @alias appengine.apps.services.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
* @param {integer=} params.pageSize Maximum results to return per page.
* @param {string=} params.pageToken Continuation token for fetching the next page of results.
* @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$Apps$Services$List, options?: MethodOptions): GaxiosPromise<Schema$ListServicesResponse>;
list(params: Params$Resource$Apps$Services$List, options: MethodOptions | BodyResponseCallback<Schema$ListServicesResponse>, callback: BodyResponseCallback<Schema$ListServicesResponse>): void;
list(params: Params$Resource$Apps$Services$List, callback: BodyResponseCallback<Schema$ListServicesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListServicesResponse>): void;
/**
* appengine.apps.services.patch
* @desc Updates the configuration of the specified service.
* @alias appengine.apps.services.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.
* @param {boolean=} params.migrateTraffic Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @param {string=} params.updateMask Standard field mask for the set of fields to be updated.
* @param {().Service} 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$Apps$Services$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Apps$Services$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Apps$Services$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Apps$Services$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/services/default.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
}
interface Params$Resource$Apps$Services$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/services/default.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
}
interface Params$Resource$Apps$Services$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Application resource. Example:
* apps/myapp.
*/
appsId?: string;
/**
* Maximum results to return per page.
*/
pageSize?: number;
/**
* Continuation token for fetching the next page of results.
*/
pageToken?: string;
}
interface Params$Resource$Apps$Services$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource to update. Example:
* apps/myapp/services/default.
*/
appsId?: string;
/**
* Set to true to gradually shift traffic to one or more versions that you
* specify. By default, traffic is shifted immediately. For gradual traffic
* migration, the target versions must be located within instances that are
* configured for both warmup requests
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType)
* and automatic scaling
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling).
* You must specify the shardBy
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy)
* field in the Service resource. Gradual traffic migration is not supported
* in the App Engine flexible environment. For examples, see Migrating and
* Splitting Traffic
* (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
*/
migrateTraffic?: boolean;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Standard field mask for the set of fields to be updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Service;
}
class Resource$Apps$Services$Versions {
context: APIRequestContext;
instances: Resource$Apps$Services$Versions$Instances;
constructor(context: APIRequestContext);
/**
* appengine.apps.services.versions.create
* @desc Deploys code and resource files to a new version.
* @alias appengine.apps.services.versions.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.
* @param {string} params.servicesId Part of `parent`. See documentation of `appsId`.
* @param {().Version} 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
*/
create(params?: Params$Resource$Apps$Services$Versions$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Apps$Services$Versions$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Apps$Services$Versions$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.services.versions.delete
* @desc Deletes an existing Version resource.
* @alias appengine.apps.services.versions.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @param {string} params.versionsId Part of `name`. See documentation of `appsId`.
* @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$Apps$Services$Versions$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Apps$Services$Versions$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Apps$Services$Versions$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.services.versions.get
* @desc Gets the specified Version resource. By default, only a BASIC_VIEW
* will be returned. Specify the FULL_VIEW parameter to get the full
* resource.
* @alias appengine.apps.services.versions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @param {string} params.versionsId Part of `name`. See documentation of `appsId`.
* @param {string=} params.view Controls the set of fields returned in the Get response.
* @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$Apps$Services$Versions$Get, options?: MethodOptions): GaxiosPromise<Schema$Version>;
get(params: Params$Resource$Apps$Services$Versions$Get, options: MethodOptions | BodyResponseCallback<Schema$Version>, callback: BodyResponseCallback<Schema$Version>): void;
get(params: Params$Resource$Apps$Services$Versions$Get, callback: BodyResponseCallback<Schema$Version>): void;
get(callback: BodyResponseCallback<Schema$Version>): void;
/**
* appengine.apps.services.versions.list
* @desc Lists the versions of a service.
* @alias appengine.apps.services.versions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.
* @param {integer=} params.pageSize Maximum results to return per page.
* @param {string=} params.pageToken Continuation token for fetching the next page of results.
* @param {string} params.servicesId Part of `parent`. See documentation of `appsId`.
* @param {string=} params.view Controls the set of fields returned in the List response.
* @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$Apps$Services$Versions$List, options?: MethodOptions): GaxiosPromise<Schema$ListVersionsResponse>;
list(params: Params$Resource$Apps$Services$Versions$List, options: MethodOptions | BodyResponseCallback<Schema$ListVersionsResponse>, callback: BodyResponseCallback<Schema$ListVersionsResponse>): void;
list(params: Params$Resource$Apps$Services$Versions$List, callback: BodyResponseCallback<Schema$ListVersionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListVersionsResponse>): void;
/**
* appengine.apps.services.versions.patch
* @desc Updates the specified Version resource. You can specify the
* following fields depending on the App Engine environment and type of
* scaling that the version resource uses:Standard environment
* instance_class
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic
* scaling in the standard environment: automatic_scaling.min_idle_instances
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
* automatic_scaling.max_idle_instances
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
* automaticScaling.standard_scheduler_settings.max_instances
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
* automaticScaling.standard_scheduler_settings.min_instances
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
* automaticScaling.standard_scheduler_settings.target_cpu_utilization
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)
* automaticScaling.standard_scheduler_settings.target_throughput_utilization
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic
* scaling or manual scaling in the standard environment: serving_status
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)Flexible
* environment serving_status
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic
* scaling in the flexible environment:
* automatic_scaling.min_total_instances
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
* automatic_scaling.max_total_instances
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
* automatic_scaling.cool_down_period_sec
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
* automatic_scaling.cpu_utilization.target_utilization
* (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)
* @alias appengine.apps.services.versions.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @param {string=} params.updateMask Standard field mask for the set of fields to be updated.
* @param {string} params.versionsId Part of `name`. See documentation of `appsId`.
* @param {().Version} 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$Apps$Services$Versions$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Apps$Services$Versions$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Apps$Services$Versions$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Apps$Services$Versions$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent resource to create this version
* under. Example: apps/myapp/services/default.
*/
appsId?: string;
/**
* Part of `parent`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Version;
}
interface Params$Resource$Apps$Services$Versions$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
versionsId?: string;
}
interface Params$Resource$Apps$Services$Versions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
versionsId?: string;
/**
* Controls the set of fields returned in the Get response.
*/
view?: string;
}
interface Params$Resource$Apps$Services$Versions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Service resource. Example:
* apps/myapp/services/default.
*/
appsId?: string;
/**
* Maximum results to return per page.
*/
pageSize?: number;
/**
* Continuation token for fetching the next page of results.
*/
pageToken?: string;
/**
* Part of `parent`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Controls the set of fields returned in the List response.
*/
view?: string;
}
interface Params$Resource$Apps$Services$Versions$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource to update. Example:
* apps/myapp/services/default/versions/1.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Standard field mask for the set of fields to be updated.
*/
updateMask?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
versionsId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Version;
}
class Resource$Apps$Services$Versions$Instances {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* appengine.apps.services.versions.instances.debug
* @desc Enables debugging on a VM instance. This allows you to use the SSH
* command to connect to the virtual machine where the instance lives. While
* in "debug mode", the instance continues to serve live traffic. You should
* delete the instance when you are done debugging and then allow the system
* to take over and determine if another instance should be started.Only
* applicable for instances in App Engine flexible environment.
* @alias appengine.apps.services.versions.instances.debug
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
* @param {string} params.instancesId Part of `name`. See documentation of `appsId`.
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @param {string} params.versionsId Part of `name`. See documentation of `appsId`.
* @param {().DebugInstanceRequest} 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
*/
debug(params?: Params$Resource$Apps$Services$Versions$Instances$Debug, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
debug(params: Params$Resource$Apps$Services$Versions$Instances$Debug, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
debug(params: Params$Resource$Apps$Services$Versions$Instances$Debug, callback: BodyResponseCallback<Schema$Operation>): void;
debug(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.services.versions.instances.delete
* @desc Stops a running instance.
* @alias appengine.apps.services.versions.instances.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
* @param {string} params.instancesId Part of `name`. See documentation of `appsId`.
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @param {string} params.versionsId Part of `name`. See documentation of `appsId`.
* @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$Apps$Services$Versions$Instances$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Apps$Services$Versions$Instances$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Apps$Services$Versions$Instances$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* appengine.apps.services.versions.instances.get
* @desc Gets instance information.
* @alias appengine.apps.services.versions.instances.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
* @param {string} params.instancesId Part of `name`. See documentation of `appsId`.
* @param {string} params.servicesId Part of `name`. See documentation of `appsId`.
* @param {string} params.versionsId Part of `name`. See documentation of `appsId`.
* @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$Apps$Services$Versions$Instances$Get, options?: MethodOptions): GaxiosPromise<Schema$Instance>;
get(params: Params$Resource$Apps$Services$Versions$Instances$Get, options: MethodOptions | BodyResponseCallback<Schema$Instance>, callback: BodyResponseCallback<Schema$Instance>): void;
get(params: Params$Resource$Apps$Services$Versions$Instances$Get, callback: BodyResponseCallback<Schema$Instance>): void;
get(callback: BodyResponseCallback<Schema$Instance>): void;
/**
* appengine.apps.services.versions.instances.list
* @desc Lists the instances of a version.Tip: To aggregate details about
* instances over time, see the Stackdriver Monitoring API
* (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
* @alias appengine.apps.services.versions.instances.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.
* @param {integer=} params.pageSize Maximum results to return per page.
* @param {string=} params.pageToken Continuation token for fetching the next page of results.
* @param {string} params.servicesId Part of `parent`. See documentation of `appsId`.
* @param {string} params.versionsId Part of `parent`. See documentation of `appsId`.
* @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$Apps$Services$Versions$Instances$List, options?: MethodOptions): GaxiosPromise<Schema$ListInstancesResponse>;
list(params: Params$Resource$Apps$Services$Versions$Instances$List, options: MethodOptions | BodyResponseCallback<Schema$ListInstancesResponse>, callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
list(params: Params$Resource$Apps$Services$Versions$Instances$List, callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
}
interface Params$Resource$Apps$Services$Versions$Instances$Debug extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
instancesId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
versionsId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DebugInstanceRequest;
}
interface Params$Resource$Apps$Services$Versions$Instances$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
instancesId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
versionsId?: string;
}
interface Params$Resource$Apps$Services$Versions$Instances$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `name`. Name of the resource requested. Example:
* apps/myapp/services/default/versions/v1/instances/instance-1.
*/
appsId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
instancesId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Part of `name`. See documentation of `appsId`.
*/
versionsId?: string;
}
interface Params$Resource$Apps$Services$Versions$Instances$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Part of `parent`. Name of the parent Version resource. Example:
* apps/myapp/services/default/versions/v1.
*/
appsId?: string;
/**
* Maximum results to return per page.
*/
pageSize?: number;
/**
* Continuation token for fetching the next page of results.
*/
pageToken?: string;
/**
* Part of `parent`. See documentation of `appsId`.
*/
servicesId?: string;
/**
* Part of `parent`. See documentation of `appsId`.
*/
versionsId?: string;
}
}