v3.d.ts
215 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
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
/**
* 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 monitoring_v3 {
interface Options extends GlobalOptions {
version: 'v3';
}
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;
}
/**
* Stackdriver Monitoring API
*
* Manages your Stackdriver Monitoring data and configurations. Most projects
* must be associated with a Stackdriver account, with a few exceptions as
* noted on the individual method pages.
*
* @example
* const {google} = require('googleapis');
* const monitoring = google.monitoring('v3');
*
* @namespace monitoring
* @type {Function}
* @version v3
* @variation v3
* @param {object=} options Options for Monitoring
*/
class Monitoring {
context: APIRequestContext;
projects: Resource$Projects;
uptimeCheckIps: Resource$Uptimecheckips;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Describes how to combine multiple time series to provide different views of
* the data. Aggregation consists of an alignment step on individual time
* series (alignment_period and per_series_aligner) followed by an optional
* reduction step of the data across the aligned time series
* (cross_series_reducer and group_by_fields). For more details, see
* Aggregation.
*/
interface Schema$Aggregation {
/**
* The alignment period for per-time series alignment. If present,
* alignmentPeriod must be at least 60 seconds. After per-time series
* alignment, each time series will contain data points only on the period
* boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE,
* then this field is ignored. If perSeriesAligner is specified and does not
* equal ALIGN_NONE, then this field must be defined; otherwise an error is
* returned.
*/
alignmentPeriod?: string;
/**
* The approach to be used to combine time series. Not all reducer functions
* may be applied to all time series, depending on the metric type and the
* value type of the original time series. Reduction may change the metric
* type of value type of the time series.Time series data must be aligned in
* order to perform cross-time series reduction. If crossSeriesReducer is
* specified, then perSeriesAligner must be specified and not equal
* ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is
* returned.
*/
crossSeriesReducer?: string;
/**
* The set of fields to preserve when crossSeriesReducer is specified. The
* groupByFields determine how the time series are partitioned into subsets
* prior to applying the aggregation function. Each subset contains time
* series that have the same value for each of the grouping fields. Each
* individual time series is a member of exactly one subset. The
* crossSeriesReducer is applied to each subset of time series. It is not
* possible to reduce across different resource types, so this field
* implicitly contains resource.type. Fields not specified in groupByFields
* are aggregated away. If groupByFields is not specified and all the time
* series have the same resource type, then the time series are aggregated
* into a single output time series. If crossSeriesReducer is not defined,
* this field is ignored.
*/
groupByFields?: string[];
/**
* The approach to be used to align individual time series. Not all
* alignment functions may be applied to all time series, depending on the
* metric type and value type of the original time series. Alignment may
* change the metric type or the value type of the time series.Time series
* data must be aligned in order to perform cross-time series reduction. If
* crossSeriesReducer is specified, then perSeriesAligner must be specified
* and not equal ALIGN_NONE and alignmentPeriod must be specified;
* otherwise, an error is returned.
*/
perSeriesAligner?: string;
}
/**
* A description of the conditions under which some aspect of your system is
* considered to be "unhealthy" and the ways to notify people or
* services about this state. For an overview of alert policies, see
* Introduction to Alerting.
*/
interface Schema$AlertPolicy {
/**
* How to combine the results of multiple conditions to determine if an
* incident should be opened.
*/
combiner?: string;
/**
* A list of conditions for the policy. The conditions are combined by AND
* or OR according to the combiner field. If the combined conditions
* evaluate to true, then an incident is created. A policy can have from one
* to six conditions.
*/
conditions?: Schema$Condition[];
/**
* A read-only record of the creation of the alerting policy. If provided in
* a call to create or update, this field will be ignored.
*/
creationRecord?: Schema$MutationRecord;
/**
* A short name or phrase used to identify the policy in dashboards,
* notifications, and incidents. To avoid confusion, don't use the same
* display name for multiple policies in the same project. The name is
* limited to 512 Unicode characters.
*/
displayName?: string;
/**
* Documentation that is included with notifications and incidents related
* to this policy. Best practice is for the documentation to include
* information to help responders understand, mitigate, escalate, and
* correct the underlying problems detected by the alerting policy.
* Notification channels that have limited capacity might not show this
* documentation.
*/
documentation?: Schema$Documentation;
/**
* Whether or not the policy is enabled. On write, the default
* interpretation if unset is that the policy is enabled. On read, clients
* should not make any assumption about the state if it has not been
* populated. The field should always be populated on List and Get
* operations, unless a field projection has been specified that strips it
* out.
*/
enabled?: boolean;
/**
* A read-only record of the most recent change to the alerting policy. If
* provided in a call to create or update, this field will be ignored.
*/
mutationRecord?: Schema$MutationRecord;
/**
* Required if the policy exists. The resource name for this policy. The
* syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
* [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy
* is created. When calling the alertPolicies.create method, do not include
* the name field in the alerting policy passed as part of the request.
*/
name?: string;
/**
* Identifies the notification channels to which notifications should be
* sent when incidents are opened or closed or when new violations occur on
* an already opened incident. Each element of this array corresponds to the
* name field in each of the NotificationChannel objects that are returned
* from the ListNotificationChannels method. The syntax of the entries in
* this field is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
*/
notificationChannels?: string[];
/**
* User-supplied key/value data to be used for organizing and identifying
* the AlertPolicy objects.The field can contain up to 64 entries. Each key
* and value is limited to 63 Unicode characters or 128 bytes, whichever is
* smaller. Labels and values can contain only lowercase letters, numerals,
* underscores, and dashes. Keys must begin with a letter.
*/
userLabels?: {
[key: string]: string;
};
}
/**
* A type of authentication to perform against the specified resource or URL
* that uses username and password. Currently, only Basic authentication is
* supported in Uptime Monitoring.
*/
interface Schema$BasicAuthentication {
/**
* The password to authenticate.
*/
password?: string;
/**
* The username to authenticate.
*/
username?: string;
}
/**
* BucketOptions describes the bucket boundaries used to create a histogram
* for the distribution. The buckets can be in a linear sequence, an
* exponential sequence, or each bucket can be specified explicitly.
* BucketOptions does not include the number of values in each bucket.A bucket
* has an inclusive lower bound and exclusive upper bound for the values that
* are counted for that bucket. The upper bound of a bucket must be strictly
* greater than the lower bound. The sequence of N buckets for a distribution
* consists of an underflow bucket (number 0), zero or more finite buckets
* (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets
* are contiguous: the lower bound of bucket i (i > 0) is the same as the
* upper bound of bucket i - 1. The buckets span the whole range of finite
* values: lower bound of the underflow bucket is -infinity and the upper
* bound of the overflow bucket is +infinity. The finite buckets are so-called
* because both bounds are finite.
*/
interface Schema$BucketOptions {
/**
* The explicit buckets.
*/
explicitBuckets?: Schema$Explicit;
/**
* The exponential buckets.
*/
exponentialBuckets?: Schema$Exponential;
/**
* The linear bucket.
*/
linearBuckets?: Schema$Linear;
}
/**
* A collection of data points sent from a collectd-based plugin. See the
* collectd documentation for more information.
*/
interface Schema$CollectdPayload {
/**
* The end time of the interval.
*/
endTime?: string;
/**
* The measurement metadata. Example: "process_id" -> 12345
*/
metadata?: {
[key: string]: Schema$TypedValue;
};
/**
* The name of the plugin. Example: "disk".
*/
plugin?: string;
/**
* The instance name of the plugin Example: "hdcl".
*/
pluginInstance?: string;
/**
* The start time of the interval.
*/
startTime?: string;
/**
* The measurement type. Example: "memory".
*/
type?: string;
/**
* The measurement type instance. Example: "used".
*/
typeInstance?: string;
/**
* The measured values during this time interval. Each value must have a
* different dataSourceName.
*/
values?: Schema$CollectdValue[];
}
/**
* Describes the error status for payloads that were not written.
*/
interface Schema$CollectdPayloadError {
/**
* Records the error status for the payload. If this field is present, the
* partial errors for nested values won't be populated.
*/
error?: Schema$Status;
/**
* The zero-based index in
* CreateCollectdTimeSeriesRequest.collectd_payloads.
*/
index?: number;
/**
* Records the error status for values that were not written due to an
* error.Failed payloads for which nothing is written will not include
* partial value errors.
*/
valueErrors?: Schema$CollectdValueError[];
}
/**
* A single data point from a collectd-based plugin.
*/
interface Schema$CollectdValue {
/**
* The data source for the collectd value. For example there are two data
* sources for network measurements: "rx" and "tx".
*/
dataSourceName?: string;
/**
* The type of measurement.
*/
dataSourceType?: string;
/**
* The measurement value.
*/
value?: Schema$TypedValue;
}
/**
* Describes the error status for values that were not written.
*/
interface Schema$CollectdValueError {
/**
* Records the error status for the value.
*/
error?: Schema$Status;
/**
* The zero-based index in CollectdPayload.values within the parent
* CreateCollectdTimeSeriesRequest.collectd_payloads.
*/
index?: number;
}
/**
* A condition is a true/false test that determines when an alerting policy
* should open an incident. If a condition evaluates to true, it signifies
* that something is wrong.
*/
interface Schema$Condition {
/**
* A condition that checks that a time series continues to receive new data
* points.
*/
conditionAbsent?: Schema$MetricAbsence;
/**
* A condition that compares a time series against a threshold.
*/
conditionThreshold?: Schema$MetricThreshold;
/**
* A short name or phrase used to identify the condition in dashboards,
* notifications, and incidents. To avoid confusion, don't use the same
* display name for multiple conditions in the same policy.
*/
displayName?: string;
/**
* Required if the condition exists. The unique resource name for this
* condition. Its syntax is:
* projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
* [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition
* is created as part of a new or updated alerting policy.When calling the
* alertPolicies.create method, do not include the name field in the
* conditions of the requested alerting policy. Stackdriver Monitoring
* creates the condition identifiers and includes them in the new
* policy.When calling the alertPolicies.update method to update a policy,
* including a condition name causes the existing condition to be updated.
* Conditions without names are added to the updated policy. Existing
* conditions are deleted if they are not updated.Best practice is to
* preserve [CONDITION_ID] if you make only small changes, such as those to
* condition thresholds, durations, or trigger values. Otherwise, treat the
* change as a new condition and let the existing condition be deleted.
*/
name?: string;
}
/**
* Used to perform string matching. It allows substring and regular
* expressions, together with their negations.
*/
interface Schema$ContentMatcher {
/**
* String or regex content to match (max 1024 bytes)
*/
content?: string;
}
/**
* The CreateCollectdTimeSeries request.
*/
interface Schema$CreateCollectdTimeSeriesRequest {
/**
* The collectd payloads representing the time series data. You must not
* include more than a single point for each time series, so no two payloads
* can have the same values for all of the fields plugin, plugin_instance,
* type, and type_instance.
*/
collectdPayloads?: Schema$CollectdPayload[];
/**
* The version of collectd that collected the data. Example:
* "5.3.0-192.el6".
*/
collectdVersion?: string;
/**
* The monitored resource associated with the time series.
*/
resource?: Schema$MonitoredResource;
}
/**
* The CreateCollectdTimeSeries response.
*/
interface Schema$CreateCollectdTimeSeriesResponse {
/**
* Records the error status for points that were not written due to an
* error.Failed requests for which nothing is written will return an error
* response instead.
*/
payloadErrors?: Schema$CollectdPayloadError[];
}
/**
* The CreateTimeSeries request.
*/
interface Schema$CreateTimeSeriesRequest {
/**
* The new data to be added to a list of time series. Adds at most one data
* point to each of several time series. The new data point must be more
* recent than any other point in its time series. Each TimeSeries value
* must fully specify a unique time series by supplying all label values for
* the metric and the monitored resource.The maximum number of TimeSeries
* objects per Create request is 200.
*/
timeSeries?: Schema$TimeSeries[];
}
/**
* Distribution contains summary statistics for a population of values. It
* optionally contains a histogram representing the distribution of those
* values across a set of buckets.The summary statistics are the count, mean,
* sum of the squared deviation from the mean, the minimum, and the maximum of
* the set of population of values. The histogram is based on a sequence of
* buckets and gives a count of values that fall into each bucket. The
* boundaries of the buckets are given either explicitly or by formulas for
* buckets of fixed or exponentially increasing widths.Although it is not
* forbidden, it is generally a bad idea to include non-finite values
* (infinities or NaNs) in the population of values, as this will render the
* mean and sum_of_squared_deviation fields meaningless.
*/
interface Schema$Distribution {
/**
* Required in the Stackdriver Monitoring API v3. The values for each bucket
* specified in bucket_options. The sum of the values in bucketCounts must
* equal the value in the count field of the Distribution object. The order
* of the bucket counts follows the numbering schemes described for the
* three bucket types. The underflow bucket has number 0; the finite
* buckets, if any, have numbers 1 through N-2; and the overflow bucket has
* number N-1. The size of bucket_counts must not be greater than N. If the
* size is less than N, then the remaining buckets are assigned values of
* zero.
*/
bucketCounts?: string[];
/**
* Required in the Stackdriver Monitoring API v3. Defines the histogram
* bucket boundaries.
*/
bucketOptions?: Schema$BucketOptions;
/**
* The number of values in the population. Must be non-negative. This value
* must equal the sum of the values in bucket_counts if a histogram is
* provided.
*/
count?: string;
/**
* Must be in increasing order of value field.
*/
exemplars?: Schema$Exemplar[];
/**
* The arithmetic mean of the values in the population. If count is zero
* then this field must be zero.
*/
mean?: number;
/**
* If specified, contains the range of the population values. The field must
* not be present if the count is zero. This field is presently ignored by
* the Stackdriver Monitoring API v3.
*/
range?: Schema$Range;
/**
* The sum of squared deviations from the mean of the values in the
* population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth,
* "The Art of Computer Programming", Vol. 2, page 323, 3rd
* edition describes Welford's method for accumulating this sum in one
* pass.If count is zero then this field must be zero.
*/
sumOfSquaredDeviation?: number;
}
/**
* A content string and a MIME type that describes the content string's
* format.
*/
interface Schema$Documentation {
/**
* The text of the documentation, interpreted according to mime_type. The
* content may not exceed 8,192 Unicode characters and may not exceed more
* than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.
*/
content?: string;
/**
* The format of the content field. Presently, only the value
* "text/markdown" is supported. See Markdown
* (https://en.wikipedia.org/wiki/Markdown) for more information.
*/
mimeType?: string;
}
/**
* A set of (label, value) pairs which were dropped during aggregation,
* attached to google.api.Distribution.Exemplars in google.api.Distribution
* values during aggregation.These values are used in combination with the
* label values that remain on the aggregated Distribution timeseries to
* construct the full label set for the exemplar values. The resulting full
* label set may be used to identify the specific task/job/instance (for
* example) which may be contributing to a long-tail, while allowing the
* storage savings of only storing aggregated distribution values for a large
* group.Note that there are no guarantees on ordering of the labels from
* exemplar-to-exemplar and from distribution-to-distribution in the same
* stream, and there may be duplicates. It is up to clients to resolve any
* ambiguities.
*/
interface Schema$DroppedLabels {
/**
* Map from label to its value, for all labels dropped in any aggregation.
*/
label?: {
[key: string]: string;
};
}
/**
* 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 {
}
/**
* Exemplars are example points that may be used to annotate aggregated
* distribution values. They are metadata that gives information about a
* particular value added to a Distribution bucket, such as a trace ID that
* was active when a value was added. They may contain further information,
* such as a example values and timestamps, origin, etc.
*/
interface Schema$Exemplar {
/**
* Contextual information about the example value. Examples are:Trace:
* type.googleapis.com/google.monitoring.v3.SpanContextLiteral string:
* type.googleapis.com/google.protobuf.StringValueLabels dropped during
* aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere
* may be only a single attachment of any given message type in a single
* exemplar, and this is enforced by the system.
*/
attachments?: Array<{
[key: string]: any;
}>;
/**
* The observation (sampling) time of the above value.
*/
timestamp?: string;
/**
* Value of the exemplar point. This value determines to which bucket the
* exemplar belongs.
*/
value?: number;
}
/**
* Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1
* (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i
* < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds
* field must contain at least one element. If bounds has only one element,
* then there are no finite buckets, and that single element is the common
* boundary of the overflow and underflow buckets.
*/
interface Schema$Explicit {
/**
* The values must be monotonically increasing.
*/
bounds?: number[];
}
/**
* Specifies an exponential sequence of buckets that have a width that is
* proportional to the value of the lower bound. Each bucket represents a
* constant relative uncertainty on a specific value in the bucket.There are
* num_finite_buckets + 2 (= N) buckets. Bucket i has the following
* boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
* Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
*/
interface Schema$Exponential {
/**
* Must be greater than 1.
*/
growthFactor?: number;
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number;
/**
* Must be greater than 0.
*/
scale?: number;
}
/**
* A single field of a message type.
*/
interface Schema$Field {
/**
* The field cardinality.
*/
cardinality?: string;
/**
* The string value of the default value of this field. Proto2 syntax only.
*/
defaultValue?: string;
/**
* The field JSON name.
*/
jsonName?: string;
/**
* The field type.
*/
kind?: string;
/**
* The field name.
*/
name?: string;
/**
* The field number.
*/
number?: number;
/**
* The index of the field type in Type.oneofs, for message or enumeration
* types. The first type has index 1; zero means the type is not in the
* list.
*/
oneofIndex?: number;
/**
* The protocol buffer options.
*/
options?: Schema$Option[];
/**
* Whether to use alternative packed wire representation.
*/
packed?: boolean;
/**
* The field type URL, without the scheme, for message or enumeration types.
* Example: "type.googleapis.com/google.protobuf.Timestamp".
*/
typeUrl?: string;
}
/**
* The GetNotificationChannelVerificationCode request.
*/
interface Schema$GetNotificationChannelVerificationCodeRequest {
/**
* The desired expiration time. If specified, the API will guarantee that
* the returned code will not be valid after the specified timestamp;
* however, the API cannot guarantee that the returned code will be valid
* for at least as long as the requested time (the API puts an upper bound
* on the amount of time for which a code may be valid). If omitted, a
* default expiration will be used, which may be less than the max
* permissible expiration (so specifying an expiration may extend the
* code's lifetime over omitting an expiration, even though the API does
* impose an upper limit on the maximum expiration that is permitted).
*/
expireTime?: string;
}
/**
* The GetNotificationChannelVerificationCode request.
*/
interface Schema$GetNotificationChannelVerificationCodeResponse {
/**
* The verification code, which may be used to verify other channels that
* have an equivalent identity (i.e. other channels of the same type with
* the same fingerprint such as other email channels with the same email
* address or other sms channels with the same number).
*/
code?: string;
/**
* The expiration time associated with the code that was returned. If an
* expiration was provided in the request, this is the minimum of the
* requested expiration in the request and the max permitted expiration.
*/
expireTime?: string;
}
/**
* The description of a dynamic collection of monitored resources. Each group
* has a filter that is matched against monitored resources and their
* associated metadata. If a group's filter matches an available monitored
* resource, then that resource is a member of that group. Groups can contain
* any number of monitored resources, and each monitored resource can be a
* member of any number of groups.Groups can be nested in parent-child
* hierarchies. The parentName field identifies an optional parent for each
* group. If a group has a parent, then the only monitored resources available
* to be matched by the group's filter are the resources contained in the
* parent group. In other words, a group contains the monitored resources that
* match its filter and the filters of all the group's ancestors. A group
* without a parent can contain any monitored resource.For example, consider
* an infrastructure running a set of instances with two user-defined tags:
* "environment" and "role". A parent group has a filter,
* environment="production". A child of that parent group has a
* filter, role="transcoder". The parent group contains all
* instances in the production environment, regardless of their roles. The
* child group contains instances that have the transcoder role and are in the
* production environment.The monitored resources contained in a group can
* change at any moment, depending on what resources exist and what filters
* are associated with the group and its ancestors.
*/
interface Schema$Group {
/**
* A user-assigned name for this group, used only for display purposes.
*/
displayName?: string;
/**
* The filter used to determine which monitored resources belong to this
* group.
*/
filter?: string;
/**
* If true, the members of this group are considered to be a cluster. The
* system can perform additional analysis on groups that are clusters.
*/
isCluster?: boolean;
/**
* Output only. The name of this group. The format is
* "projects/{project_id_or_number}/groups/{group_id}". When
* creating a group, this field is ignored and a new name is created
* consisting of the project specified in the call to CreateGroup and a
* unique {group_id} that is generated automatically.
*/
name?: string;
/**
* The name of the group's parent, if it has one. The format is
* "projects/{project_id_or_number}/groups/{group_id}". For groups
* with no parent, parentName is the empty string, "".
*/
parentName?: string;
}
/**
* Information involved in an HTTP/HTTPS uptime check request.
*/
interface Schema$HttpCheck {
/**
* The authentication information. Optional when creating an HTTP check;
* defaults to empty.
*/
authInfo?: Schema$BasicAuthentication;
/**
* The list of headers to send as part of the uptime check request. If two
* headers have the same key and different values, they should be entered as
* a single header, with the value being a comma-separated list of all the
* desired values as described at
* https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two
* separate headers with the same key in a Create call will cause the first
* to be overwritten by the second. The maximum number of headers allowed is
* 100.
*/
headers?: {
[key: string]: string;
};
/**
* Boolean specifiying whether to encrypt the header information. Encryption
* should be specified for any headers related to authentication that you do
* not wish to be seen when retrieving the configuration. The server will be
* responsible for encrypting the headers. On Get/List calls, if
* mask_headers is set to True then the headers will be obscured with
* ******.
*/
maskHeaders?: boolean;
/**
* The path to the page to run the check against. Will be combined with the
* host (specified within the MonitoredResource) and port to construct the
* full URL. Optional (defaults to "/"). If the provided path does
* not begin with "/", it will be prepended automatically.
*/
path?: string;
/**
* The port to the page to run the check against. Will be combined with host
* (specified within the MonitoredResource) and path to construct the full
* URL. Optional (defaults to 80 without SSL, or 443 with SSL).
*/
port?: number;
/**
* If true, use HTTPS instead of HTTP to run the check.
*/
useSsl?: boolean;
}
/**
* An internal checker allows uptime checks to run on private/internal GCP
* resources.
*/
interface Schema$InternalChecker {
/**
* The checker's human-readable name. The display name should be unique
* within a Stackdriver Workspace in order to make it easier to identify;
* however, uniqueness is not enforced.
*/
displayName?: string;
/**
* The GCP zone the uptime check should egress from. Only respected for
* internal uptime checks, where internal_network is specified.
*/
gcpZone?: string;
/**
* A unique resource name for this InternalChecker. The format
* is:projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].PROJECT_ID
* is the stackdriver workspace project for the uptime check config
* associated with the internal checker.
*/
name?: string;
/**
* The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the
* internal resource lives (ex: "default").
*/
network?: string;
/**
* The GCP project_id where the internal checker lives. Not necessary the
* same as the workspace project.
*/
peerProjectId?: string;
/**
* The current operational state of the internal checker.
*/
state?: string;
}
/**
* A description of a label.
*/
interface Schema$LabelDescriptor {
/**
* A human-readable description for the label.
*/
description?: string;
/**
* The label key.
*/
key?: string;
/**
* The type of data that can be assigned to the label.
*/
valueType?: string;
}
/**
* Specifies a linear sequence of buckets that all have the same width (except
* overflow and underflow). Each bucket represents a constant absolute
* uncertainty on the specific value in the bucket.There are
* num_finite_buckets + 2 (= N) buckets. Bucket i has the following
* boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower
* bound (1 <= i < N): offset + (width * (i - 1)).
*/
interface Schema$Linear {
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number;
/**
* Lower bound of the first bucket.
*/
offset?: number;
/**
* Must be greater than 0.
*/
width?: number;
}
/**
* The protocol for the ListAlertPolicies response.
*/
interface Schema$ListAlertPoliciesResponse {
/**
* The returned alert policies.
*/
alertPolicies?: Schema$AlertPolicy[];
/**
* If there might be more results than were returned, then this field is set
* to a non-empty value. To see the additional results, use that value as
* pageToken in the next call to this method.
*/
nextPageToken?: string;
}
/**
* The ListGroupMembers response.
*/
interface Schema$ListGroupMembersResponse {
/**
* A set of monitored resources in the group.
*/
members?: Schema$MonitoredResource[];
/**
* If there are more results than have been returned, then this field is set
* to a non-empty value. To see the additional results, use that value as
* pageToken in the next call to this method.
*/
nextPageToken?: string;
/**
* The total number of elements matching this request.
*/
totalSize?: number;
}
/**
* The ListGroups response.
*/
interface Schema$ListGroupsResponse {
/**
* The groups that match the specified filters.
*/
group?: Schema$Group[];
/**
* If there are more results than have been returned, then this field is set
* to a non-empty value. To see the additional results, use that value as
* pageToken in the next call to this method.
*/
nextPageToken?: string;
}
/**
* The ListMetricDescriptors response.
*/
interface Schema$ListMetricDescriptorsResponse {
/**
* The metric descriptors that are available to the project and that match
* the value of filter, if present.
*/
metricDescriptors?: Schema$MetricDescriptor[];
/**
* If there are more results than have been returned, then this field is set
* to a non-empty value. To see the additional results, use that value as
* pageToken in the next call to this method.
*/
nextPageToken?: string;
}
/**
* The ListMonitoredResourceDescriptors response.
*/
interface Schema$ListMonitoredResourceDescriptorsResponse {
/**
* If there are more results than have been returned, then this field is set
* to a non-empty value. To see the additional results, use that value as
* pageToken in the next call to this method.
*/
nextPageToken?: string;
/**
* The monitored resource descriptors that are available to this project and
* that match filter, if present.
*/
resourceDescriptors?: Schema$MonitoredResourceDescriptor[];
}
/**
* The ListNotificationChannelDescriptors response.
*/
interface Schema$ListNotificationChannelDescriptorsResponse {
/**
* The monitored resource descriptors supported for the specified project,
* optionally filtered.
*/
channelDescriptors?: Schema$NotificationChannelDescriptor[];
/**
* If not empty, indicates that there may be more results that match the
* request. Use the value in the page_token field in a subsequent request to
* fetch the next set of results. If empty, all results have been returned.
*/
nextPageToken?: string;
}
/**
* The ListNotificationChannels response.
*/
interface Schema$ListNotificationChannelsResponse {
/**
* If not empty, indicates that there may be more results that match the
* request. Use the value in the page_token field in a subsequent request to
* fetch the next set of results. If empty, all results have been returned.
*/
nextPageToken?: string;
/**
* The notification channels defined for the specified project.
*/
notificationChannels?: Schema$NotificationChannel[];
}
/**
* The ListTimeSeries response.
*/
interface Schema$ListTimeSeriesResponse {
/**
* Query execution errors that may have caused the time series data returned
* to be incomplete.
*/
executionErrors?: Schema$Status[];
/**
* If there are more results than have been returned, then this field is set
* to a non-empty value. To see the additional results, use that value as
* pageToken in the next call to this method.
*/
nextPageToken?: string;
/**
* One or more time series that match the filter included in the request.
*/
timeSeries?: Schema$TimeSeries[];
}
/**
* The protocol for the ListUptimeCheckConfigs response.
*/
interface Schema$ListUptimeCheckConfigsResponse {
/**
* This field represents the pagination token to retrieve the next page of
* results. If the value is empty, it means no further results for the
* request. To retrieve the next page of results, the value of the
* next_page_token is passed to the subsequent List method call (in the
* request message's page_token field).
*/
nextPageToken?: string;
/**
* The total number of uptime check configurations for the project,
* irrespective of any pagination.
*/
totalSize?: number;
/**
* The returned uptime check configurations.
*/
uptimeCheckConfigs?: Schema$UptimeCheckConfig[];
}
/**
* The protocol for the ListUptimeCheckIps response.
*/
interface Schema$ListUptimeCheckIpsResponse {
/**
* This field represents the pagination token to retrieve the next page of
* results. If the value is empty, it means no further results for the
* request. To retrieve the next page of results, the value of the
* next_page_token is passed to the subsequent List method call (in the
* request message's page_token field). NOTE: this field is not yet
* implemented
*/
nextPageToken?: string;
/**
* The returned list of IP addresses (including region and location) that
* the checkers run from.
*/
uptimeCheckIps?: Schema$UptimeCheckIp[];
}
/**
* A specific metric, identified by specifying values for all of the labels of
* a MetricDescriptor.
*/
interface Schema$Metric {
/**
* The set of label values that uniquely identify this metric. All labels
* listed in the MetricDescriptor must be assigned values.
*/
labels?: {
[key: string]: string;
};
/**
* An existing metric type, see google.api.MetricDescriptor. For example,
* custom.googleapis.com/invoice/paid/amount.
*/
type?: string;
}
/**
* A condition type that checks that monitored resources are reporting data.
* The configuration defines a metric and a set of monitored resources. The
* predicate is considered in violation when a time series for the specified
* metric of a monitored resource does not include any data in the specified
* duration.
*/
interface Schema$MetricAbsence {
/**
* Specifies the alignment of data points in individual time series as well
* as how to combine the retrieved time series together (such as when
* aggregating multiple streams on each resource to a single stream for each
* resource or when aggregating streams across all members of a group of
* resrouces). Multiple aggregations are applied in the order specified.This
* field is similar to the one in the MetricService.ListTimeSeries request.
* It is advisable to use the ListTimeSeries method when debugging this
* field.
*/
aggregations?: Schema$Aggregation[];
/**
* The amount of time that a time series must fail to report new data to be
* considered failing. Currently, only values that are a multiple of a
* minute--e.g. 60, 120, or 300 seconds--are supported. If an invalid value
* is given, an error will be returned. The Duration.nanos field is ignored.
*/
duration?: string;
/**
* A filter that identifies which time series should be compared with the
* threshold.The filter is similar to the one that is specified in the
* MetricService.ListTimeSeries request (that call is useful to verify the
* time series that will be retrieved / processed) and must specify the
* metric type and optionally may contain restrictions on resource type,
* resource labels, and metric labels. This field may not exceed 2048
* Unicode characters in length.
*/
filter?: string;
/**
* The number/percent of time series for which the comparison must hold in
* order for the condition to trigger. If unspecified, then the condition
* will trigger if the comparison is true for any of the time series that
* have been identified by filter and aggregations.
*/
trigger?: Schema$Trigger;
}
/**
* Defines a metric type and its schema. Once a metric descriptor is created,
* deleting or altering it stops data collection and makes the metric
* type's existing data unusable.
*/
interface Schema$MetricDescriptor {
/**
* A detailed description of the metric, which can be used in documentation.
*/
description?: string;
/**
* A concise name for the metric, which can be displayed in user interfaces.
* Use sentence case without an ending period, for example "Request
* count". This field is optional but it is recommended to be set for
* any metrics associated with user-visible concepts, such as Quota.
*/
displayName?: string;
/**
* The set of labels that can be used to describe a specific instance of
* this metric type. For example, the
* appengine.googleapis.com/http/server/response_latencies metric type has a
* label for the HTTP response code, response_code, so you can look at
* latencies for successful responses or just for responses that failed.
*/
labels?: Schema$LabelDescriptor[];
/**
* Optional. Metadata which can be used to guide usage of the metric.
*/
metadata?: Schema$MetricDescriptorMetadata;
/**
* Whether the metric records instantaneous values, changes to a value, etc.
* Some combinations of metric_kind and value_type might not be supported.
*/
metricKind?: string;
/**
* The resource name of the metric descriptor.
*/
name?: string;
/**
* The metric type, including its DNS name prefix. The type is not
* URL-encoded. All user-defined metric types have the DNS name
* custom.googleapis.com or external.googleapis.com. Metric types should use
* a natural hierarchical grouping. For example:
* "custom.googleapis.com/invoice/paid/amount"
* "external.googleapis.com/prometheus/up"
* "appengine.googleapis.com/http/server/response_latencies"
*/
type?: string;
/**
* The unit in which the metric value is reported. It is only applicable if
* the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are
* a subset of The Unified Code for Units of Measure
* (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit
* By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3)
* M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa
* (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro
* (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto
* (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi
* (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes
* these connectors: / division (as an infix operator, e.g. 1/s). .
* multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit
* is as follows: Expression = Component { "." Component } {
* "/" Component } ; Component = ( [ PREFIX ] UNIT |
* "%" ) [ Annotation ] | Annotation |
* "1" ; Annotation = "{" NAME "}"
* ; Notes: Annotation is just a comment if it follows a UNIT and is
* equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s,
* By{transmitted}/s == By/s. NAME is a sequence of non-blank printable
* ASCII characters not containing '{' or '}'. 1 represents
* dimensionless value 1, such as in 1/s. % represents dimensionless value
* 1/100, and annotates values giving a percentage.
*/
unit?: string;
/**
* Whether the measurement is an integer, a floating-point number, etc. Some
* combinations of metric_kind and value_type might not be supported.
*/
valueType?: string;
}
/**
* Additional annotations that can be used to guide the usage of a metric.
*/
interface Schema$MetricDescriptorMetadata {
/**
* The delay of data points caused by ingestion. Data points older than this
* age are guaranteed to be ingested and available to be read, excluding
* data loss due to errors.
*/
ingestDelay?: string;
/**
* The launch stage of the metric definition.
*/
launchStage?: string;
/**
* The sampling period of metric data points. For metrics which are written
* periodically, consecutive data points are stored at this time interval,
* excluding data loss due to errors. Metrics with a higher granularity have
* a smaller sampling period.
*/
samplePeriod?: string;
}
/**
* A condition type that compares a collection of time series against a
* threshold.
*/
interface Schema$MetricThreshold {
/**
* Specifies the alignment of data points in individual time series as well
* as how to combine the retrieved time series together (such as when
* aggregating multiple streams on each resource to a single stream for each
* resource or when aggregating streams across all members of a group of
* resrouces). Multiple aggregations are applied in the order specified.This
* field is similar to the one in the MetricService.ListTimeSeries request.
* It is advisable to use the ListTimeSeries method when debugging this
* field.
*/
aggregations?: Schema$Aggregation[];
/**
* The comparison to apply between the time series (indicated by filter and
* aggregation) and the threshold (indicated by threshold_value). The
* comparison is applied on each time series, with the time series on the
* left-hand side and the threshold on the right-hand side.Only
* COMPARISON_LT and COMPARISON_GT are supported currently.
*/
comparison?: string;
/**
* Specifies the alignment of data points in individual time series selected
* by denominatorFilter as well as how to combine the retrieved time series
* together (such as when aggregating multiple streams on each resource to a
* single stream for each resource or when aggregating streams across all
* members of a group of resources).When computing ratios, the aggregations
* and denominator_aggregations fields must use the same alignment period
* and produce time series that have the same periodicity and labels.This
* field is similar to the one in the MetricService.ListTimeSeries request.
* It is advisable to use the ListTimeSeries method when debugging this
* field.
*/
denominatorAggregations?: Schema$Aggregation[];
/**
* A filter that identifies a time series that should be used as the
* denominator of a ratio that will be compared with the threshold. If a
* denominator_filter is specified, the time series specified by the filter
* field will be used as the numerator.The filter is similar to the one that
* is specified in the MetricService.ListTimeSeries request (that call is
* useful to verify the time series that will be retrieved / processed) and
* must specify the metric type and optionally may contain restrictions on
* resource type, resource labels, and metric labels. This field may not
* exceed 2048 Unicode characters in length.
*/
denominatorFilter?: string;
/**
* The amount of time that a time series must violate the threshold to be
* considered failing. Currently, only values that are a multiple of a
* minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid
* value is given, an error will be returned. When choosing a duration, it
* is useful to keep in mind the frequency of the underlying time series
* data (which may also be affected by any alignments specified in the
* aggregations field); a good duration is long enough so that a single
* outlier does not generate spurious alerts, but short enough that
* unhealthy states are detected and alerted on quickly.
*/
duration?: string;
/**
* A filter that identifies which time series should be compared with the
* threshold.The filter is similar to the one that is specified in the
* MetricService.ListTimeSeries request (that call is useful to verify the
* time series that will be retrieved / processed) and must specify the
* metric type and optionally may contain restrictions on resource type,
* resource labels, and metric labels. This field may not exceed 2048
* Unicode characters in length.
*/
filter?: string;
/**
* A value against which to compare the time series.
*/
thresholdValue?: number;
/**
* The number/percent of time series for which the comparison must hold in
* order for the condition to trigger. If unspecified, then the condition
* will trigger if the comparison is true for any of the time series that
* have been identified by filter and aggregations, or by the ratio, if
* denominator_filter and denominator_aggregations are specified.
*/
trigger?: Schema$Trigger;
}
/**
* An object representing a resource that can be used for monitoring, logging,
* billing, or other purposes. Examples include virtual machine instances,
* databases, and storage devices such as disks. The type field identifies a
* MonitoredResourceDescriptor object that describes the resource's
* schema. Information in the labels field identifies the actual resource and
* its attributes according to the schema. For example, a particular Compute
* Engine VM instance could be represented by the following object, because
* the MonitoredResourceDescriptor for "gce_instance" has labels
* "instance_id" and "zone": { "type":
* "gce_instance", "labels": { "instance_id":
* "12345678901234", "zone":
* "us-central1-a" }}
*/
interface Schema$MonitoredResource {
/**
* Required. Values for all of the labels listed in the associated monitored
* resource descriptor. For example, Compute Engine VM instances use the
* labels "project_id", "instance_id", and
* "zone".
*/
labels?: {
[key: string]: string;
};
/**
* Required. The monitored resource type. This field must match the type
* field of a MonitoredResourceDescriptor object. For example, the type of a
* Compute Engine VM instance is gce_instance. For a list of types, see
* Monitoring resource types and Logging resource types.
*/
type?: string;
}
/**
* An object that describes the schema of a MonitoredResource object using a
* type name and a set of labels. For example, the monitored resource
* descriptor for Google Compute Engine VM instances has a type of
* "gce_instance" and specifies the use of the labels
* "instance_id" and "zone" to identify particular VM
* instances.Different APIs can support different monitored resource types.
* APIs generally provide a list method that returns the monitored resource
* descriptors used by the API.
*/
interface Schema$MonitoredResourceDescriptor {
/**
* Optional. A detailed description of the monitored resource type that
* might be used in documentation.
*/
description?: string;
/**
* Optional. A concise name for the monitored resource type that might be
* displayed in user interfaces. It should be a Title Cased Noun Phrase,
* without any article or other determiners. For example, "Google Cloud
* SQL Database".
*/
displayName?: string;
/**
* Required. A set of labels used to describe instances of this monitored
* resource type. For example, an individual Google Cloud SQL database is
* identified by values for the labels "database_id" and
* "zone".
*/
labels?: Schema$LabelDescriptor[];
/**
* Optional. The resource name of the monitored resource descriptor:
* "projects/{project_id}/monitoredResourceDescriptors/{type}"
* where {type} is the value of the type field in this object and
* {project_id} is a project ID that provides API-specific context for
* accessing the type. APIs that do not use project information can use the
* resource name format "monitoredResourceDescriptors/{type}".
*/
name?: string;
/**
* Required. The monitored resource type. For example, the type
* "cloudsql_database" represents databases in Google Cloud SQL.
* The maximum length of this value is 256 characters.
*/
type?: string;
}
/**
* Auxiliary metadata for a MonitoredResource object. MonitoredResource
* objects contain the minimum set of information to uniquely identify a
* monitored resource instance. There is some other useful auxiliary metadata.
* Monitoring and Logging use an ingestion pipeline to extract metadata for
* cloud resources of all types, and store the metadata in this message.
*/
interface Schema$MonitoredResourceMetadata {
/**
* Output only. Values for predefined system metadata labels. System labels
* are a kind of metadata extracted by Google, including
* "machine_image", "vpc", "subnet_id",
* "security_group", "name", etc. System label values
* can be only strings, Boolean values, or a list of strings. For example: {
* "name": "my-test-instance",
* "security_group": ["a", "b",
* "c"], "spot_instance": false }
*/
systemLabels?: {
[key: string]: any;
};
/**
* Output only. A map of user-defined metadata labels.
*/
userLabels?: {
[key: string]: string;
};
}
/**
* Describes a change made to a configuration.
*/
interface Schema$MutationRecord {
/**
* The email address of the user making the change.
*/
mutatedBy?: string;
/**
* When the change occurred.
*/
mutateTime?: string;
}
/**
* A NotificationChannel is a medium through which an alert is delivered when
* a policy violation is detected. Examples of channels include email, SMS,
* and third-party messaging applications. Fields containing sensitive
* information like authentication tokens or contact info are only partially
* populated on retrieval.
*/
interface Schema$NotificationChannel {
/**
* An optional human-readable description of this notification channel. This
* description may provide additional details, beyond the display name, for
* the channel. This may not exceed 1024 Unicode characters.
*/
description?: string;
/**
* An optional human-readable name for this notification channel. It is
* recommended that you specify a non-empty and unique name in order to make
* it easier to identify the channels in your project, though this is not
* enforced. The display name is limited to 512 Unicode characters.
*/
displayName?: string;
/**
* Whether notifications are forwarded to the described channel. This makes
* it possible to disable delivery of notifications to a particular channel
* without removing the channel from all alerting policies that reference
* the channel. This is a more convenient approach when the change is
* temporary and you want to receive notifications from the same set of
* alerting policies on the channel at some point in the future.
*/
enabled?: boolean;
/**
* Configuration fields that define the channel and its behavior. The
* permissible and required labels are specified in the
* NotificationChannelDescriptor.labels of the NotificationChannelDescriptor
* corresponding to the type field.
*/
labels?: {
[key: string]: string;
};
/**
* The full REST resource name for this channel. The syntax is:
* projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID]
* is automatically assigned by the server on creation.
*/
name?: string;
/**
* The type of the notification channel. This field matches the value of the
* NotificationChannelDescriptor.type field.
*/
type?: string;
/**
* User-supplied key/value data that does not need to conform to the
* corresponding NotificationChannelDescriptor's schema, unlike the
* labels field. This field is intended to be used for organizing and
* identifying the NotificationChannel objects.The field can contain up to
* 64 entries. Each key and value is limited to 63 Unicode characters or 128
* bytes, whichever is smaller. Labels and values can contain only lowercase
* letters, numerals, underscores, and dashes. Keys must begin with a
* letter.
*/
userLabels?: {
[key: string]: string;
};
/**
* Indicates whether this channel has been verified or not. On a
* ListNotificationChannels or GetNotificationChannel operation, this field
* is expected to be populated.If the value is UNVERIFIED, then it indicates
* that the channel is non-functioning (it both requires verification and
* lacks verification); otherwise, it is assumed that the channel works.If
* the channel is neither VERIFIED nor UNVERIFIED, it implies that the
* channel is of a type that does not require verification or that this
* specific channel has been exempted from verification because it was
* created prior to verification being required for channels of this
* type.This field cannot be modified using a standard
* UpdateNotificationChannel operation. To change the value of this field,
* you must call VerifyNotificationChannel.
*/
verificationStatus?: string;
}
/**
* A description of a notification channel. The descriptor includes the
* properties of the channel and the set of labels or fields that must be
* specified to configure channels of a given type.
*/
interface Schema$NotificationChannelDescriptor {
/**
* A human-readable description of the notification channel type. The
* description may include a description of the properties of the channel
* and pointers to external documentation.
*/
description?: string;
/**
* A human-readable name for the notification channel type. This form of the
* name is suitable for a user interface.
*/
displayName?: string;
/**
* The set of labels that must be defined to identify a particular channel
* of the corresponding type. Each label includes a description for how that
* field should be populated.
*/
labels?: Schema$LabelDescriptor[];
/**
* The full REST resource name for this descriptor. The syntax is:
* projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above,
* [TYPE] is the value of the type field.
*/
name?: string;
/**
* The tiers that support this notification channel; the project service
* tier must be one of the supported_tiers.
*/
supportedTiers?: string[];
/**
* The type of notification channel, such as "email",
* "sms", etc. Notification channel types are globally unique.
*/
type?: string;
}
/**
* A protocol buffer option, which can be attached to a message, field,
* enumeration, etc.
*/
interface Schema$Option {
/**
* The option's name. For protobuf built-in options (options defined in
* descriptor.proto), this is the short name. For example,
* "map_entry". For custom options, it should be the
* fully-qualified name. For example, "google.api.http".
*/
name?: string;
/**
* The option's value packed in an Any message. If the value is a
* primitive, the corresponding wrapper type defined in
* google/protobuf/wrappers.proto should be used. If the value is an enum,
* it should be stored as an int32 value using the
* google.protobuf.Int32Value type.
*/
value?: {
[key: string]: any;
};
}
/**
* A single data point in a time series.
*/
interface Schema$Point {
/**
* The time interval to which the data point applies. For GAUGE metrics,
* only the end time of the interval is used. For DELTA metrics, the start
* and end time should specify a non-zero interval, with subsequent points
* specifying contiguous and non-overlapping intervals. For CUMULATIVE
* metrics, the start and end time should specify a non-zero interval, with
* subsequent points specifying the same start time and increasing end
* times, until an event resets the cumulative value to zero and sets a new
* start time for the following points.
*/
interval?: Schema$TimeInterval;
/**
* The value of the data point.
*/
value?: Schema$TypedValue;
}
/**
* The range of the population values.
*/
interface Schema$Range {
/**
* The maximum of the population values.
*/
max?: number;
/**
* The minimum of the population values.
*/
min?: number;
}
/**
* The resource submessage for group checks. It can be used instead of a
* monitored resource, when multiple resources are being monitored.
*/
interface Schema$ResourceGroup {
/**
* The group of resources being monitored. Should be only the group_id, not
* projects/<project_id>/groups/<group_id>.
*/
groupId?: string;
/**
* The resource type of the group members.
*/
resourceType?: string;
}
/**
* The SendNotificationChannelVerificationCode request.
*/
interface Schema$SendNotificationChannelVerificationCodeRequest {
}
/**
* SourceContext represents information about the source of a protobuf
* element, like the file in which it is defined.
*/
interface Schema$SourceContext {
/**
* The path-qualified name of the .proto file that contained the associated
* protobuf element. For example:
* "google/protobuf/source_context.proto".
*/
fileName?: string;
}
/**
* The context of a span, attached to google.api.Distribution.Exemplars in
* google.api.Distribution values during aggregation.It contains the name of a
* span with format: projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID
*/
interface Schema$SpanContext {
/**
* The resource name of the span in the following format:
* projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] TRACE_ID is a
* unique identifier for a trace within a project; it is a 32-character
* hexadecimal encoding of a 16-byte array.SPAN_ID is a unique identifier
* for a span within a trace; it is a 16-character hexadecimal encoding of
* an 8-byte array.
*/
spanName?: 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;
}
/**
* Information required for a TCP uptime check request.
*/
interface Schema$TcpCheck {
/**
* The port to the page to run the check against. Will be combined with host
* (specified within the MonitoredResource) to construct the full URL.
* Required.
*/
port?: number;
}
/**
* A time interval extending just after a start time through an end time. The
* start time must not be later than the end time. The default start time is
* the end time, making the startTime value technically optional. Whether this
* is useful depends on the MetricKind. If the start and end times are the
* same, the interval represents a point in time. This is appropriate for
* GAUGE metrics, but not for DELTA and CUMULATIVE metrics, which cover a span
* of time.
*/
interface Schema$TimeInterval {
/**
* Required. The end of the time interval.
*/
endTime?: string;
/**
* Optional. The beginning of the time interval. The default value for the
* start time is the end time. The start time must not be later than the end
* time.
*/
startTime?: string;
}
/**
* A collection of data points that describes the time-varying values of a
* metric. A time series is identified by a combination of a fully-specified
* monitored resource and a fully-specified metric. This type is used for both
* listing and creating time series.
*/
interface Schema$TimeSeries {
/**
* Output only. The associated monitored resource metadata. When reading a a
* timeseries, this field will include metadata labels that are explicitly
* named in the reduction. When creating a timeseries, this field is
* ignored.
*/
metadata?: Schema$MonitoredResourceMetadata;
/**
* The associated metric. A fully-specified metric used to identify the time
* series.
*/
metric?: Schema$Metric;
/**
* The metric kind of the time series. When listing time series, this metric
* kind might be different from the metric kind of the associated metric if
* this time series is an alignment or reduction of other time series.When
* creating a time series, this field is optional. If present, it must be
* the same as the metric kind of the associated metric. If the associated
* metric's descriptor must be auto-created, then this field specifies
* the metric kind of the new descriptor and must be either GAUGE (the
* default) or CUMULATIVE.
*/
metricKind?: string;
/**
* The data points of this time series. When listing time series, points are
* returned in reverse time order.When creating a time series, this field
* must contain exactly one point and the point's type must be the same
* as the value type of the associated metric. If the associated
* metric's descriptor must be auto-created, then the value type of the
* descriptor is determined by the point's type, which must be BOOL,
* INT64, DOUBLE, or DISTRIBUTION.
*/
points?: Schema$Point[];
/**
* The associated monitored resource. Custom metrics can use only certain
* monitored resource types in their time series data.
*/
resource?: Schema$MonitoredResource;
/**
* The value type of the time series. When listing time series, this value
* type might be different from the value type of the associated metric if
* this time series is an alignment or reduction of other time series.When
* creating a time series, this field is optional. If present, it must be
* the same as the type of the data in the points field.
*/
valueType?: string;
}
/**
* Specifies how many time series must fail a predicate to trigger a
* condition. If not specified, then a {count: 1} trigger is used.
*/
interface Schema$Trigger {
/**
* The absolute number of time series that must fail the predicate for the
* condition to be triggered.
*/
count?: number;
/**
* The percentage of time series that must fail the predicate for the
* condition to be triggered.
*/
percent?: number;
}
/**
* A protocol buffer message type.
*/
interface Schema$Type {
/**
* The list of fields.
*/
fields?: Schema$Field[];
/**
* The fully qualified message name.
*/
name?: string;
/**
* The list of types appearing in oneof definitions in this type.
*/
oneofs?: string[];
/**
* The protocol buffer options.
*/
options?: Schema$Option[];
/**
* The source context.
*/
sourceContext?: Schema$SourceContext;
/**
* The source syntax.
*/
syntax?: string;
}
/**
* A single strongly-typed value.
*/
interface Schema$TypedValue {
/**
* A Boolean value: true or false.
*/
boolValue?: boolean;
/**
* A distribution value.
*/
distributionValue?: Schema$Distribution;
/**
* A 64-bit double-precision floating-point number. Its magnitude is
* approximately &plusmn;10<sup>&plusmn;300</sup> and it
* has 16 significant digits of precision.
*/
doubleValue?: number;
/**
* A 64-bit integer. Its range is approximately
* &plusmn;9.2x10<sup>18</sup>.
*/
int64Value?: string;
/**
* A variable-length string value.
*/
stringValue?: string;
}
/**
* This message configures which resources and services to monitor for
* availability.
*/
interface Schema$UptimeCheckConfig {
/**
* The expected content on the page the check is run against. Currently,
* only the first entry in the list is supported, and other entries will be
* ignored. The server will look for an exact match of the string in the
* page response's content. This field is optional and should only be
* specified if a content match is required.
*/
contentMatchers?: Schema$ContentMatcher[];
/**
* A human-friendly name for the uptime check configuration. The display
* name should be unique within a Stackdriver Workspace in order to make it
* easier to identify; however, uniqueness is not enforced. Required.
*/
displayName?: string;
/**
* Contains information needed to make an HTTP or HTTPS check.
*/
httpCheck?: Schema$HttpCheck;
/**
* The internal checkers that this check will egress from. If is_internal is
* true and this list is empty, the check will egress from all the
* InternalCheckers configured for the project that owns this CheckConfig.
*/
internalCheckers?: Schema$InternalChecker[];
/**
* The monitored resource
* (https://cloud.google.com/monitoring/api/resources) associated with the
* configuration. The following monitored resource types are supported for
* uptime checks: uptime_url gce_instance gae_app aws_ec2_instance
* aws_elb_load_balancer
*/
monitoredResource?: Schema$MonitoredResource;
/**
* A unique resource name for this UptimeCheckConfig. The format
* is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field
* should be omitted when creating the uptime check configuration; on
* create, the resource name is assigned by the server and included in the
* response.
*/
name?: string;
/**
* How often, in seconds, the uptime check is performed. Currently, the only
* supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes),
* and 900s (15 minutes). Optional, defaults to 60s.
*/
period?: string;
/**
* The group resource associated with the configuration.
*/
resourceGroup?: Schema$ResourceGroup;
/**
* The list of regions from which the check will be run. Some regions
* contain one location, and others contain more than one. If this field is
* specified, enough regions to include a minimum of 3 locations must be
* provided, or an error message is returned. Not specifying this field will
* result in uptime checks running from all regions.
*/
selectedRegions?: string[];
/**
* Contains information needed to make a TCP check.
*/
tcpCheck?: Schema$TcpCheck;
/**
* The maximum amount of time to wait for the request to complete (must be
* between 1 and 60 seconds). Required.
*/
timeout?: string;
}
/**
* Contains the region, location, and list of IP addresses where checkers in
* the location run from.
*/
interface Schema$UptimeCheckIp {
/**
* The IP address from which the uptime check originates. This is a full IP
* address (not an IP address range). Most IP addresses, as of this
* publication, are in IPv4 format; however, one should not rely on the IP
* addresses being in IPv4 format indefinitely and should support
* interpreting this field in either IPv4 or IPv6 format.
*/
ipAddress?: string;
/**
* A more specific location within the region that typically encodes a
* particular city/town/metro (and its containing state/province or country)
* within the broader umbrella region category.
*/
location?: string;
/**
* A broad region category in which the IP address is located.
*/
region?: string;
}
/**
* The VerifyNotificationChannel request.
*/
interface Schema$VerifyNotificationChannelRequest {
/**
* The verification code that was delivered to the channel as a result of
* invoking the SendNotificationChannelVerificationCode API method or that
* was retrieved from a verified channel via
* GetNotificationChannelVerificationCode. For example, one might have
* "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general,
* one is only guaranteed that the code is valid UTF-8; one should not make
* any assumptions regarding the structure or format of the code).
*/
code?: string;
}
class Resource$Projects {
context: APIRequestContext;
alertPolicies: Resource$Projects$Alertpolicies;
collectdTimeSeries: Resource$Projects$Collectdtimeseries;
groups: Resource$Projects$Groups;
metricDescriptors: Resource$Projects$Metricdescriptors;
monitoredResourceDescriptors: Resource$Projects$Monitoredresourcedescriptors;
notificationChannelDescriptors: Resource$Projects$Notificationchanneldescriptors;
notificationChannels: Resource$Projects$Notificationchannels;
timeSeries: Resource$Projects$Timeseries;
uptimeCheckConfigs: Resource$Projects$Uptimecheckconfigs;
constructor(context: APIRequestContext);
}
class Resource$Projects$Alertpolicies {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.alertPolicies.create
* @desc Creates a new alerting policy.
* @alias monitoring.projects.alertPolicies.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The project in which to create the alerting policy. The format is projects/[PROJECT_ID].Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container.
* @param {().AlertPolicy} 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$Projects$Alertpolicies$Create, options?: MethodOptions): GaxiosPromise<Schema$AlertPolicy>;
create(params: Params$Resource$Projects$Alertpolicies$Create, options: MethodOptions | BodyResponseCallback<Schema$AlertPolicy>, callback: BodyResponseCallback<Schema$AlertPolicy>): void;
create(params: Params$Resource$Projects$Alertpolicies$Create, callback: BodyResponseCallback<Schema$AlertPolicy>): void;
create(callback: BodyResponseCallback<Schema$AlertPolicy>): void;
/**
* monitoring.projects.alertPolicies.delete
* @desc Deletes an alerting policy.
* @alias monitoring.projects.alertPolicies.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy.
* @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$Projects$Alertpolicies$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Alertpolicies$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Alertpolicies$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* monitoring.projects.alertPolicies.get
* @desc Gets a single alerting policy.
* @alias monitoring.projects.alertPolicies.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
* @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$Projects$Alertpolicies$Get, options?: MethodOptions): GaxiosPromise<Schema$AlertPolicy>;
get(params: Params$Resource$Projects$Alertpolicies$Get, options: MethodOptions | BodyResponseCallback<Schema$AlertPolicy>, callback: BodyResponseCallback<Schema$AlertPolicy>): void;
get(params: Params$Resource$Projects$Alertpolicies$Get, callback: BodyResponseCallback<Schema$AlertPolicy>): void;
get(callback: BodyResponseCallback<Schema$AlertPolicy>): void;
/**
* monitoring.projects.alertPolicies.list
* @desc Lists the existing alerting policies for the project.
* @alias monitoring.projects.alertPolicies.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering.
* @param {string} params.name The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.
* @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering.
* @param {integer=} params.pageSize The maximum number of results to return in a single response.
* @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.
* @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$Projects$Alertpolicies$List, options?: MethodOptions): GaxiosPromise<Schema$ListAlertPoliciesResponse>;
list(params: Params$Resource$Projects$Alertpolicies$List, options: MethodOptions | BodyResponseCallback<Schema$ListAlertPoliciesResponse>, callback: BodyResponseCallback<Schema$ListAlertPoliciesResponse>): void;
list(params: Params$Resource$Projects$Alertpolicies$List, callback: BodyResponseCallback<Schema$ListAlertPoliciesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAlertPoliciesResponse>): void;
/**
* monitoring.projects.alertPolicies.patch
* @desc Updates an alerting policy. You can either replace the entire
* policy with a new one or replace only certain fields in the current
* alerting policy by specifying the fields to be updated via updateMask.
* Returns the updated alerting policy.
* @alias monitoring.projects.alertPolicies.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
* @param {string=} params.updateMask Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created.
* @param {().AlertPolicy} 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$Projects$Alertpolicies$Patch, options?: MethodOptions): GaxiosPromise<Schema$AlertPolicy>;
patch(params: Params$Resource$Projects$Alertpolicies$Patch, options: MethodOptions | BodyResponseCallback<Schema$AlertPolicy>, callback: BodyResponseCallback<Schema$AlertPolicy>): void;
patch(params: Params$Resource$Projects$Alertpolicies$Patch, callback: BodyResponseCallback<Schema$AlertPolicy>): void;
patch(callback: BodyResponseCallback<Schema$AlertPolicy>): void;
}
interface Params$Resource$Projects$Alertpolicies$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project in which to create the alerting policy. The format is
* projects/[PROJECT_ID].Note that this field names the parent container in
* which the alerting policy will be written, not the name of the created
* policy. The alerting policy that is returned will have a name that
* contains a normalized representation of this name as a prefix but adds a
* suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in
* the container.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AlertPolicy;
}
interface Params$Resource$Projects$Alertpolicies$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The alerting policy to delete. The format is:
* projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more
* information, see AlertPolicy.
*/
name?: string;
}
interface Params$Resource$Projects$Alertpolicies$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The alerting policy to retrieve. The format is
* projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
*/
name?: string;
}
interface Params$Resource$Projects$Alertpolicies$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If provided, this field specifies the criteria that must be met by alert
* policies to be included in the response.For more details, see sorting and
* filtering.
*/
filter?: string;
/**
* The project whose alert policies are to be listed. The format is
* projects/[PROJECT_ID] Note that this field names the parent container in
* which the alerting policies to be listed are stored. To retrieve a single
* alerting policy by name, use the GetAlertPolicy operation, instead.
*/
name?: string;
/**
* A comma-separated list of fields by which to sort the result. Supports
* the same set of field references as the filter field. Entries can be
* prefixed with a minus sign to sort by the field in descending order.For
* more details, see sorting and filtering.
*/
orderBy?: string;
/**
* The maximum number of results to return in a single response.
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value
* returned by a previous call to this method. Using this field causes the
* method to return more results from the previous method call.
*/
pageToken?: string;
}
interface Params$Resource$Projects$Alertpolicies$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required if the policy exists. The resource name for this policy. The
* syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
* [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy
* is created. When calling the alertPolicies.create method, do not include
* the name field in the alerting policy passed as part of the request.
*/
name?: string;
/**
* Optional. A list of alerting policy field names. If this field is not
* empty, each listed field in the existing alerting policy is set to the
* value of the corresponding field in the supplied policy (alert_policy),
* or to the field's default value if the field is not in the supplied
* alerting policy. Fields not listed retain their previous value.Examples
* of valid field masks include display_name, documentation,
* documentation.content, documentation.mime_type, user_labels,
* user_label.nameofkey, enabled, conditions, combiner, etc.If this field is
* empty, then the supplied alerting policy replaces the existing policy. It
* is the same as deleting the existing policy and adding the supplied
* policy, except for the following: The new policy will have the same
* [ALERT_POLICY_ID] as the former policy. This gives you continuity with
* the former policy in your notifications and incidents. Conditions in the
* new policy will keep their former [CONDITION_ID] if the supplied
* condition includes the name field with that [CONDITION_ID]. If the
* supplied condition omits the name field, then a new [CONDITION_ID] is
* created.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AlertPolicy;
}
class Resource$Projects$Collectdtimeseries {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.collectdTimeSeries.create
* @desc Stackdriver Monitoring Agent only: Creates a new time series.<aside
* class="caution">This method is only for use by the Stackdriver Monitoring
* Agent. Use projects.timeSeries.create instead.</aside>
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'create' method:
*
* // The project in which to create the time series. The format is
* `"projects/PROJECT_ID_OR_NUMBER"`. name: "projects/{MY-PROJECT}",
* resource: {},
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.collectdTimeSeries.create(request, function(err,
* result) { if (err) { console.log(err); } else { console.log(result);
* }
* });
* });
* @alias monitoring.projects.collectdTimeSeries.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The project in which to create the time series. The format is "projects/PROJECT_ID_OR_NUMBER".
* @param {().CreateCollectdTimeSeriesRequest} 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$Projects$Collectdtimeseries$Create, options?: MethodOptions): GaxiosPromise<Schema$CreateCollectdTimeSeriesResponse>;
create(params: Params$Resource$Projects$Collectdtimeseries$Create, options: MethodOptions | BodyResponseCallback<Schema$CreateCollectdTimeSeriesResponse>, callback: BodyResponseCallback<Schema$CreateCollectdTimeSeriesResponse>): void;
create(params: Params$Resource$Projects$Collectdtimeseries$Create, callback: BodyResponseCallback<Schema$CreateCollectdTimeSeriesResponse>): void;
create(callback: BodyResponseCallback<Schema$CreateCollectdTimeSeriesResponse>): void;
}
interface Params$Resource$Projects$Collectdtimeseries$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project in which to create the time series. The format is
* "projects/PROJECT_ID_OR_NUMBER".
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateCollectdTimeSeriesRequest;
}
class Resource$Projects$Groups {
context: APIRequestContext;
members: Resource$Projects$Groups$Members;
constructor(context: APIRequestContext);
/**
* monitoring.projects.groups.create
* @desc Creates a new group.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'create' method:
*
* // The project in which to create the group. The format is
* `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}",
* resource: {},
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.groups.create(request, function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* }
* });
* });
* @alias monitoring.projects.groups.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The project in which to create the group. The format is "projects/{project_id_or_number}".
* @param {boolean=} params.validateOnly If true, validate this request but do not create the group.
* @param {().Group} 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$Projects$Groups$Create, options?: MethodOptions): GaxiosPromise<Schema$Group>;
create(params: Params$Resource$Projects$Groups$Create, options: MethodOptions | BodyResponseCallback<Schema$Group>, callback: BodyResponseCallback<Schema$Group>): void;
create(params: Params$Resource$Projects$Groups$Create, callback: BodyResponseCallback<Schema$Group>): void;
create(callback: BodyResponseCallback<Schema$Group>): void;
/**
* monitoring.projects.groups.delete
* @desc Deletes an existing group.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'delete' method:
*
* // The group to delete. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`. name:
* "projects/{MY-PROJECT}/groups/{MY-GROUP}",
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.groups.delete(request, function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* }
* });
* });
* @alias monitoring.projects.groups.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}".
* @param {boolean=} params.recursive If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false.
* @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$Projects$Groups$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Groups$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Groups$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* monitoring.projects.groups.get
* @desc Gets a single group.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'get' method:
*
* // The group to retrieve. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`. name:
* "projects/{MY-PROJECT}/groups/{MY-GROUP}",
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.groups.get(request, function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* }
* });
* });
* @alias monitoring.projects.groups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The group to retrieve. The format is "projects/{project_id_or_number}/groups/{group_id}".
* @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$Projects$Groups$Get, options?: MethodOptions): GaxiosPromise<Schema$Group>;
get(params: Params$Resource$Projects$Groups$Get, options: MethodOptions | BodyResponseCallback<Schema$Group>, callback: BodyResponseCallback<Schema$Group>): void;
get(params: Params$Resource$Projects$Groups$Get, callback: BodyResponseCallback<Schema$Group>): void;
get(callback: BodyResponseCallback<Schema$Group>): void;
/**
* monitoring.projects.groups.list
* @desc Lists the existing groups.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'list' method:
*
* // The project whose groups are to be listed. The format is
* `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}",
* // Auth client
* auth: authClient
* };
*
*
* var recur = function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* if (result.nextPageToken) {
* request.pageToken = result.nextPageToken;
* monitoring.projects.groups.list(request, recur);
* }
* }
* };
*
* monitoring.projects.groups.list(request, recur);
* });
* @alias monitoring.projects.groups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ancestorsOfGroup A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
* @param {string=} params.childrenOfGroup A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.
* @param {string=} params.descendantsOfGroup A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.
* @param {string} params.name The project whose groups are to be listed. The format is "projects/{project_id_or_number}".
* @param {integer=} params.pageSize A positive number that is the maximum number of results to return.
* @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
* @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$Projects$Groups$List, options?: MethodOptions): GaxiosPromise<Schema$ListGroupsResponse>;
list(params: Params$Resource$Projects$Groups$List, options: MethodOptions | BodyResponseCallback<Schema$ListGroupsResponse>, callback: BodyResponseCallback<Schema$ListGroupsResponse>): void;
list(params: Params$Resource$Projects$Groups$List, callback: BodyResponseCallback<Schema$ListGroupsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListGroupsResponse>): void;
/**
* monitoring.projects.groups.update
* @desc Updates an existing group. You can change any group attributes
* except name.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'update' method:
*
* // The name of this group. The format is
* `"projects/{project_id_or_number}/groups/{group_id}"`. When
* // creating a group, this field is ignored and a new name is created
* consisting of the project
* // specified in the call to `CreateGroup` and a unique `{group_id}`
* that is generated automatically.
* // @OutputOnly
* name: "projects/{MY-PROJECT}/groups/{MY-GROUP}",
* resource: {},
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.groups.update(request, function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* }
* });
* });
* @alias monitoring.projects.groups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
* @param {boolean=} params.validateOnly If true, validate this request but do not update the existing group.
* @param {().Group} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Projects$Groups$Update, options?: MethodOptions): GaxiosPromise<Schema$Group>;
update(params: Params$Resource$Projects$Groups$Update, options: MethodOptions | BodyResponseCallback<Schema$Group>, callback: BodyResponseCallback<Schema$Group>): void;
update(params: Params$Resource$Projects$Groups$Update, callback: BodyResponseCallback<Schema$Group>): void;
update(callback: BodyResponseCallback<Schema$Group>): void;
}
interface Params$Resource$Projects$Groups$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project in which to create the group. The format is
* "projects/{project_id_or_number}".
*/
name?: string;
/**
* If true, validate this request but do not create the group.
*/
validateOnly?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Group;
}
interface Params$Resource$Projects$Groups$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The group to delete. The format is
* "projects/{project_id_or_number}/groups/{group_id}".
*/
name?: string;
/**
* If this field is true, then the request means to delete a group with all
* its descendants. Otherwise, the request means to delete a group only when
* it has no descendants. The default value is false.
*/
recursive?: boolean;
}
interface Params$Resource$Projects$Groups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The group to retrieve. The format is
* "projects/{project_id_or_number}/groups/{group_id}".
*/
name?: string;
}
interface Params$Resource$Projects$Groups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A group name: "projects/{project_id_or_number}/groups/{group_id}".
* Returns groups that are ancestors of the specified group. The groups are
* returned in order, starting with the immediate parent and ending with the
* most distant ancestor. If the specified group has no immediate parent,
* the results are empty.
*/
ancestorsOfGroup?: string;
/**
* A group name: "projects/{project_id_or_number}/groups/{group_id}".
* Returns groups whose parentName field contains the group name. If no
* groups have this parent, the results are empty.
*/
childrenOfGroup?: string;
/**
* A group name: "projects/{project_id_or_number}/groups/{group_id}".
* Returns the descendants of the specified group. This is a superset of the
* results returned by the childrenOfGroup filter, and includes
* children-of-children, and so forth.
*/
descendantsOfGroup?: string;
/**
* The project whose groups are to be listed. The format is
* "projects/{project_id_or_number}".
*/
name?: string;
/**
* A positive number that is the maximum number of results to return.
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value
* returned by a previous call to this method. Using this field causes the
* method to return additional results from the previous method call.
*/
pageToken?: string;
}
interface Params$Resource$Projects$Groups$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Output only. The name of this group. The format is
* "projects/{project_id_or_number}/groups/{group_id}". When creating a
* group, this field is ignored and a new name is created consisting of the
* project specified in the call to CreateGroup and a unique {group_id} that
* is generated automatically.
*/
name?: string;
/**
* If true, validate this request but do not update the existing group.
*/
validateOnly?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Group;
}
class Resource$Projects$Groups$Members {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.groups.members.list
* @desc Lists the monitored resources that are members of a group.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'list' method:
*
* // The group whose members are listed. The format is
* // `"projects/{project_id_or_number}/groups/{group_id}"`.
* name: "projects/{MY-PROJECT}/groups/{MY-GROUP}",
* // Auth client
* auth: authClient
* };
*
*
* var recur = function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* if (result.nextPageToken) {
* request.pageToken = result.nextPageToken;
* monitoring.projects.groups.members.list(request, recur);
* }
* }
* };
*
* monitoring.projects.groups.members.list(request, recur);
* });
* @alias monitoring.projects.groups.members.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: resource.type = "gce_instance"
* @param {string=} params.interval.endTime Required. The end of the time interval.
* @param {string=} params.interval.startTime Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
* @param {string} params.name The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}".
* @param {integer=} params.pageSize A positive number that is the maximum number of results to return.
* @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
* @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$Projects$Groups$Members$List, options?: MethodOptions): GaxiosPromise<Schema$ListGroupMembersResponse>;
list(params: Params$Resource$Projects$Groups$Members$List, options: MethodOptions | BodyResponseCallback<Schema$ListGroupMembersResponse>, callback: BodyResponseCallback<Schema$ListGroupMembersResponse>): void;
list(params: Params$Resource$Projects$Groups$Members$List, callback: BodyResponseCallback<Schema$ListGroupMembersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListGroupMembersResponse>): void;
}
interface Params$Resource$Projects$Groups$Members$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* An optional list filter describing the members to be returned. The filter
* may reference the type, labels, and metadata of monitored resources that
* comprise the group. For example, to return only resources representing
* Compute Engine VM instances, use this filter: resource.type =
* "gce_instance"
*/
filter?: string;
/**
* Required. The end of the time interval.
*/
'interval.endTime'?: string;
/**
* Optional. The beginning of the time interval. The default value for the
* start time is the end time. The start time must not be later than the end
* time.
*/
'interval.startTime'?: string;
/**
* The group whose members are listed. The format is
* "projects/{project_id_or_number}/groups/{group_id}".
*/
name?: string;
/**
* A positive number that is the maximum number of results to return.
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value
* returned by a previous call to this method. Using this field causes the
* method to return additional results from the previous method call.
*/
pageToken?: string;
}
class Resource$Projects$Metricdescriptors {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.metricDescriptors.create
* @desc Creates a new metric descriptor. User-created metric descriptors
* define custom metrics.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'create' method:
*
* // The project on which to execute the request. The format is
* `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}",
* resource: {},
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.metricDescriptors.create(request, function(err,
* result) { if (err) { console.log(err); } else { console.log(result);
* }
* });
* });
* @alias monitoring.projects.metricDescriptors.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}".
* @param {().MetricDescriptor} 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$Projects$Metricdescriptors$Create, options?: MethodOptions): GaxiosPromise<Schema$MetricDescriptor>;
create(params: Params$Resource$Projects$Metricdescriptors$Create, options: MethodOptions | BodyResponseCallback<Schema$MetricDescriptor>, callback: BodyResponseCallback<Schema$MetricDescriptor>): void;
create(params: Params$Resource$Projects$Metricdescriptors$Create, callback: BodyResponseCallback<Schema$MetricDescriptor>): void;
create(callback: BodyResponseCallback<Schema$MetricDescriptor>): void;
/**
* monitoring.projects.metricDescriptors.delete
* @desc Deletes a metric descriptor. Only user-created custom metrics can
* be deleted.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'delete' method:
*
* // The metric descriptor on which to execute the request. The format
* is
* // `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`.
* An example of `{metric_id}` is:
* // `"custom.googleapis.com/my_test_metric"`.
* name: "",
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.metricDescriptors.delete(request, function(err,
* result) { if (err) { console.log(err); } else { console.log(result);
* }
* });
* });
* @alias monitoring.projects.metricDescriptors.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric".
* @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$Projects$Metricdescriptors$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Metricdescriptors$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Metricdescriptors$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* monitoring.projects.metricDescriptors.get
* @desc Gets a single metric descriptor. This method does not require a
* Stackdriver account.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'get' method:
*
* // The metric descriptor on which to execute the request. The format
* is
* // `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`.
* An example value of `{metric_id}`
* // is `"compute.googleapis.com/instance/disk/read_bytes_count"`.
* name: "",
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.metricDescriptors.get(request, function(err,
* result) { if (err) { console.log(err); } else { console.log(result);
* }
* });
* });
* @alias monitoring.projects.metricDescriptors.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count".
* @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$Projects$Metricdescriptors$Get, options?: MethodOptions): GaxiosPromise<Schema$MetricDescriptor>;
get(params: Params$Resource$Projects$Metricdescriptors$Get, options: MethodOptions | BodyResponseCallback<Schema$MetricDescriptor>, callback: BodyResponseCallback<Schema$MetricDescriptor>): void;
get(params: Params$Resource$Projects$Metricdescriptors$Get, callback: BodyResponseCallback<Schema$MetricDescriptor>): void;
get(callback: BodyResponseCallback<Schema$MetricDescriptor>): void;
/**
* monitoring.projects.metricDescriptors.list
* @desc Lists metric descriptors that match a filter. This method does not
* require a Stackdriver account.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'list' method:
*
* // The project on which to execute the request. The format is
* `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}",
* // Auth client
* auth: authClient
* };
*
*
* var recur = function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* if (result.nextPageToken) {
* request.pageToken = result.nextPageToken;
* monitoring.projects.metricDescriptors.list(request, recur);
* }
* }
* };
*
* monitoring.projects.metricDescriptors.list(request, recur);
* });
* @alias monitoring.projects.metricDescriptors.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/")
* @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}".
* @param {integer=} params.pageSize A positive number that is the maximum number of results to return.
* @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
* @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$Projects$Metricdescriptors$List, options?: MethodOptions): GaxiosPromise<Schema$ListMetricDescriptorsResponse>;
list(params: Params$Resource$Projects$Metricdescriptors$List, options: MethodOptions | BodyResponseCallback<Schema$ListMetricDescriptorsResponse>, callback: BodyResponseCallback<Schema$ListMetricDescriptorsResponse>): void;
list(params: Params$Resource$Projects$Metricdescriptors$List, callback: BodyResponseCallback<Schema$ListMetricDescriptorsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListMetricDescriptorsResponse>): void;
}
interface Params$Resource$Projects$Metricdescriptors$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project on which to execute the request. The format is
* "projects/{project_id_or_number}".
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$MetricDescriptor;
}
interface Params$Resource$Projects$Metricdescriptors$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The metric descriptor on which to execute the request. The format is
* "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An
* example of {metric_id} is: "custom.googleapis.com/my_test_metric".
*/
name?: string;
}
interface Params$Resource$Projects$Metricdescriptors$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The metric descriptor on which to execute the request. The format is
* "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An
* example value of {metric_id} is
* "compute.googleapis.com/instance/disk/read_bytes_count".
*/
name?: string;
}
interface Params$Resource$Projects$Metricdescriptors$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If this field is empty, all custom and system-defined metric descriptors
* are returned. Otherwise, the filter specifies which metric descriptors
* are to be returned. For example, the following filter matches all custom
* metrics: metric.type = starts_with("custom.googleapis.com/")
*/
filter?: string;
/**
* The project on which to execute the request. The format is
* "projects/{project_id_or_number}".
*/
name?: string;
/**
* A positive number that is the maximum number of results to return.
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value
* returned by a previous call to this method. Using this field causes the
* method to return additional results from the previous method call.
*/
pageToken?: string;
}
class Resource$Projects$Monitoredresourcedescriptors {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.monitoredResourceDescriptors.get
* @desc Gets a single monitored resource descriptor. This method does not
* require a Stackdriver account.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'get' method:
*
* // The monitored resource descriptor to get. The format is
* //
* `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`.
* The
* // `{resource_type}` is a predefined type, such as
* `cloudsql_database`. name:
* "projects/{MY-PROJECT}/monitoredResourceDescriptors/{MY-MONITOREDRESOURCEDESCRIPTOR}",
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.monitoredResourceDescriptors.get(request,
* function(err, result) { if (err) { console.log(err); } else {
* console.log(result);
* }
* });
* });
* @alias monitoring.projects.monitoredResourceDescriptors.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database.
* @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$Projects$Monitoredresourcedescriptors$Get, options?: MethodOptions): GaxiosPromise<Schema$MonitoredResourceDescriptor>;
get(params: Params$Resource$Projects$Monitoredresourcedescriptors$Get, options: MethodOptions | BodyResponseCallback<Schema$MonitoredResourceDescriptor>, callback: BodyResponseCallback<Schema$MonitoredResourceDescriptor>): void;
get(params: Params$Resource$Projects$Monitoredresourcedescriptors$Get, callback: BodyResponseCallback<Schema$MonitoredResourceDescriptor>): void;
get(callback: BodyResponseCallback<Schema$MonitoredResourceDescriptor>): void;
/**
* monitoring.projects.monitoredResourceDescriptors.list
* @desc Lists monitored resource descriptors that match a filter. This
* method does not require a Stackdriver account.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'list' method:
*
* // The project on which to execute the request. The format is
* `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}",
* // Auth client
* auth: authClient
* };
*
*
* var recur = function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* if (result.nextPageToken) {
* request.pageToken = result.nextPageToken;
* monitoring.projects.monitoredResourceDescriptors.list(request,
* recur);
* }
* }
* };
*
* monitoring.projects.monitoredResourceDescriptors.list(request, recur);
* });
* @alias monitoring.projects.monitoredResourceDescriptors.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id
* @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}".
* @param {integer=} params.pageSize A positive number that is the maximum number of results to return.
* @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
* @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$Projects$Monitoredresourcedescriptors$List, options?: MethodOptions): GaxiosPromise<Schema$ListMonitoredResourceDescriptorsResponse>;
list(params: Params$Resource$Projects$Monitoredresourcedescriptors$List, options: MethodOptions | BodyResponseCallback<Schema$ListMonitoredResourceDescriptorsResponse>, callback: BodyResponseCallback<Schema$ListMonitoredResourceDescriptorsResponse>): void;
list(params: Params$Resource$Projects$Monitoredresourcedescriptors$List, callback: BodyResponseCallback<Schema$ListMonitoredResourceDescriptorsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListMonitoredResourceDescriptorsResponse>): void;
}
interface Params$Resource$Projects$Monitoredresourcedescriptors$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The monitored resource descriptor to get. The format is
* "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}".
* The {resource_type} is a predefined type, such as cloudsql_database.
*/
name?: string;
}
interface Params$Resource$Projects$Monitoredresourcedescriptors$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* An optional filter describing the descriptors to be returned. The filter
* can reference the descriptor's type and labels. For example, the
* following filter returns only Google Compute Engine descriptors that have
* an id label: resource.type = starts_with("gce_") AND resource.label:id
*/
filter?: string;
/**
* The project on which to execute the request. The format is
* "projects/{project_id_or_number}".
*/
name?: string;
/**
* A positive number that is the maximum number of results to return.
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value
* returned by a previous call to this method. Using this field causes the
* method to return additional results from the previous method call.
*/
pageToken?: string;
}
class Resource$Projects$Notificationchanneldescriptors {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.notificationChannelDescriptors.get
* @desc Gets a single channel descriptor. The descriptor indicates which
* fields are expected / permitted for a notification channel of the given
* type.
* @alias monitoring.projects.notificationChannelDescriptors.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}.
* @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$Projects$Notificationchanneldescriptors$Get, options?: MethodOptions): GaxiosPromise<Schema$NotificationChannelDescriptor>;
get(params: Params$Resource$Projects$Notificationchanneldescriptors$Get, options: MethodOptions | BodyResponseCallback<Schema$NotificationChannelDescriptor>, callback: BodyResponseCallback<Schema$NotificationChannelDescriptor>): void;
get(params: Params$Resource$Projects$Notificationchanneldescriptors$Get, callback: BodyResponseCallback<Schema$NotificationChannelDescriptor>): void;
get(callback: BodyResponseCallback<Schema$NotificationChannelDescriptor>): void;
/**
* monitoring.projects.notificationChannelDescriptors.list
* @desc Lists the descriptors for supported channel types. The use of
* descriptors makes it possible for new channel types to be dynamically
* added.
* @alias monitoring.projects.notificationChannelDescriptors.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.
* @param {integer=} params.pageSize The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
* @param {string=} params.pageToken If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set 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$Projects$Notificationchanneldescriptors$List, options?: MethodOptions): GaxiosPromise<Schema$ListNotificationChannelDescriptorsResponse>;
list(params: Params$Resource$Projects$Notificationchanneldescriptors$List, options: MethodOptions | BodyResponseCallback<Schema$ListNotificationChannelDescriptorsResponse>, callback: BodyResponseCallback<Schema$ListNotificationChannelDescriptorsResponse>): void;
list(params: Params$Resource$Projects$Notificationchanneldescriptors$List, callback: BodyResponseCallback<Schema$ListNotificationChannelDescriptorsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNotificationChannelDescriptorsResponse>): void;
}
interface Params$Resource$Projects$Notificationchanneldescriptors$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The channel type for which to execute the request. The format is
* projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}.
*/
name?: string;
}
interface Params$Resource$Projects$Notificationchanneldescriptors$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The REST resource name of the parent from which to retrieve the
* notification channel descriptors. The expected syntax is:
* projects/[PROJECT_ID] Note that this names the parent container in which
* to look for the descriptors; to retrieve a single descriptor by name, use
* the GetNotificationChannelDescriptor operation, instead.
*/
name?: string;
/**
* The maximum number of results to return in a single response. If not set
* to a positive number, a reasonable value will be chosen by the service.
*/
pageSize?: number;
/**
* If non-empty, page_token must contain a value returned as the
* next_page_token in a previous response to request the next set of
* results.
*/
pageToken?: string;
}
class Resource$Projects$Notificationchannels {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.notificationChannels.create
* @desc Creates a new notification channel, representing a single
* notification endpoint such as an email address, SMS number, or PagerDuty
* service.
* @alias monitoring.projects.notificationChannels.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The project on which to execute the request. The format is: projects/[PROJECT_ID] Note that this names the container into which the channel will be written. This does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.
* @param {().NotificationChannel} 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$Projects$Notificationchannels$Create, options?: MethodOptions): GaxiosPromise<Schema$NotificationChannel>;
create(params: Params$Resource$Projects$Notificationchannels$Create, options: MethodOptions | BodyResponseCallback<Schema$NotificationChannel>, callback: BodyResponseCallback<Schema$NotificationChannel>): void;
create(params: Params$Resource$Projects$Notificationchannels$Create, callback: BodyResponseCallback<Schema$NotificationChannel>): void;
create(callback: BodyResponseCallback<Schema$NotificationChannel>): void;
/**
* monitoring.projects.notificationChannels.delete
* @desc Deletes a notification channel.
* @alias monitoring.projects.notificationChannels.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.force If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.
* @param {string} params.name The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID].
* @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$Projects$Notificationchannels$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Notificationchannels$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Notificationchannels$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* monitoring.projects.notificationChannels.get
* @desc Gets a single notification channel. The channel includes the
* relevant configuration details with which the channel was created.
* However, the response may truncate or omit passwords, API keys, or other
* private key matter and thus the response may not be 100% identical to the
* information that was supplied in the call to the create method.
* @alias monitoring.projects.notificationChannels.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID].
* @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$Projects$Notificationchannels$Get, options?: MethodOptions): GaxiosPromise<Schema$NotificationChannel>;
get(params: Params$Resource$Projects$Notificationchannels$Get, options: MethodOptions | BodyResponseCallback<Schema$NotificationChannel>, callback: BodyResponseCallback<Schema$NotificationChannel>): void;
get(params: Params$Resource$Projects$Notificationchannels$Get, callback: BodyResponseCallback<Schema$NotificationChannel>): void;
get(callback: BodyResponseCallback<Schema$NotificationChannel>): void;
/**
* monitoring.projects.notificationChannels.getVerificationCode
* @desc Requests a verification code for an already verified channel that
* can then be used in a call to VerifyNotificationChannel() on a different
* channel with an equivalent identity in the same or in a different
* project. This makes it possible to copy a channel between projects
* without requiring manual reverification of the channel. If the channel is
* not in the verified state, this method will fail (in other words, this
* may only be used if the SendNotificationChannelVerificationCode and
* VerifyNotificationChannel paths have already been used to put the given
* channel into the verified state).There is no guarantee that the
* verification codes returned by this method will be of a similar structure
* or form as the ones that are delivered to the channel via
* SendNotificationChannelVerificationCode; while
* VerifyNotificationChannel() will recognize both the codes delivered via
* SendNotificationChannelVerificationCode() and returned from
* GetNotificationChannelVerificationCode(), it is typically the case that
* the verification codes delivered via
* SendNotificationChannelVerificationCode() will be shorter and also have a
* shorter expiration (e.g. codes such as "G-123456") whereas
* GetVerificationCode() will typically return a much longer, websafe base
* 64 encoded string that has a longer expiration time.
* @alias monitoring.projects.notificationChannels.getVerificationCode
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.
* @param {().GetNotificationChannelVerificationCodeRequest} 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
*/
getVerificationCode(params?: Params$Resource$Projects$Notificationchannels$Getverificationcode, options?: MethodOptions): GaxiosPromise<Schema$GetNotificationChannelVerificationCodeResponse>;
getVerificationCode(params: Params$Resource$Projects$Notificationchannels$Getverificationcode, options: MethodOptions | BodyResponseCallback<Schema$GetNotificationChannelVerificationCodeResponse>, callback: BodyResponseCallback<Schema$GetNotificationChannelVerificationCodeResponse>): void;
getVerificationCode(params: Params$Resource$Projects$Notificationchannels$Getverificationcode, callback: BodyResponseCallback<Schema$GetNotificationChannelVerificationCodeResponse>): void;
getVerificationCode(callback: BodyResponseCallback<Schema$GetNotificationChannelVerificationCodeResponse>): void;
/**
* monitoring.projects.notificationChannels.list
* @desc Lists the notification channels that have been created for the
* project.
* @alias monitoring.projects.notificationChannels.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering.
* @param {string} params.name The project on which to execute the request. The format is projects/[PROJECT_ID]. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.
* @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering.
* @param {integer=} params.pageSize The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
* @param {string=} params.pageToken If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set 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$Projects$Notificationchannels$List, options?: MethodOptions): GaxiosPromise<Schema$ListNotificationChannelsResponse>;
list(params: Params$Resource$Projects$Notificationchannels$List, options: MethodOptions | BodyResponseCallback<Schema$ListNotificationChannelsResponse>, callback: BodyResponseCallback<Schema$ListNotificationChannelsResponse>): void;
list(params: Params$Resource$Projects$Notificationchannels$List, callback: BodyResponseCallback<Schema$ListNotificationChannelsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNotificationChannelsResponse>): void;
/**
* monitoring.projects.notificationChannels.patch
* @desc Updates a notification channel. Fields not specified in the field
* mask remain unchanged.
* @alias monitoring.projects.notificationChannels.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.
* @param {string=} params.updateMask The fields to update.
* @param {().NotificationChannel} 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$Projects$Notificationchannels$Patch, options?: MethodOptions): GaxiosPromise<Schema$NotificationChannel>;
patch(params: Params$Resource$Projects$Notificationchannels$Patch, options: MethodOptions | BodyResponseCallback<Schema$NotificationChannel>, callback: BodyResponseCallback<Schema$NotificationChannel>): void;
patch(params: Params$Resource$Projects$Notificationchannels$Patch, callback: BodyResponseCallback<Schema$NotificationChannel>): void;
patch(callback: BodyResponseCallback<Schema$NotificationChannel>): void;
/**
* monitoring.projects.notificationChannels.sendVerificationCode
* @desc Causes a verification code to be delivered to the channel. The code
* can then be supplied in VerifyNotificationChannel to verify the channel.
* @alias monitoring.projects.notificationChannels.sendVerificationCode
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The notification channel to which to send a verification code.
* @param {().SendNotificationChannelVerificationCodeRequest} 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
*/
sendVerificationCode(params?: Params$Resource$Projects$Notificationchannels$Sendverificationcode, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
sendVerificationCode(params: Params$Resource$Projects$Notificationchannels$Sendverificationcode, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
sendVerificationCode(params: Params$Resource$Projects$Notificationchannels$Sendverificationcode, callback: BodyResponseCallback<Schema$Empty>): void;
sendVerificationCode(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* monitoring.projects.notificationChannels.verify
* @desc Verifies a NotificationChannel by proving receipt of the code
* delivered to the channel as a result of calling
* SendNotificationChannelVerificationCode.
* @alias monitoring.projects.notificationChannels.verify
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The notification channel to verify.
* @param {().VerifyNotificationChannelRequest} 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
*/
verify(params?: Params$Resource$Projects$Notificationchannels$Verify, options?: MethodOptions): GaxiosPromise<Schema$NotificationChannel>;
verify(params: Params$Resource$Projects$Notificationchannels$Verify, options: MethodOptions | BodyResponseCallback<Schema$NotificationChannel>, callback: BodyResponseCallback<Schema$NotificationChannel>): void;
verify(params: Params$Resource$Projects$Notificationchannels$Verify, callback: BodyResponseCallback<Schema$NotificationChannel>): void;
verify(callback: BodyResponseCallback<Schema$NotificationChannel>): void;
}
interface Params$Resource$Projects$Notificationchannels$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project on which to execute the request. The format is:
* projects/[PROJECT_ID] Note that this names the container into which the
* channel will be written. This does not name the newly created channel.
* The resulting channel's name will have a normalized version of this field
* as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify
* the channel.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$NotificationChannel;
}
interface Params$Resource$Projects$Notificationchannels$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If true, the notification channel will be deleted regardless of its use
* in alert policies (the policies will be updated to remove the channel).
* If false, channels that are still referenced by an existing alerting
* policy will fail to be deleted in a delete operation.
*/
force?: boolean;
/**
* The channel for which to execute the request. The format is
* projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID].
*/
name?: string;
}
interface Params$Resource$Projects$Notificationchannels$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The channel for which to execute the request. The format is
* projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID].
*/
name?: string;
}
interface Params$Resource$Projects$Notificationchannels$Getverificationcode extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The notification channel for which a verification code is to be generated
* and retrieved. This must name a channel that is already verified; if the
* specified channel is not verified, the request will fail.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GetNotificationChannelVerificationCodeRequest;
}
interface Params$Resource$Projects$Notificationchannels$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If provided, this field specifies the criteria that must be met by
* notification channels to be included in the response.For more details,
* see sorting and filtering.
*/
filter?: string;
/**
* The project on which to execute the request. The format is
* projects/[PROJECT_ID]. That is, this names the container in which to look
* for the notification channels; it does not name a specific channel. To
* query a specific channel by REST resource name, use the
* GetNotificationChannel operation.
*/
name?: string;
/**
* A comma-separated list of fields by which to sort the result. Supports
* the same set of fields as in filter. Entries can be prefixed with a minus
* sign to sort in descending rather than ascending order.For more details,
* see sorting and filtering.
*/
orderBy?: string;
/**
* The maximum number of results to return in a single response. If not set
* to a positive number, a reasonable value will be chosen by the service.
*/
pageSize?: number;
/**
* If non-empty, page_token must contain a value returned as the
* next_page_token in a previous response to request the next set of
* results.
*/
pageToken?: string;
}
interface Params$Resource$Projects$Notificationchannels$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The full REST resource name for this channel. The syntax is:
* projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID]
* is automatically assigned by the server on creation.
*/
name?: string;
/**
* The fields to update.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$NotificationChannel;
}
interface Params$Resource$Projects$Notificationchannels$Sendverificationcode extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The notification channel to which to send a verification code.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SendNotificationChannelVerificationCodeRequest;
}
interface Params$Resource$Projects$Notificationchannels$Verify extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The notification channel to verify.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$VerifyNotificationChannelRequest;
}
class Resource$Projects$Timeseries {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.timeSeries.create
* @desc Creates or adds data to one or more time series. The response is
* empty if all time series in the request were written. If any time series
* could not be written, a corresponding failure message is included in the
* error response.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'create' method:
*
* // The project on which to execute the request. The format is
* `"projects/{project_id_or_number}"`. name: "projects/{MY-PROJECT}",
* resource: {},
* // Auth client
* auth: authClient
* };
*
* monitoring.projects.timeSeries.create(request, function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* }
* });
* });
* @alias monitoring.projects.timeSeries.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}".
* @param {().CreateTimeSeriesRequest} 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$Projects$Timeseries$Create, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
create(params: Params$Resource$Projects$Timeseries$Create, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
create(params: Params$Resource$Projects$Timeseries$Create, callback: BodyResponseCallback<Schema$Empty>): void;
create(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* monitoring.projects.timeSeries.list
* @desc Lists time series that match a filter. This method does not require
* a Stackdriver account.
* @example
* * // PRE-REQUISITES:
* // ---------------
* // 1. If not already done, enable the Google Monitoring API and check the
* quota for your project at
* //
* https://console.developers.google.com/apis/api/monitoring_component/quotas
* // 2. This sample uses Application Default Credentials for Auth. If not
* already done, install the gcloud CLI from
* // https://cloud.google.com/sdk/ and run 'gcloud beta auth
* application-default login'
* // 3. To install the client library and Application Default Credentials
* library, run:
* // 'npm install googleapis --save'
* var google = require('googleapis');
* var monitoring = google.monitoring('v3');
*
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.log('Authentication failed because of ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
*
* var request = {
* // TODO: Change placeholders below to appropriate parameter values
* for the 'list' method:
*
* // The project on which to execute the request. The format is
* "projects/{project_id_or_number}". name: "projects/{MY-PROJECT}",
* // Auth client
* auth: authClient
* };
*
*
* var recur = function(err, result) {
* if (err) {
* console.log(err);
* } else {
* console.log(result);
* if (result.nextPageToken) {
* request.pageToken = result.nextPageToken;
* monitoring.projects.timeSeries.list(request, recur);
* }
* }
* };
*
* monitoring.projects.timeSeries.list(request, recur);
* });
* @alias monitoring.projects.timeSeries.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.aggregation.alignmentPeriod The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.
* @param {string=} params.aggregation.crossSeriesReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.
* @param {string=} params.aggregation.groupByFields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.
* @param {string=} params.aggregation.perSeriesAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.
* @param {string=} params.filter A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name"
* @param {string=} params.interval.endTime Required. The end of the time interval.
* @param {string=} params.interval.startTime Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
* @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}".
* @param {string=} params.orderBy Unsupported: must be left blank. The points in each time series are returned in reverse time order.
* @param {integer=} params.pageSize A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.
* @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
* @param {string=} params.view Specifies which information is returned about the time series.
* @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$Projects$Timeseries$List, options?: MethodOptions): GaxiosPromise<Schema$ListTimeSeriesResponse>;
list(params: Params$Resource$Projects$Timeseries$List, options: MethodOptions | BodyResponseCallback<Schema$ListTimeSeriesResponse>, callback: BodyResponseCallback<Schema$ListTimeSeriesResponse>): void;
list(params: Params$Resource$Projects$Timeseries$List, callback: BodyResponseCallback<Schema$ListTimeSeriesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTimeSeriesResponse>): void;
}
interface Params$Resource$Projects$Timeseries$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project on which to execute the request. The format is
* "projects/{project_id_or_number}".
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateTimeSeriesRequest;
}
interface Params$Resource$Projects$Timeseries$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The alignment period for per-time series alignment. If present,
* alignmentPeriod must be at least 60 seconds. After per-time series
* alignment, each time series will contain data points only on the period
* boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE,
* then this field is ignored. If perSeriesAligner is specified and does not
* equal ALIGN_NONE, then this field must be defined; otherwise an error is
* returned.
*/
'aggregation.alignmentPeriod'?: string;
/**
* The approach to be used to combine time series. Not all reducer functions
* may be applied to all time series, depending on the metric type and the
* value type of the original time series. Reduction may change the metric
* type of value type of the time series.Time series data must be aligned in
* order to perform cross-time series reduction. If crossSeriesReducer is
* specified, then perSeriesAligner must be specified and not equal
* ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is
* returned.
*/
'aggregation.crossSeriesReducer'?: string;
/**
* The set of fields to preserve when crossSeriesReducer is specified. The
* groupByFields determine how the time series are partitioned into subsets
* prior to applying the aggregation function. Each subset contains time
* series that have the same value for each of the grouping fields. Each
* individual time series is a member of exactly one subset. The
* crossSeriesReducer is applied to each subset of time series. It is not
* possible to reduce across different resource types, so this field
* implicitly contains resource.type. Fields not specified in groupByFields
* are aggregated away. If groupByFields is not specified and all the time
* series have the same resource type, then the time series are aggregated
* into a single output time series. If crossSeriesReducer is not defined,
* this field is ignored.
*/
'aggregation.groupByFields'?: string[];
/**
* The approach to be used to align individual time series. Not all
* alignment functions may be applied to all time series, depending on the
* metric type and value type of the original time series. Alignment may
* change the metric type or the value type of the time series.Time series
* data must be aligned in order to perform cross-time series reduction. If
* crossSeriesReducer is specified, then perSeriesAligner must be specified
* and not equal ALIGN_NONE and alignmentPeriod must be specified;
* otherwise, an error is returned.
*/
'aggregation.perSeriesAligner'?: string;
/**
* A monitoring filter that specifies which time series should be returned.
* The filter must specify a single metric type, and can additionally
* specify metric labels and other information. For example: metric.type =
* "compute.googleapis.com/instance/cpu/usage_time" AND
* metric.label.instance_name = "my-instance-name"
*/
filter?: string;
/**
* Required. The end of the time interval.
*/
'interval.endTime'?: string;
/**
* Optional. The beginning of the time interval. The default value for the
* start time is the end time. The start time must not be later than the end
* time.
*/
'interval.startTime'?: string;
/**
* The project on which to execute the request. The format is
* "projects/{project_id_or_number}".
*/
name?: string;
/**
* Unsupported: must be left blank. The points in each time series are
* returned in reverse time order.
*/
orderBy?: string;
/**
* A positive number that is the maximum number of results to return. If
* page_size is empty or more than 100,000 results, the effective page_size
* is 100,000 results. If view is set to FULL, this is the maximum number of
* Points returned. If view is set to HEADERS, this is the maximum number of
* TimeSeries returned.
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value
* returned by a previous call to this method. Using this field causes the
* method to return additional results from the previous method call.
*/
pageToken?: string;
/**
* Specifies which information is returned about the time series.
*/
view?: string;
}
class Resource$Projects$Uptimecheckconfigs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.projects.uptimeCheckConfigs.create
* @desc Creates a new uptime check configuration.
* @alias monitoring.projects.uptimeCheckConfigs.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The project in which to create the uptime check. The format is projects/[PROJECT_ID].
* @param {().UptimeCheckConfig} 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$Projects$Uptimecheckconfigs$Create, options?: MethodOptions): GaxiosPromise<Schema$UptimeCheckConfig>;
create(params: Params$Resource$Projects$Uptimecheckconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$UptimeCheckConfig>, callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
create(params: Params$Resource$Projects$Uptimecheckconfigs$Create, callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
create(callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
/**
* monitoring.projects.uptimeCheckConfigs.delete
* @desc Deletes an uptime check configuration. Note that this method will
* fail if the uptime check configuration is referenced by an alert policy
* or other dependent configs that would be rendered invalid by the
* deletion.
* @alias monitoring.projects.uptimeCheckConfigs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
* @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$Projects$Uptimecheckconfigs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Uptimecheckconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Uptimecheckconfigs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* monitoring.projects.uptimeCheckConfigs.get
* @desc Gets a single uptime check configuration.
* @alias monitoring.projects.uptimeCheckConfigs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
* @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$Projects$Uptimecheckconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$UptimeCheckConfig>;
get(params: Params$Resource$Projects$Uptimecheckconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$UptimeCheckConfig>, callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
get(params: Params$Resource$Projects$Uptimecheckconfigs$Get, callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
get(callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
/**
* monitoring.projects.uptimeCheckConfigs.list
* @desc Lists the existing valid uptime check configurations for the
* project, leaving out any invalid configurations.
* @alias monitoring.projects.uptimeCheckConfigs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.
* @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.
* @param {string} params.parent The project whose uptime check configurations are listed. The format is projects/[PROJECT_ID].
* @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$Projects$Uptimecheckconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$ListUptimeCheckConfigsResponse>;
list(params: Params$Resource$Projects$Uptimecheckconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$ListUptimeCheckConfigsResponse>, callback: BodyResponseCallback<Schema$ListUptimeCheckConfigsResponse>): void;
list(params: Params$Resource$Projects$Uptimecheckconfigs$List, callback: BodyResponseCallback<Schema$ListUptimeCheckConfigsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListUptimeCheckConfigsResponse>): void;
/**
* monitoring.projects.uptimeCheckConfigs.patch
* @desc Updates an uptime check configuration. You can either replace the
* entire configuration with a new one or replace only certain fields in the
* current configuration by specifying the fields to be updated via
* "updateMask". Returns the updated configuration.
* @alias monitoring.projects.uptimeCheckConfigs.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.
* @param {string=} params.updateMask Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.
* @param {().UptimeCheckConfig} 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$Projects$Uptimecheckconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$UptimeCheckConfig>;
patch(params: Params$Resource$Projects$Uptimecheckconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$UptimeCheckConfig>, callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
patch(params: Params$Resource$Projects$Uptimecheckconfigs$Patch, callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
patch(callback: BodyResponseCallback<Schema$UptimeCheckConfig>): void;
}
interface Params$Resource$Projects$Uptimecheckconfigs$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project in which to create the uptime check. The format is
* projects/[PROJECT_ID].
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UptimeCheckConfig;
}
interface Params$Resource$Projects$Uptimecheckconfigs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The uptime check configuration to delete. The format is
* projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
*/
name?: string;
}
interface Params$Resource$Projects$Uptimecheckconfigs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The uptime check configuration to retrieve. The format is
* projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
*/
name?: string;
}
interface Params$Resource$Projects$Uptimecheckconfigs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of results to return in a single response. The server
* may further constrain the maximum number of results returned in a single
* page. If the page_size is <=0, the server will decide the number of
* results to be returned.
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value
* returned by a previous call to this method. Using this field causes the
* method to return more results from the previous method call.
*/
pageToken?: string;
/**
* The project whose uptime check configurations are listed. The format is
* projects/[PROJECT_ID].
*/
parent?: string;
}
interface Params$Resource$Projects$Uptimecheckconfigs$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A unique resource name for this UptimeCheckConfig. The format
* is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field
* should be omitted when creating the uptime check configuration; on
* create, the resource name is assigned by the server and included in the
* response.
*/
name?: string;
/**
* Optional. If present, only the listed fields in the current uptime check
* configuration are updated with values from the new configuration. If this
* field is empty, then the current configuration is completely replaced
* with the new configuration.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UptimeCheckConfig;
}
class Resource$Uptimecheckips {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* monitoring.uptimeCheckIps.list
* @desc Returns the list of IPs that checkers run from
* @alias monitoring.uptimeCheckIps.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented
* @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented
* @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$Uptimecheckips$List, options?: MethodOptions): GaxiosPromise<Schema$ListUptimeCheckIpsResponse>;
list(params: Params$Resource$Uptimecheckips$List, options: MethodOptions | BodyResponseCallback<Schema$ListUptimeCheckIpsResponse>, callback: BodyResponseCallback<Schema$ListUptimeCheckIpsResponse>): void;
list(params: Params$Resource$Uptimecheckips$List, callback: BodyResponseCallback<Schema$ListUptimeCheckIpsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListUptimeCheckIpsResponse>): void;
}
interface Params$Resource$Uptimecheckips$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of results to return in a single response. The server
* may further constrain the maximum number of results returned in a single
* page. If the page_size is <=0, the server will decide the number of
* results to be returned. NOTE: this field is not yet implemented
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value
* returned by a previous call to this method. Using this field causes the
* method to return more results from the previous method call. NOTE: this
* field is not yet implemented
*/
pageToken?: string;
}
}