v1beta.d.ts
113 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
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace osconfig_v1beta {
export interface Options extends GlobalOptions {
version: 'v1beta';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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;
}
/**
* OS Config API
*
* OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.
*
* @example
* ```js
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
* ```
*/
export class Osconfig {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`.
*/
export interface Schema$AptRepository {
/**
* Type of archive files in this repository. The default behavior is DEB.
*/
archiveType?: string | null;
/**
* Required. List of components for this repository. Must contain at least one item.
*/
components?: string[] | null;
/**
* Required. Distribution of this repository.
*/
distribution?: string | null;
/**
* URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy.
*/
gpgKey?: string | null;
/**
* Required. URI for this repository.
*/
uri?: string | null;
}
/**
* Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed.
*/
export interface Schema$AptSettings {
/**
* List of packages to exclude from update. These packages will be excluded
*/
excludes?: string[] | null;
/**
* An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.
*/
exclusivePackages?: string[] | null;
/**
* By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.
*/
type?: string | null;
}
/**
* An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones.
*/
export interface Schema$Assignment {
/**
* Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging".
*/
groupLabels?: Schema$AssignmentGroupLabel[];
/**
* Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-". Only supported for project-level policies.
*/
instanceNamePrefixes?: string[] | null;
/**
* Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project.
*/
instances?: string[] | null;
/**
* Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included.
*/
osTypes?: Schema$AssignmentOsType[];
/**
* Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone.
*/
zones?: string[] | null;
}
/**
* Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web".
*/
export interface Schema$AssignmentGroupLabel {
/**
* Google Compute Engine instance labels that must be present for an instance to be included in this assignment group.
*/
labels?: {
[key: string]: string;
} | null;
}
/**
* Defines the criteria for selecting VM Instances by OS type.
*/
export interface Schema$AssignmentOsType {
/**
* Targets VM instances with OS Inventory enabled and having the following OS architecture.
*/
osArchitecture?: string | null;
/**
* Targets VM instances with OS Inventory enabled and having the following OS short name, for example "debian" or "windows".
*/
osShortName?: string | null;
/**
* Targets VM instances with OS Inventory enabled and having the following following OS version.
*/
osVersion?: string | null;
}
/**
* Message for canceling a patch job.
*/
export interface Schema$CancelPatchJobRequest {
}
/**
* The effective guest policy that applies to a VM instance.
*/
export interface Schema$EffectiveGuestPolicy {
/**
* List of package repository configurations assigned to the VM instance.
*/
packageRepositories?: Schema$EffectiveGuestPolicySourcedPackageRepository[];
/**
* List of package configurations assigned to the VM instance.
*/
packages?: Schema$EffectiveGuestPolicySourcedPackage[];
/**
* List of recipes assigned to the VM instance.
*/
softwareRecipes?: Schema$EffectiveGuestPolicySourcedSoftwareRecipe[];
}
/**
* A guest policy package including its source.
*/
export interface Schema$EffectiveGuestPolicySourcedPackage {
/**
* A software package to configure on the VM instance.
*/
package?: Schema$Package;
/**
* Name of the guest policy providing this config.
*/
source?: string | null;
}
/**
* A guest policy package repository including its source.
*/
export interface Schema$EffectiveGuestPolicySourcedPackageRepository {
/**
* A software package repository to configure on the VM instance.
*/
packageRepository?: Schema$PackageRepository;
/**
* Name of the guest policy providing this config.
*/
source?: string | null;
}
/**
* A guest policy recipe including its source.
*/
export interface Schema$EffectiveGuestPolicySourcedSoftwareRecipe {
/**
* A software recipe to configure on the VM instance.
*/
softwareRecipe?: Schema$SoftwareRecipe;
/**
* Name of the guest policy providing this config.
*/
source?: string | null;
}
/**
* 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 `{\}`.
*/
export interface Schema$Empty {
}
/**
* A step that runs an executable for a PatchJob.
*/
export interface Schema$ExecStep {
/**
* The ExecStepConfig for all Linux VMs targeted by the PatchJob.
*/
linuxExecStepConfig?: Schema$ExecStepConfig;
/**
* The ExecStepConfig for all Windows VMs targeted by the PatchJob.
*/
windowsExecStepConfig?: Schema$ExecStepConfig;
}
/**
* Common configurations for an ExecStep.
*/
export interface Schema$ExecStepConfig {
/**
* Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
*/
allowedSuccessCodes?: number[] | null;
/**
* A Google Cloud Storage object containing the executable.
*/
gcsObject?: Schema$GcsObject;
/**
* The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
*/
interpreter?: string | null;
/**
* An absolute path to the executable on the VM.
*/
localPath?: string | null;
}
/**
* A request message to initiate patching across Compute Engine instances.
*/
export interface Schema$ExecutePatchJobRequest {
/**
* Description of the patch job. Length of the description is limited to 1024 characters.
*/
description?: string | null;
/**
* Display name for this patch job. This does not have to be unique.
*/
displayName?: string | null;
/**
* If this patch is a dry-run only, instances are contacted but will do nothing.
*/
dryRun?: boolean | null;
/**
* Duration of the patch job. After the duration ends, the patch job times out.
*/
duration?: string | null;
/**
* Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.
*/
instanceFilter?: Schema$PatchInstanceFilter;
/**
* Patch configuration being applied. If omitted, instances are patched using the default configurations.
*/
patchConfig?: Schema$PatchConfig;
/**
* Rollout strategy of the patch job.
*/
rollout?: Schema$PatchRollout;
}
/**
* Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.
*/
export interface Schema$FixedOrPercent {
/**
* Specifies a fixed value.
*/
fixed?: number | null;
/**
* Specifies the relative value defined as a percentage, which will be multiplied by a reference value.
*/
percent?: number | null;
}
/**
* Google Cloud Storage object representation.
*/
export interface Schema$GcsObject {
/**
* Required. Bucket of the Google Cloud Storage object.
*/
bucket?: string | null;
/**
* Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.
*/
generationNumber?: string | null;
/**
* Required. Name of the Google Cloud Storage object.
*/
object?: string | null;
}
/**
* Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo.
*/
export interface Schema$GooRepository {
/**
* Required. The name of the repository.
*/
name?: string | null;
/**
* Required. The url of the repository.
*/
url?: string | null;
}
/**
* Googet patching is performed by running `googet update`.
*/
export interface Schema$GooSettings {
}
/**
* An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install.
*/
export interface Schema$GuestPolicy {
/**
* Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts).
*/
assignment?: Schema$Assignment;
/**
* Output only. Time this guest policy was created.
*/
createTime?: string | null;
/**
* Description of the guest policy. Length of the description is limited to 1024 characters.
*/
description?: string | null;
/**
* The etag for this guest policy. If this is provided on update, it must match the server's etag.
*/
etag?: string | null;
/**
* Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number\}/guestPolicies/{guest_policy_id\}`.
*/
name?: string | null;
/**
* A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available.
*/
packageRepositories?: Schema$PackageRepository[];
/**
* The software packages to be managed by this policy.
*/
packages?: Schema$Package[];
/**
* A list of Recipes to install on the VM instance.
*/
recipes?: Schema$SoftwareRecipe[];
/**
* Output only. Last time this guest policy was updated.
*/
updateTime?: string | null;
}
/**
* A response message for listing guest policies.
*/
export interface Schema$ListGuestPoliciesResponse {
/**
* The list of GuestPolicies.
*/
guestPolicies?: Schema$GuestPolicy[];
/**
* A pagination token that can be used to get the next page of guest policies.
*/
nextPageToken?: string | null;
}
/**
* A response message for listing patch deployments.
*/
export interface Schema$ListPatchDeploymentsResponse {
/**
* A pagination token that can be used to get the next page of patch deployments.
*/
nextPageToken?: string | null;
/**
* The list of patch deployments.
*/
patchDeployments?: Schema$PatchDeployment[];
}
/**
* A response message for listing the instances details for a patch job.
*/
export interface Schema$ListPatchJobInstanceDetailsResponse {
/**
* A pagination token that can be used to get the next page of results.
*/
nextPageToken?: string | null;
/**
* A list of instance status.
*/
patchJobInstanceDetails?: Schema$PatchJobInstanceDetails[];
}
/**
* A response message for listing patch jobs.
*/
export interface Schema$ListPatchJobsResponse {
/**
* A pagination token that can be used to get the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of patch jobs.
*/
patchJobs?: Schema$PatchJob[];
}
/**
* A request message for getting the effective guest policy assigned to the instance.
*/
export interface Schema$LookupEffectiveGuestPolicyRequest {
/**
* Architecture of OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance.
*/
osArchitecture?: string | null;
/**
* Short name of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance.
*/
osShortName?: string | null;
/**
* Version of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that VM instance.
*/
osVersion?: string | null;
}
/**
* Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month".
*/
export interface Schema$MonthlySchedule {
/**
* Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc.
*/
monthDay?: number | null;
/**
* Required. Week day in a month.
*/
weekDayOfMonth?: Schema$WeekDayOfMonth;
}
/**
* Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
*/
export interface Schema$OneTimeSchedule {
/**
* Required. The desired patch job execution time.
*/
executeTime?: string | null;
}
/**
* OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.
*/
export interface Schema$OSPolicyAssignmentOperationMetadata {
/**
* The OS policy assignment API method.
*/
apiMethod?: string | null;
/**
* Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment_id@revision_id\}`
*/
osPolicyAssignment?: string | null;
/**
* Rollout start time
*/
rolloutStartTime?: string | null;
/**
* State of the rollout
*/
rolloutState?: string | null;
/**
* Rollout update time
*/
rolloutUpdateTime?: string | null;
}
/**
* Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3`
*/
export interface Schema$Package {
/**
* The desired_state the agent should maintain for this package. The default is to ensure the package is installed.
*/
desiredState?: string | null;
/**
* Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY.
*/
manager?: string | null;
/**
* Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets.
*/
name?: string | null;
}
/**
* A package repository.
*/
export interface Schema$PackageRepository {
/**
* An Apt Repository.
*/
apt?: Schema$AptRepository;
/**
* A Goo Repository.
*/
goo?: Schema$GooRepository;
/**
* A Yum Repository.
*/
yum?: Schema$YumRepository;
/**
* A Zypper Repository.
*/
zypper?: Schema$ZypperRepository;
}
/**
* Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.
*/
export interface Schema$PatchConfig {
/**
* Apt update settings. Use this setting to override the default `apt` patch rules.
*/
apt?: Schema$AptSettings;
/**
* Goo update settings. Use this setting to override the default `goo` patch rules.
*/
goo?: Schema$GooSettings;
/**
* The `ExecStep` to run after the patch update.
*/
postStep?: Schema$ExecStep;
/**
* The `ExecStep` to run before the patch update.
*/
preStep?: Schema$ExecStep;
/**
* Post-patch reboot settings.
*/
rebootConfig?: string | null;
/**
* Windows update settings. Use this override the default windows patch rules.
*/
windowsUpdate?: Schema$WindowsUpdateSettings;
/**
* Yum update settings. Use this setting to override the default `yum` patch rules.
*/
yum?: Schema$YumSettings;
/**
* Zypper update settings. Use this setting to override the default `zypper` patch rules.
*/
zypper?: Schema$ZypperSettings;
}
/**
* Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).
*/
export interface Schema$PatchDeployment {
/**
* Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
*/
createTime?: string | null;
/**
* Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.
*/
description?: string | null;
/**
* Optional. Duration of the patch. After the duration ends, the patch times out.
*/
duration?: string | null;
/**
* Required. VM instances to patch.
*/
instanceFilter?: Schema$PatchInstanceFilter;
/**
* Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
*/
lastExecuteTime?: string | null;
/**
* Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id\}/patchDeployments/{patch_deployment_id\}`. This field is ignored when you create a new patch deployment.
*/
name?: string | null;
/**
* Required. Schedule a one-time execution.
*/
oneTimeSchedule?: Schema$OneTimeSchedule;
/**
* Optional. Patch configuration that is applied.
*/
patchConfig?: Schema$PatchConfig;
/**
* Required. Schedule recurring executions.
*/
recurringSchedule?: Schema$RecurringSchedule;
/**
* Optional. Rollout strategy of the patch job.
*/
rollout?: Schema$PatchRollout;
/**
* Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
*/
updateTime?: string | null;
}
/**
* A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones.
*/
export interface Schema$PatchInstanceFilter {
/**
* Target all VM instances in the project. If true, no other criteria is permitted.
*/
all?: boolean | null;
/**
* Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging".
*/
groupLabels?: Schema$PatchInstanceFilterGroupLabel[];
/**
* Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".
*/
instanceNamePrefixes?: string[] | null;
/**
* Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
*/
instances?: string[] | null;
/**
* Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.
*/
zones?: string[] | null;
}
/**
* Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".
*/
export interface Schema$PatchInstanceFilterGroupLabel {
/**
* Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.
*/
labels?: {
[key: string]: string;
} | null;
}
/**
* A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use `ListPatchJobInstanceDetails`. For more information about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
*/
export interface Schema$PatchJob {
/**
* Time this patch job was created.
*/
createTime?: string | null;
/**
* Description of the patch job. Length of the description is limited to 1024 characters.
*/
description?: string | null;
/**
* Display name for this patch job. This is not a unique identifier.
*/
displayName?: string | null;
/**
* If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
*/
dryRun?: boolean | null;
/**
* Duration of the patch job. After the duration ends, the patch job times out.
*/
duration?: string | null;
/**
* If this patch job failed, this message provides information about the failure.
*/
errorMessage?: string | null;
/**
* Summary of instance details.
*/
instanceDetailsSummary?: Schema$PatchJobInstanceDetailsSummary;
/**
* Instances to patch.
*/
instanceFilter?: Schema$PatchInstanceFilter;
/**
* Unique identifier for this patch job in the form `projects/x/patchJobs/x`
*/
name?: string | null;
/**
* Patch configuration being applied.
*/
patchConfig?: Schema$PatchConfig;
/**
* Output only. Name of the patch deployment that created this patch job.
*/
patchDeployment?: string | null;
/**
* Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
*/
percentComplete?: number | null;
/**
* Rollout strategy being applied.
*/
rollout?: Schema$PatchRollout;
/**
* The current state of the PatchJob.
*/
state?: string | null;
/**
* Last time this patch job was updated.
*/
updateTime?: string | null;
}
/**
* Patch details for a VM instance. For more information about reviewing VM instance details, see [Listing all VM instance details for a specific patch job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).
*/
export interface Schema$PatchJobInstanceDetails {
/**
* The number of times the agent that the agent attempts to apply the patch.
*/
attemptCount?: string | null;
/**
* If the patch fails, this field provides the reason.
*/
failureReason?: string | null;
/**
* The unique identifier for the instance. This identifier is defined by the server.
*/
instanceSystemId?: string | null;
/**
* The instance name in the form `projects/x/zones/x/instances/x`
*/
name?: string | null;
/**
* Current state of instance patch.
*/
state?: string | null;
}
/**
* A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance.
*/
export interface Schema$PatchJobInstanceDetailsSummary {
/**
* Number of instances that have acked and will start shortly.
*/
ackedInstanceCount?: string | null;
/**
* Number of instances that are applying patches.
*/
applyingPatchesInstanceCount?: string | null;
/**
* Number of instances that are downloading patches.
*/
downloadingPatchesInstanceCount?: string | null;
/**
* Number of instances that failed.
*/
failedInstanceCount?: string | null;
/**
* Number of instances that are inactive.
*/
inactiveInstanceCount?: string | null;
/**
* Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service.
*/
noAgentDetectedInstanceCount?: string | null;
/**
* Number of instances notified about patch job.
*/
notifiedInstanceCount?: string | null;
/**
* Number of instances pending patch job.
*/
pendingInstanceCount?: string | null;
/**
* Number of instances that are running the post-patch step.
*/
postPatchStepInstanceCount?: string | null;
/**
* Number of instances that are running the pre-patch step.
*/
prePatchStepInstanceCount?: string | null;
/**
* Number of instances rebooting.
*/
rebootingInstanceCount?: string | null;
/**
* Number of instances that have started.
*/
startedInstanceCount?: string | null;
/**
* Number of instances that have completed successfully.
*/
succeededInstanceCount?: string | null;
/**
* Number of instances that require reboot.
*/
succeededRebootRequiredInstanceCount?: string | null;
/**
* Number of instances that exceeded the time out while applying the patch.
*/
timedOutInstanceCount?: string | null;
}
/**
* Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.
*/
export interface Schema$PatchRollout {
/**
* The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.
*/
disruptionBudget?: Schema$FixedOrPercent;
/**
* Mode of the patch rollout.
*/
mode?: string | null;
}
/**
* Sets the time for recurring patch deployments.
*/
export interface Schema$RecurringSchedule {
/**
* Optional. The end time at which a recurring patch deployment schedule is no longer active.
*/
endTime?: string | null;
/**
* Required. The frequency unit of this recurring schedule.
*/
frequency?: string | null;
/**
* Output only. The time the last patch job ran successfully.
*/
lastExecuteTime?: string | null;
/**
* Required. Schedule with monthly executions.
*/
monthly?: Schema$MonthlySchedule;
/**
* Output only. The time the next patch job is scheduled to run.
*/
nextExecuteTime?: string | null;
/**
* Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.
*/
startTime?: string | null;
/**
* Required. Time of the day to run a recurring deployment.
*/
timeOfDay?: Schema$TimeOfDay;
/**
* Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone.
*/
timeZone?: Schema$TimeZone;
/**
* Required. Schedule with weekly executions.
*/
weekly?: Schema$WeeklySchedule;
}
/**
* A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step.
*/
export interface Schema$SoftwareRecipe {
/**
* Resources available to be used in the steps in the recipe.
*/
artifacts?: Schema$SoftwareRecipeArtifact[];
/**
* Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.
*/
desiredState?: string | null;
/**
* Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back.
*/
installSteps?: Schema$SoftwareRecipeStep[];
/**
* Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.
*/
name?: string | null;
/**
* Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back.
*/
updateSteps?: Schema$SoftwareRecipeStep[];
/**
* The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).
*/
version?: string | null;
}
/**
* Specifies a resource to be used in the recipe.
*/
export interface Schema$SoftwareRecipeArtifact {
/**
* Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified.
*/
allowInsecure?: boolean | null;
/**
* A Google Cloud Storage artifact.
*/
gcs?: Schema$SoftwareRecipeArtifactGcs;
/**
* Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id.
*/
id?: string | null;
/**
* A generic remote artifact.
*/
remote?: Schema$SoftwareRecipeArtifactRemote;
}
/**
* Specifies an artifact available as a Google Cloud Storage object.
*/
export interface Schema$SoftwareRecipeArtifactGcs {
/**
* Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`.
*/
bucket?: string | null;
/**
* Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`.
*/
generation?: string | null;
/**
* Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`.
*/
object?: string | null;
}
/**
* Specifies an artifact available via some URI.
*/
export interface Schema$SoftwareRecipeArtifactRemote {
/**
* Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps.
*/
checksum?: string | null;
/**
* URI from which to fetch the object. It should contain both the protocol and path following the format {protocol\}://{location\}.
*/
uri?: string | null;
}
/**
* An action that can be taken as part of installing or updating a recipe.
*/
export interface Schema$SoftwareRecipeStep {
/**
* Extracts an archive into the specified directory.
*/
archiveExtraction?: Schema$SoftwareRecipeStepExtractArchive;
/**
* Installs a deb file via dpkg.
*/
dpkgInstallation?: Schema$SoftwareRecipeStepInstallDpkg;
/**
* Copies a file onto the instance.
*/
fileCopy?: Schema$SoftwareRecipeStepCopyFile;
/**
* Executes an artifact or local file.
*/
fileExec?: Schema$SoftwareRecipeStepExecFile;
/**
* Installs an MSI file.
*/
msiInstallation?: Schema$SoftwareRecipeStepInstallMsi;
/**
* Installs an rpm file via the rpm utility.
*/
rpmInstallation?: Schema$SoftwareRecipeStepInstallRpm;
/**
* Runs commands in a shell.
*/
scriptRun?: Schema$SoftwareRecipeStepRunScript;
}
/**
* Copies the artifact to the specified path on the instance.
*/
export interface Schema$SoftwareRecipeStepCopyFile {
/**
* Required. The id of the relevant artifact in the recipe.
*/
artifactId?: string | null;
/**
* Required. The absolute path on the instance to put the file.
*/
destination?: string | null;
/**
* Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false.
*/
overwrite?: boolean | null;
/**
* Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4
*/
permissions?: string | null;
}
/**
* Executes an artifact or local file.
*/
export interface Schema$SoftwareRecipeStepExecFile {
/**
* Defaults to [0]. A list of possible return values that the program can return to indicate a success.
*/
allowedExitCodes?: number[] | null;
/**
* Arguments to be passed to the provided executable.
*/
args?: string[] | null;
/**
* The id of the relevant artifact in the recipe.
*/
artifactId?: string | null;
/**
* The absolute path of the file on the local filesystem.
*/
localPath?: string | null;
}
/**
* Extracts an archive of the type specified in the specified directory.
*/
export interface Schema$SoftwareRecipeStepExtractArchive {
/**
* Required. The id of the relevant artifact in the recipe.
*/
artifactId?: string | null;
/**
* Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows.
*/
destination?: string | null;
/**
* Required. The type of the archive to extract.
*/
type?: string | null;
}
/**
* Installs a deb via dpkg.
*/
export interface Schema$SoftwareRecipeStepInstallDpkg {
/**
* Required. The id of the relevant artifact in the recipe.
*/
artifactId?: string | null;
}
/**
* Installs an MSI file.
*/
export interface Schema$SoftwareRecipeStepInstallMsi {
/**
* Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0]
*/
allowedExitCodes?: number[] | null;
/**
* Required. The id of the relevant artifact in the recipe.
*/
artifactId?: string | null;
/**
* The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag).
*/
flags?: string[] | null;
}
/**
* Installs an rpm file via the rpm utility.
*/
export interface Schema$SoftwareRecipeStepInstallRpm {
/**
* Required. The id of the relevant artifact in the recipe.
*/
artifactId?: string | null;
}
/**
* Runs a script through an interpreter.
*/
export interface Schema$SoftwareRecipeStepRunScript {
/**
* Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0]
*/
allowedExitCodes?: number[] | null;
/**
* The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
*/
interpreter?: string | null;
/**
* Required. The shell script to be executed.
*/
script?: string | null;
}
/**
* Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
*/
export interface Schema$TimeOfDay {
/**
* Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
*/
hours?: number | null;
/**
* Minutes of hour of day. Must be from 0 to 59.
*/
minutes?: number | null;
/**
* Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
*/
nanos?: number | null;
/**
* Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
*/
seconds?: number | null;
}
/**
* Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).
*/
export interface Schema$TimeZone {
/**
* IANA Time Zone Database time zone, e.g. "America/New_York".
*/
id?: string | null;
/**
* Optional. IANA Time Zone Database version number, e.g. "2019a".
*/
version?: string | null;
}
/**
* Represents one week day in a month. An example is "the 4th Sunday".
*/
export interface Schema$WeekDayOfMonth {
/**
* Required. A day of the week.
*/
dayOfWeek?: string | null;
/**
* Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month.
*/
weekOrdinal?: number | null;
}
/**
* Represents a weekly schedule.
*/
export interface Schema$WeeklySchedule {
/**
* Required. Day of the week.
*/
dayOfWeek?: string | null;
}
/**
* Windows patching is performed using the Windows Update Agent.
*/
export interface Schema$WindowsUpdateSettings {
/**
* Only apply updates of these windows update classifications. If empty, all updates are applied.
*/
classifications?: string[] | null;
/**
* List of KBs to exclude from update.
*/
excludes?: string[] | null;
/**
* An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.
*/
exclusivePatches?: string[] | null;
}
/**
* Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`.
*/
export interface Schema$YumRepository {
/**
* Required. The location of the repository directory.
*/
baseUrl?: string | null;
/**
* The display name of the repository.
*/
displayName?: string | null;
/**
* URIs of GPG keys.
*/
gpgKeys?: string[] | null;
/**
* Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts.
*/
id?: string | null;
}
/**
* Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms.
*/
export interface Schema$YumSettings {
/**
* List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag.
*/
excludes?: string[] | null;
/**
* An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.
*/
exclusivePackages?: string[] | null;
/**
* Will cause patch to run `yum update-minimal` instead.
*/
minimal?: boolean | null;
/**
* Adds the `--security` flag to `yum update`. Not supported on all platforms.
*/
security?: boolean | null;
}
/**
* Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`.
*/
export interface Schema$ZypperRepository {
/**
* Required. The location of the repository directory.
*/
baseUrl?: string | null;
/**
* The display name of the repository.
*/
displayName?: string | null;
/**
* URIs of GPG keys.
*/
gpgKeys?: string[] | null;
/**
* Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts.
*/
id?: string | null;
}
/**
* Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual.
*/
export interface Schema$ZypperSettings {
/**
* Install only patches with these categories. Common categories include security, recommended, and feature.
*/
categories?: string[] | null;
/**
* List of patches to exclude from update.
*/
excludes?: string[] | null;
/**
* An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.
*/
exclusivePatches?: string[] | null;
/**
* Install only patches with these severities. Common severities include critical, important, moderate, and low.
*/
severities?: string[] | null;
/**
* Adds the `--with-optional` flag to `zypper patch`.
*/
withOptional?: boolean | null;
/**
* Adds the `--with-update` flag, to `zypper patch`.
*/
withUpdate?: boolean | null;
}
export class Resource$Projects {
context: APIRequestContext;
guestPolicies: Resource$Projects$Guestpolicies;
patchDeployments: Resource$Projects$Patchdeployments;
patchJobs: Resource$Projects$Patchjobs;
zones: Resource$Projects$Zones;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Guestpolicies {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Create an OS Config guest policy.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.guestPolicies.create({
* // Required. The logical name of the guest policy in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
* guestPolicyId: 'placeholder-value',
* // Required. The resource name of the parent using one of the following forms: `projects/{project_number\}`.
* parent: 'projects/my-project',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "assignment": {},
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "etag": "my_etag",
* // "name": "my_name",
* // "packageRepositories": [],
* // "packages": [],
* // "recipes": [],
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "assignment": {},
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "etag": "my_etag",
* // "name": "my_name",
* // "packageRepositories": [],
* // "packages": [],
* // "recipes": [],
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Guestpolicies$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Guestpolicies$Create, options?: MethodOptions): GaxiosPromise<Schema$GuestPolicy>;
create(params: Params$Resource$Projects$Guestpolicies$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Guestpolicies$Create, options: MethodOptions | BodyResponseCallback<Schema$GuestPolicy>, callback: BodyResponseCallback<Schema$GuestPolicy>): void;
create(params: Params$Resource$Projects$Guestpolicies$Create, callback: BodyResponseCallback<Schema$GuestPolicy>): void;
create(callback: BodyResponseCallback<Schema$GuestPolicy>): void;
/**
* Delete an OS Config guest policy.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.guestPolicies.delete({
* // Required. The resource name of the guest policy using one of the following forms: `projects/{project_number\}/guestPolicies/{guest_policy_id\}`.
* name: 'projects/my-project/guestPolicies/my-guestPolicie',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Guestpolicies$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Guestpolicies$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Guestpolicies$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Guestpolicies$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Guestpolicies$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Get an OS Config guest policy.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.guestPolicies.get({
* // Required. The resource name of the guest policy using one of the following forms: `projects/{project_number\}/guestPolicies/{guest_policy_id\}`.
* name: 'projects/my-project/guestPolicies/my-guestPolicie',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "assignment": {},
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "etag": "my_etag",
* // "name": "my_name",
* // "packageRepositories": [],
* // "packages": [],
* // "recipes": [],
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Guestpolicies$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Guestpolicies$Get, options?: MethodOptions): GaxiosPromise<Schema$GuestPolicy>;
get(params: Params$Resource$Projects$Guestpolicies$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Guestpolicies$Get, options: MethodOptions | BodyResponseCallback<Schema$GuestPolicy>, callback: BodyResponseCallback<Schema$GuestPolicy>): void;
get(params: Params$Resource$Projects$Guestpolicies$Get, callback: BodyResponseCallback<Schema$GuestPolicy>): void;
get(callback: BodyResponseCallback<Schema$GuestPolicy>): void;
/**
* Get a page of OS Config guest policies.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.guestPolicies.list({
* // The maximum number of guest policies to return.
* pageSize: 'placeholder-value',
* // A pagination token returned from a previous call to `ListGuestPolicies` that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* // Required. The resource name of the parent using one of the following forms: `projects/{project_number\}`.
* parent: 'projects/my-project',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "guestPolicies": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Guestpolicies$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Guestpolicies$List, options?: MethodOptions): GaxiosPromise<Schema$ListGuestPoliciesResponse>;
list(params: Params$Resource$Projects$Guestpolicies$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Guestpolicies$List, options: MethodOptions | BodyResponseCallback<Schema$ListGuestPoliciesResponse>, callback: BodyResponseCallback<Schema$ListGuestPoliciesResponse>): void;
list(params: Params$Resource$Projects$Guestpolicies$List, callback: BodyResponseCallback<Schema$ListGuestPoliciesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListGuestPoliciesResponse>): void;
/**
* Update an OS Config guest policy.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.guestPolicies.patch({
* // Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number\}/guestPolicies/{guest_policy_id\}`.
* name: 'projects/my-project/guestPolicies/my-guestPolicie',
* // Field mask that controls which fields of the guest policy should be updated.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "assignment": {},
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "etag": "my_etag",
* // "name": "my_name",
* // "packageRepositories": [],
* // "packages": [],
* // "recipes": [],
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "assignment": {},
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "etag": "my_etag",
* // "name": "my_name",
* // "packageRepositories": [],
* // "packages": [],
* // "recipes": [],
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Guestpolicies$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Guestpolicies$Patch, options?: MethodOptions): GaxiosPromise<Schema$GuestPolicy>;
patch(params: Params$Resource$Projects$Guestpolicies$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Guestpolicies$Patch, options: MethodOptions | BodyResponseCallback<Schema$GuestPolicy>, callback: BodyResponseCallback<Schema$GuestPolicy>): void;
patch(params: Params$Resource$Projects$Guestpolicies$Patch, callback: BodyResponseCallback<Schema$GuestPolicy>): void;
patch(callback: BodyResponseCallback<Schema$GuestPolicy>): void;
}
export interface Params$Resource$Projects$Guestpolicies$Create extends StandardParameters {
/**
* Required. The logical name of the guest policy in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
*/
guestPolicyId?: string;
/**
* Required. The resource name of the parent using one of the following forms: `projects/{project_number\}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GuestPolicy;
}
export interface Params$Resource$Projects$Guestpolicies$Delete extends StandardParameters {
/**
* Required. The resource name of the guest policy using one of the following forms: `projects/{project_number\}/guestPolicies/{guest_policy_id\}`.
*/
name?: string;
}
export interface Params$Resource$Projects$Guestpolicies$Get extends StandardParameters {
/**
* Required. The resource name of the guest policy using one of the following forms: `projects/{project_number\}/guestPolicies/{guest_policy_id\}`.
*/
name?: string;
}
export interface Params$Resource$Projects$Guestpolicies$List extends StandardParameters {
/**
* The maximum number of guest policies to return.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to `ListGuestPolicies` that indicates where this listing should continue from.
*/
pageToken?: string;
/**
* Required. The resource name of the parent using one of the following forms: `projects/{project_number\}`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Guestpolicies$Patch extends StandardParameters {
/**
* Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number\}/guestPolicies/{guest_policy_id\}`.
*/
name?: string;
/**
* Field mask that controls which fields of the guest policy should be updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GuestPolicy;
}
export class Resource$Projects$Patchdeployments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Create an OS Config patch deployment.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchDeployments.create({
* // Required. The project to apply this patch deployment to in the form `projects/x`.
* parent: 'projects/my-project',
* // Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
* patchDeploymentId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "duration": "my_duration",
* // "instanceFilter": {},
* // "lastExecuteTime": "my_lastExecuteTime",
* // "name": "my_name",
* // "oneTimeSchedule": {},
* // "patchConfig": {},
* // "recurringSchedule": {},
* // "rollout": {},
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "duration": "my_duration",
* // "instanceFilter": {},
* // "lastExecuteTime": "my_lastExecuteTime",
* // "name": "my_name",
* // "oneTimeSchedule": {},
* // "patchConfig": {},
* // "recurringSchedule": {},
* // "rollout": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Patchdeployments$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Patchdeployments$Create, options?: MethodOptions): GaxiosPromise<Schema$PatchDeployment>;
create(params: Params$Resource$Projects$Patchdeployments$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Patchdeployments$Create, options: MethodOptions | BodyResponseCallback<Schema$PatchDeployment>, callback: BodyResponseCallback<Schema$PatchDeployment>): void;
create(params: Params$Resource$Projects$Patchdeployments$Create, callback: BodyResponseCallback<Schema$PatchDeployment>): void;
create(callback: BodyResponseCallback<Schema$PatchDeployment>): void;
/**
* Delete an OS Config patch deployment.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchDeployments.delete({
* // Required. The resource name of the patch deployment in the form `projects/x/patchDeployments/x`.
* name: 'projects/my-project/patchDeployments/my-patchDeployment',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Patchdeployments$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Patchdeployments$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Patchdeployments$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Patchdeployments$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Patchdeployments$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Get an OS Config patch deployment.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchDeployments.get({
* // Required. The resource name of the patch deployment in the form `projects/x/patchDeployments/x`.
* name: 'projects/my-project/patchDeployments/my-patchDeployment',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "duration": "my_duration",
* // "instanceFilter": {},
* // "lastExecuteTime": "my_lastExecuteTime",
* // "name": "my_name",
* // "oneTimeSchedule": {},
* // "patchConfig": {},
* // "recurringSchedule": {},
* // "rollout": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Patchdeployments$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Patchdeployments$Get, options?: MethodOptions): GaxiosPromise<Schema$PatchDeployment>;
get(params: Params$Resource$Projects$Patchdeployments$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Patchdeployments$Get, options: MethodOptions | BodyResponseCallback<Schema$PatchDeployment>, callback: BodyResponseCallback<Schema$PatchDeployment>): void;
get(params: Params$Resource$Projects$Patchdeployments$Get, callback: BodyResponseCallback<Schema$PatchDeployment>): void;
get(callback: BodyResponseCallback<Schema$PatchDeployment>): void;
/**
* Get a page of OS Config patch deployments.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchDeployments.list({
* // Optional. The maximum number of patch deployments to return. Default is 100.
* pageSize: 'placeholder-value',
* // Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* // Required. The resource name of the parent in the form `projects/x`.
* parent: 'projects/my-project',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "patchDeployments": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Patchdeployments$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Patchdeployments$List, options?: MethodOptions): GaxiosPromise<Schema$ListPatchDeploymentsResponse>;
list(params: Params$Resource$Projects$Patchdeployments$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Patchdeployments$List, options: MethodOptions | BodyResponseCallback<Schema$ListPatchDeploymentsResponse>, callback: BodyResponseCallback<Schema$ListPatchDeploymentsResponse>): void;
list(params: Params$Resource$Projects$Patchdeployments$List, callback: BodyResponseCallback<Schema$ListPatchDeploymentsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPatchDeploymentsResponse>): void;
}
export interface Params$Resource$Projects$Patchdeployments$Create extends StandardParameters {
/**
* Required. The project to apply this patch deployment to in the form `projects/x`.
*/
parent?: string;
/**
* Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
*/
patchDeploymentId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PatchDeployment;
}
export interface Params$Resource$Projects$Patchdeployments$Delete extends StandardParameters {
/**
* Required. The resource name of the patch deployment in the form `projects/x/patchDeployments/x`.
*/
name?: string;
}
export interface Params$Resource$Projects$Patchdeployments$Get extends StandardParameters {
/**
* Required. The resource name of the patch deployment in the form `projects/x/patchDeployments/x`.
*/
name?: string;
}
export interface Params$Resource$Projects$Patchdeployments$List extends StandardParameters {
/**
* Optional. The maximum number of patch deployments to return. Default is 100.
*/
pageSize?: number;
/**
* Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.
*/
pageToken?: string;
/**
* Required. The resource name of the parent in the form `projects/x`.
*/
parent?: string;
}
export class Resource$Projects$Patchjobs {
context: APIRequestContext;
instanceDetails: Resource$Projects$Patchjobs$Instancedetails;
constructor(context: APIRequestContext);
/**
* Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchJobs.cancel({
* // Required. Name of the patch in the form `projects/x/patchJobs/x`
* name: 'projects/my-project/patchJobs/my-patchJob',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "dryRun": false,
* // "duration": "my_duration",
* // "errorMessage": "my_errorMessage",
* // "instanceDetailsSummary": {},
* // "instanceFilter": {},
* // "name": "my_name",
* // "patchConfig": {},
* // "patchDeployment": "my_patchDeployment",
* // "percentComplete": {},
* // "rollout": {},
* // "state": "my_state",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(params: Params$Resource$Projects$Patchjobs$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
cancel(params?: Params$Resource$Projects$Patchjobs$Cancel, options?: MethodOptions): GaxiosPromise<Schema$PatchJob>;
cancel(params: Params$Resource$Projects$Patchjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
cancel(params: Params$Resource$Projects$Patchjobs$Cancel, options: MethodOptions | BodyResponseCallback<Schema$PatchJob>, callback: BodyResponseCallback<Schema$PatchJob>): void;
cancel(params: Params$Resource$Projects$Patchjobs$Cancel, callback: BodyResponseCallback<Schema$PatchJob>): void;
cancel(callback: BodyResponseCallback<Schema$PatchJob>): void;
/**
* Patch VM instances by creating and running a patch job.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchJobs.execute({
* // Required. The project in which to run this patch in the form `projects/x`
* parent: 'projects/my-project',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "dryRun": false,
* // "duration": "my_duration",
* // "instanceFilter": {},
* // "patchConfig": {},
* // "rollout": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "dryRun": false,
* // "duration": "my_duration",
* // "errorMessage": "my_errorMessage",
* // "instanceDetailsSummary": {},
* // "instanceFilter": {},
* // "name": "my_name",
* // "patchConfig": {},
* // "patchDeployment": "my_patchDeployment",
* // "percentComplete": {},
* // "rollout": {},
* // "state": "my_state",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
execute(params: Params$Resource$Projects$Patchjobs$Execute, options: StreamMethodOptions): GaxiosPromise<Readable>;
execute(params?: Params$Resource$Projects$Patchjobs$Execute, options?: MethodOptions): GaxiosPromise<Schema$PatchJob>;
execute(params: Params$Resource$Projects$Patchjobs$Execute, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
execute(params: Params$Resource$Projects$Patchjobs$Execute, options: MethodOptions | BodyResponseCallback<Schema$PatchJob>, callback: BodyResponseCallback<Schema$PatchJob>): void;
execute(params: Params$Resource$Projects$Patchjobs$Execute, callback: BodyResponseCallback<Schema$PatchJob>): void;
execute(callback: BodyResponseCallback<Schema$PatchJob>): void;
/**
* Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchJobs.get({
* // Required. Name of the patch in the form `projects/x/patchJobs/x`
* name: 'projects/my-project/patchJobs/my-patchJob',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "dryRun": false,
* // "duration": "my_duration",
* // "errorMessage": "my_errorMessage",
* // "instanceDetailsSummary": {},
* // "instanceFilter": {},
* // "name": "my_name",
* // "patchConfig": {},
* // "patchDeployment": "my_patchDeployment",
* // "percentComplete": {},
* // "rollout": {},
* // "state": "my_state",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Patchjobs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Patchjobs$Get, options?: MethodOptions): GaxiosPromise<Schema$PatchJob>;
get(params: Params$Resource$Projects$Patchjobs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Patchjobs$Get, options: MethodOptions | BodyResponseCallback<Schema$PatchJob>, callback: BodyResponseCallback<Schema$PatchJob>): void;
get(params: Params$Resource$Projects$Patchjobs$Get, callback: BodyResponseCallback<Schema$PatchJob>): void;
get(callback: BodyResponseCallback<Schema$PatchJob>): void;
/**
* Get a list of patch jobs.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchJobs.list({
* // If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.
* filter: 'placeholder-value',
* // The maximum number of instance status to return.
* pageSize: 'placeholder-value',
* // A pagination token returned from a previous call that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* // Required. In the form of `projects/x`
* parent: 'projects/my-project',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "patchJobs": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Patchjobs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Patchjobs$List, options?: MethodOptions): GaxiosPromise<Schema$ListPatchJobsResponse>;
list(params: Params$Resource$Projects$Patchjobs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Patchjobs$List, options: MethodOptions | BodyResponseCallback<Schema$ListPatchJobsResponse>, callback: BodyResponseCallback<Schema$ListPatchJobsResponse>): void;
list(params: Params$Resource$Projects$Patchjobs$List, callback: BodyResponseCallback<Schema$ListPatchJobsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPatchJobsResponse>): void;
}
export interface Params$Resource$Projects$Patchjobs$Cancel extends StandardParameters {
/**
* Required. Name of the patch in the form `projects/x/patchJobs/x`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelPatchJobRequest;
}
export interface Params$Resource$Projects$Patchjobs$Execute extends StandardParameters {
/**
* Required. The project in which to run this patch in the form `projects/x`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ExecutePatchJobRequest;
}
export interface Params$Resource$Projects$Patchjobs$Get extends StandardParameters {
/**
* Required. Name of the patch in the form `projects/x/patchJobs/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Patchjobs$List extends StandardParameters {
/**
* If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.
*/
filter?: string;
/**
* The maximum number of instance status to return.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call that indicates where this listing should continue from.
*/
pageToken?: string;
/**
* Required. In the form of `projects/x`
*/
parent?: string;
}
export class Resource$Projects$Patchjobs$Instancedetails {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Get a list of instance details for a given patch job.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await osconfig.projects.patchJobs.instanceDetails.list({
* // A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`.
* filter: 'placeholder-value',
* // The maximum number of instance details records to return. Default is 100.
* pageSize: 'placeholder-value',
* // A pagination token returned from a previous call that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* // Required. The parent for the instances are in the form of `projects/x/patchJobs/x`.
* parent: 'projects/my-project/patchJobs/my-patchJob',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "patchJobInstanceDetails": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Patchjobs$Instancedetails$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Patchjobs$Instancedetails$List, options?: MethodOptions): GaxiosPromise<Schema$ListPatchJobInstanceDetailsResponse>;
list(params: Params$Resource$Projects$Patchjobs$Instancedetails$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Patchjobs$Instancedetails$List, options: MethodOptions | BodyResponseCallback<Schema$ListPatchJobInstanceDetailsResponse>, callback: BodyResponseCallback<Schema$ListPatchJobInstanceDetailsResponse>): void;
list(params: Params$Resource$Projects$Patchjobs$Instancedetails$List, callback: BodyResponseCallback<Schema$ListPatchJobInstanceDetailsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPatchJobInstanceDetailsResponse>): void;
}
export interface Params$Resource$Projects$Patchjobs$Instancedetails$List extends StandardParameters {
/**
* A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`.
*/
filter?: string;
/**
* The maximum number of instance details records to return. Default is 100.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call that indicates where this listing should continue from.
*/
pageToken?: string;
/**
* Required. The parent for the instances are in the form of `projects/x/patchJobs/x`.
*/
parent?: string;
}
export class Resource$Projects$Zones {
context: APIRequestContext;
instances: Resource$Projects$Zones$Instances;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Zones$Instances {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/osconfig.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const osconfig = google.osconfig('v1beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await osconfig.projects.zones.instances.lookupEffectiveGuestPolicy({
* // Required. The VM instance whose policies are being looked up.
* instance: 'projects/my-project/zones/my-zone/instances/my-instance',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "osArchitecture": "my_osArchitecture",
* // "osShortName": "my_osShortName",
* // "osVersion": "my_osVersion"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "packageRepositories": [],
* // "packages": [],
* // "softwareRecipes": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
lookupEffectiveGuestPolicy(params: Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy, options: StreamMethodOptions): GaxiosPromise<Readable>;
lookupEffectiveGuestPolicy(params?: Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy, options?: MethodOptions): GaxiosPromise<Schema$EffectiveGuestPolicy>;
lookupEffectiveGuestPolicy(params: Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
lookupEffectiveGuestPolicy(params: Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy, options: MethodOptions | BodyResponseCallback<Schema$EffectiveGuestPolicy>, callback: BodyResponseCallback<Schema$EffectiveGuestPolicy>): void;
lookupEffectiveGuestPolicy(params: Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy, callback: BodyResponseCallback<Schema$EffectiveGuestPolicy>): void;
lookupEffectiveGuestPolicy(callback: BodyResponseCallback<Schema$EffectiveGuestPolicy>): void;
}
export interface Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy extends StandardParameters {
/**
* Required. The VM instance whose policies are being looked up.
*/
instance?: string;
/**
* Request body metadata
*/
requestBody?: Schema$LookupEffectiveGuestPolicyRequest;
}
export {};
}